Class: BigNeuroVec

Defined in: src/vector/BigNeuroVec.ts:238

BigNeuroVec - Memory-mapped neuroimaging vector data.

This class provides efficient handling of large 4D neuroimaging data by using memory-mapped arrays that remain on disk.

Direct translation of Python's BigNeuroVec class.

Implements

• NeuroVec

Constructors

Constructor

new BigNeuroVec(
   dataOrFilename, 
   spaceOrShape?, 
   options?): BigNeuroVec;

Defined in: src/vector/BigNeuroVec.ts:253

Creates a BigNeuroVec instance.

Can be initialized in two ways:

1. With data and space (creates new memory-mapped file)
2. With filename and shape (opens or creates file)

Parameters

dataOrFilename

string | TypedArray

spaceOrShape?

number[] | NeuroSpace

options?

filename?

string

mode?

string

dtype?

string

Returns

BigNeuroVec

Properties

filename

readonly filename: string;

Defined in: src/vector/BigNeuroVec.ts:242

---

mode

readonly mode: string;

Defined in: src/vector/BigNeuroVec.ts:243

---

space

readonly space: NeuroSpace;

Defined in: src/vector/BigNeuroVec.ts:244

Implementation of

NeuroVec.space

Accessors

data

Get Signature

get data(): TypedArray;

Defined in: src/vector/BigNeuroVec.ts:347

Returns

TypedArray

---

values

Get Signature

get values(): TypedArray;

Defined in: src/vector/BigNeuroVec.ts:352

Returns

TypedArray

---

length

Get Signature

get length(): number;

Defined in: src/vector/BigNeuroVec.ts:356

Returns

number

Implementation of

NeuroVec.length

---

dim

Get Signature

get dim(): number[];

Defined in: src/vector/BigNeuroVec.ts:360

Returns

number[]

Implementation of

NeuroVec.dim

---

shape

Get Signature

get shape(): number[];

Defined in: src/vector/BigNeuroVec.ts:364

Returns

number[]

---

spacing

Get Signature

get spacing(): number[];

Defined in: src/vector/BigNeuroVec.ts:368

Returns

number[]

Implementation of

NeuroVec.spacing

---

origin

Get Signature

get origin(): number[];

Defined in: src/vector/BigNeuroVec.ts:372

Returns

number[]

Implementation of

NeuroVec.origin

Methods

getVolume()

getVolume(t): NeuroVol;

Defined in: src/vector/BigNeuroVec.ts:379

Get volume at time point t

Parameters

t

number

Returns

NeuroVol

Implementation of

NeuroVec.getVolume

---

getSeries()

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

Defined in: src/vector/BigNeuroVec.ts:409

Get time series at voxel (i, j, k)

Parameters

i

number

j

number

k

number

Returns

number[]

Implementation of

NeuroVec.getSeries

---

getData()

getData(): TypedArray;

Defined in: src/vector/BigNeuroVec.ts:420

Get all data (loads into memory)

Returns

TypedArray

Implementation of

NeuroVec.getData

---

getRange()

getRange(): [number, number];

Defined in: src/vector/BigNeuroVec.ts:427

Get data range [min, max]

Returns

[number, number]

Implementation of

NeuroVec.getRange

---

getAt()

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

Defined in: src/vector/BigNeuroVec.ts:462

Get value at 4D index (interface uses i,j,k,t order)

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/vector/BigNeuroVec.ts:469

Set value at 4D index (interface uses i,j,k,t order)

Parameters

i

number

j

number

k

number

t

number

value

number

Returns

void

Implementation of

NeuroVec.setAt

---

series()

series(
   x, 
   y?, 
   z?): TypedArray;

Defined in: src/vector/BigNeuroVec.ts:476

Parameters

x

number | number[][]

y?

number

z?

number

Returns

TypedArray

---

subVector()

subVector(indices): BigNeuroVec;

Defined in: src/vector/BigNeuroVec.ts:506

Parameters

indices

number | number[]

Returns

BigNeuroVec

---

vols()

vols(indices?): NeuroVol[];

Defined in: src/vector/BigNeuroVec.ts:535

Parameters

indices?

number[]

Returns

NeuroVol[]

---

processChunks()

processChunks<T>(
   func, 
   chunkSize?, 
   axis?): T[];

Defined in: src/vector/BigNeuroVec.ts:569

Process data in chunks to avoid loading entire dataset into memory

Type Parameters

T

T

Parameters

func

(chunk) => T

chunkSize?

number = 100

axis?

number = 0

Returns

T[]

---

flush()

flush(): void;

Defined in: src/vector/BigNeuroVec.ts:612

Flush memory-mapped data to disk

Returns

void

---

close()

close(): void;

Defined in: src/vector/BigNeuroVec.ts:619

Close the memory-mapped file

Returns

void

---

cleanup()

cleanup(): void;

Defined in: src/vector/BigNeuroVec.ts:626

Clean up temporary files

Returns

void

---

toString()

toString(): string;

Defined in: src/vector/BigNeuroVec.ts:633

Returns a string representation of an object.

Returns

string