Skip to content

Class: UInt8NeuroVol ​

Defined in: src/volume/DenseNeuroVol.ts:414

Interface for volumetric neuroimaging data.

Extends ​

Constructors ​

Constructor ​

ts
new UInt8NeuroVol(space, data?): UInt8NeuroVol;

Defined in: src/volume/DenseNeuroVol.ts:415

Parameters ​

space ​

NeuroSpace

data? ​

Uint8Array<ArrayBufferLike>

Returns ​

UInt8NeuroVol

Overrides ​

DenseNeuroVol.constructor

Properties ​

space ​

ts
readonly space: NeuroSpace;

Defined in: src/volume/DenseNeuroVol.ts:23

Inherited from ​

DenseNeuroVol.space

Accessors ​

length ​

Get Signature ​

ts
get length(): number;

Defined in: src/volume/DenseNeuroVol.ts:49

Returns ​

number

Inherited from ​

DenseNeuroVol.length


dim ​

Get Signature ​

ts
get dim(): number[];

Defined in: src/volume/DenseNeuroVol.ts:53

Returns ​

number[]

Inherited from ​

DenseNeuroVol.dim


spacing ​

Get Signature ​

ts
get spacing(): number[];

Defined in: src/volume/DenseNeuroVol.ts:57

Returns ​

number[]

Inherited from ​

DenseNeuroVol.spacing


origin ​

Get Signature ​

ts
get origin(): number[];

Defined in: src/volume/DenseNeuroVol.ts:61

Returns ​

number[]

Inherited from ​

DenseNeuroVol.origin

Methods ​

getData() ​

ts
getData(): TypedArray;

Defined in: src/volume/DenseNeuroVol.ts:65

Returns ​

TypedArray

Inherited from ​

DenseNeuroVol.getData


setData() ​

ts
setData(newData): void;

Defined in: src/volume/DenseNeuroVol.ts:73

Replace underlying data in-place to preserve typed array type and views. Useful for fast volume updates (e.g., refreshed overlays) without realloc.

Parameters ​

newData ​

TypedArray

Returns ​

void

Inherited from ​

DenseNeuroVol.setData


get() ​

ts
get(index): number;

Defined in: src/volume/DenseNeuroVol.ts:81

Parameters ​

index ​

number

Returns ​

number

Inherited from ​

DenseNeuroVol.get


getAt() ​

ts
getAt(
   i, 
   j, 
   k): number;

Defined in: src/volume/DenseNeuroVol.ts:88

Parameters ​

i ​

number

j ​

number

k ​

number

Returns ​

number

Inherited from ​

DenseNeuroVol.getAt


setAt() ​

ts
setAt(
   i, 
   j, 
   k, 
   value): void;

Defined in: src/volume/DenseNeuroVol.ts:94

Parameters ​

i ​

number

j ​

number

k ​

number

value ​

number

Returns ​

void

Inherited from ​

DenseNeuroVol.setAt


isIdentityMatrix() ​

ts
isIdentityMatrix(matrix): boolean;

Defined in: src/volume/DenseNeuroVol.ts:110

Parameters ​

matrix ​

Matrix

Returns ​

boolean

Inherited from ​

DenseNeuroVol.isIdentityMatrix


getSlice() ​

ts
getSlice(zlevel, outAxes): NeuroSlice;

Defined in: src/volume/DenseNeuroVol.ts:132

Parameters ​

zlevel ​

number

outAxes ​

AxisSet3D

Returns ​

NeuroSlice

Inherited from ​

DenseNeuroVol.getSlice


getRange() ​

ts
getRange(): [number, number];

Defined in: src/volume/DenseNeuroVol.ts:247

Returns ​

[number, number]

Inherited from ​

DenseNeuroVol.getRange


getSliceAt() ​

ts
getSliceAt(
   coord, 
   outAxes, 
   interpolation?): NeuroSlice;

Defined in: src/volume/DenseNeuroVol.ts:272

Parameters ​

coord ​

number[]

outAxes ​

AxisSet3D

interpolation? ​

"nearest" | "trilinear"

Returns ​

NeuroSlice

Inherited from ​

DenseNeuroVol.getSliceAt


getDataConstructor() ​

ts
getDataConstructor(): Uint8ArrayConstructor;

Defined in: src/volume/DenseNeuroVol.ts:419

Returns ​

Uint8ArrayConstructor

Overrides ​

DenseNeuroVol.getDataConstructor


getSliceTypedArrayType() ​

ts
getSliceTypedArrayType(): "uint8";

Defined in: src/volume/DenseNeuroVol.ts:423

Returns ​

"uint8"

Overrides ​

DenseNeuroVol.getSliceTypedArrayType

Released under the MIT License.