Class: SparseNeuroVec

Defined in: src/vec/SparseNeuroVec.ts:11

SparseNeuroVec class representing a sparse 4D neuroimaging dataset. Implements the NeuroVec interface.

Implements

• NeuroVec<Map<number, number[]>>

Constructors

Constructor

new SparseNeuroVec(
   space, 
   voxelData, 
   defaultValue?): SparseNeuroVec;

Defined in: src/vec/SparseNeuroVec.ts:22

Constructs a SparseNeuroVec.

Parameters

space

NeuroSpace

NeuroSpace defining the dimensionality and transformations.

voxelData

Map<number, number[]>

Map from linear voxel indices to arrays of time series data.

defaultValue?

number = 0

The default value for missing voxels. Defaults to 0.

Returns

SparseNeuroVec

Properties

space

readonly space: NeuroSpace;

Defined in: src/vec/SparseNeuroVec.ts:12

Implementation of

NeuroVec.space

Accessors

length

Get Signature

get length(): number;

Defined in: src/vec/SparseNeuroVec.ts:31

Returns

number

Implementation of

NeuroVec.length

---

dim

Get Signature

get dim(): number[];

Defined in: src/vec/SparseNeuroVec.ts:35

Returns

number[]

Implementation of

NeuroVec.dim

---

spacing

Get Signature

get spacing(): number[];

Defined in: src/vec/SparseNeuroVec.ts:39

Returns

number[]

Implementation of

NeuroVec.spacing

---

origin

Get Signature

get origin(): number[];

Defined in: src/vec/SparseNeuroVec.ts:43

Returns

number[]

Implementation of

NeuroVec.origin

Methods

getData()

getData(): Map<number, number[]>;

Defined in: src/vec/SparseNeuroVec.ts:47

Returns

Map<number, number[]>

Implementation of

NeuroVec.getData

---

getAt()

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

Defined in: src/vec/SparseNeuroVec.ts:54

Retrieves the value at the specified (i, j, k, t) coordinate.

Parameters

i

number

j

number

k

number

t

number

Returns

number

Implementation of

NeuroVec.getAt

---

setAt()

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

Defined in: src/vec/SparseNeuroVec.ts:67

Sets the value at the specified (i, j, k, t) coordinate.

Parameters

i

number

j

number

k

number

t

number

value

number

Returns

void

Implementation of

NeuroVec.setAt

---

getSeries()

getSeries(
   i, 
   j, 
   k): number[];

Defined in: src/vec/SparseNeuroVec.ts:84

Retrieves the time series at voxel (i, j, k) as a number[].

Parameters

i

number

j

number

k

number

Returns

number[]

Implementation of

NeuroVec.getSeries

---

getVolume()

getVolume(t): NeuroVol;

Defined in: src/vec/SparseNeuroVec.ts:97

Retrieves the volume at the specified time index.

Parameters

t

number

Returns

NeuroVol

Implementation of

NeuroVec.getVolume

---

getRange()

getRange(): [number, number];

Defined in: src/vec/SparseNeuroVec.ts:121

Retrieves the minimum and maximum values across all data.

Returns

[number, number]

Implementation of

NeuroVec.getRange