Interface: NeuroVol

Defined in: src/volume/NeuroVol.ts:9

Interface for volumetric neuroimaging data.

Properties

space

readonly space: NeuroSpace;

Defined in: src/volume/NeuroVol.ts:10

---

length

readonly length: number;

Defined in: src/volume/NeuroVol.ts:11

---

dim

readonly dim: number[];

Defined in: src/volume/NeuroVol.ts:12

---

spacing

readonly spacing: number[];

Defined in: src/volume/NeuroVol.ts:13

---

origin

readonly origin: number[];

Defined in: src/volume/NeuroVol.ts:14

Methods

get()

get(index): number;

Defined in: src/volume/NeuroVol.ts:16

Parameters

index

number

Returns

number

---

getAt()

getAt(
   i, 
   j, 
   k): number;

Defined in: src/volume/NeuroVol.ts:17

Parameters

i

number

j

number

k

number

Returns

number

---

setAt()

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

Defined in: src/volume/NeuroVol.ts:18

Parameters

i

number

j

number

k

number

value

number

Returns

void

---

getSlice()

getSlice(zlevel, outAxes): NeuroSlice;

Defined in: src/volume/NeuroVol.ts:19

Parameters

zlevel

number

outAxes

AxisSet3D

Returns

NeuroSlice

---

getSliceAt()

getSliceAt(
   coord, 
   outAxes, 
   interpolation): NeuroSlice;

Defined in: src/volume/NeuroVol.ts:20

Parameters

coord

number[]

outAxes

AxisSet3D

interpolation

"nearest" | "trilinear"

Returns

NeuroSlice

---

getData()

getData(): TypedArray;

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

Returns

TypedArray

---

setData()

setData(newData): void;

Defined in: src/volume/NeuroVol.ts:28

Replace the underlying data in-place without changing geometry. Implementations should copy into the existing buffer to preserve view types.

Parameters

newData

TypedArray

Returns

void

---

getRange()

getRange(): [number, number];

Defined in: src/volume/NeuroVol.ts:30

Returns

[number, number]

---

getSliceTypedArrayType()

getSliceTypedArrayType(): NumericType;

Defined in: src/volume/NeuroVol.ts:33

Returns

NumericType

---

getDataConstructor()

getDataConstructor(): (length) => TypedArray;

Defined in: src/volume/NeuroVol.ts:35

Returns

(length) => TypedArray