Skip to content

Class: MappedNeuroVec ​

Defined in: src/vec/MappedNeuroVec.ts:26

Memory-mapped NeuroVec that provides efficient access to large datasets Uses ArrayBuffer for zero-copy operations where possible

Implements ​

Constructors ​

Constructor ​

ts
new MappedNeuroVec(
   space, 
   buffer, 
   options?): MappedNeuroVec;

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

Parameters ​

space ​

NeuroSpace

buffer ​

ArrayBufferLike

options? ​

MappedNeuroVecOptions = {}

Returns ​

MappedNeuroVec

Properties ​

space ​

ts
readonly space: NeuroSpace;

Defined in: src/vec/MappedNeuroVec.ts:27

Implementation of ​

INeuroVec.space

Accessors ​

length ​

Get Signature ​

ts
get length(): number;

Defined in: src/vec/MappedNeuroVec.ts:78

Returns ​

number

Implementation of ​

INeuroVec.length


dim ​

Get Signature ​

ts
get dim(): number[];

Defined in: src/vec/MappedNeuroVec.ts:82

Returns ​

number[]

Implementation of ​

INeuroVec.dim


spacing ​

Get Signature ​

ts
get spacing(): number[];

Defined in: src/vec/MappedNeuroVec.ts:86

Returns ​

number[]

Implementation of ​

INeuroVec.spacing


origin ​

Get Signature ​

ts
get origin(): number[];

Defined in: src/vec/MappedNeuroVec.ts:90

Returns ​

number[]

Implementation of ​

INeuroVec.origin

Methods ​

getData() ​

ts
getData(): ArrayBufferLike;

Defined in: src/vec/MappedNeuroVec.ts:94

Returns ​

ArrayBufferLike

Implementation of ​

INeuroVec.getData


getRange() ​

ts
getRange(): [number, number];

Defined in: src/vec/MappedNeuroVec.ts:98

Returns ​

[number, number]

Implementation of ​

INeuroVec.getRange


getAt() ​

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

Defined in: src/vec/MappedNeuroVec.ts:111

Parameters ​

i ​

number

j ​

number

k ​

number

t ​

number

Returns ​

number

Implementation of ​

INeuroVec.getAt


setAt() ​

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

Defined in: src/vec/MappedNeuroVec.ts:116

Parameters ​

i ​

number

j ​

number

k ​

number

t ​

number

value ​

number

Returns ​

void

Implementation of ​

INeuroVec.setAt


getVolume() ​

ts
getVolume(t): NeuroVol;

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

Parameters ​

t ​

number

Returns ​

NeuroVol

Implementation of ​

INeuroVec.getVolume


getSeries() ​

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

Defined in: src/vec/MappedNeuroVec.ts:141

Parameters ​

i ​

number

j ​

number

k ​

number

Returns ​

number[]

Implementation of ​

INeuroVec.getSeries


getTimeSeries() ​

ts
getTimeSeries(
   i, 
   j, 
   k): Float32Array;

Defined in: src/vec/MappedNeuroVec.ts:146

Parameters ​

i ​

number

j ​

number

k ​

number

Returns ​

Float32Array

Implementation of ​

INeuroVec.getTimeSeries


setTimeSeries() ​

ts
setTimeSeries(
   i, 
   j, 
   k, 
   data): void;

Defined in: src/vec/MappedNeuroVec.ts:164

Parameters ​

i ​

number

j ​

number

k ​

number

data ​

Float32Array

Returns ​

void

Implementation of ​

INeuroVec.setTimeSeries


detrend() ​

ts
detrend(method, options?): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:181

Parameters ​

method ​

DetrendMethod

options? ​
order? ​

number

Returns ​

INeuroVec

Implementation of ​

INeuroVec.detrend


temporalFilter() ​

ts
temporalFilter(filter): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:186

Parameters ​

filter ​

TemporalFilter

Returns ​

INeuroVec

Implementation of ​

INeuroVec.temporalFilter


convolve() ​

ts
convolve(kernel): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:191

Parameters ​

kernel ​

number[]

Returns ​

INeuroVec

Implementation of ​

INeuroVec.convolve


temporalSmooth() ​

ts
temporalSmooth(sigma): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:196

Parameters ​

sigma ​

number

Returns ​

INeuroVec

Implementation of ​

INeuroVec.temporalSmooth


temporalMean() ​

ts
temporalMean(): NeuroVol;

Defined in: src/vec/MappedNeuroVec.ts:201

Returns ​

NeuroVol

Implementation of ​

INeuroVec.temporalMean


temporalStd() ​

ts
temporalStd(): NeuroVol;

Defined in: src/vec/MappedNeuroVec.ts:219

Returns ​

NeuroVol

Implementation of ​

INeuroVec.temporalStd


temporalMin() ​

ts
temporalMin(): NeuroVol;

Defined in: src/vec/MappedNeuroVec.ts:241

Returns ​

NeuroVol

Implementation of ​

INeuroVec.temporalMin


temporalMax() ​

ts
temporalMax(): NeuroVol;

Defined in: src/vec/MappedNeuroVec.ts:245

Returns ​

NeuroVol

Implementation of ​

INeuroVec.temporalMax


temporalMedian() ​

ts
temporalMedian(): NeuroVol;

Defined in: src/vec/MappedNeuroVec.ts:249

Returns ​

NeuroVol

Implementation of ​

INeuroVec.temporalMedian


temporalCorrelation() ​

ts
temporalCorrelation(seed): NeuroVol;

Defined in: src/vec/MappedNeuroVec.ts:253

Parameters ​

seed ​

[number, number, number]

Returns ​

NeuroVol

Implementation of ​

INeuroVec.temporalCorrelation


temporalCorrelationMap() ​

ts
temporalCorrelationMap(seedVol): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:258

Parameters ​

seedVol ​

NeuroVol

Returns ​

INeuroVec

Implementation of ​

INeuroVec.temporalCorrelationMap


zscore() ​

ts
zscore(): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:262

Returns ​

INeuroVec

Implementation of ​

INeuroVec.zscore


percentSignalChange() ​

ts
percentSignalChange(baseline?): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:267

Parameters ​

baseline? ​

number[]

Returns ​

INeuroVec

Implementation of ​

INeuroVec.percentSignalChange


clone() ​

ts
clone(): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:272

Returns ​

INeuroVec

Implementation of ​

INeuroVec.clone


slice() ​

ts
slice(startTime, endTime): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:281

Parameters ​

startTime ​

number

endTime ​

number

Returns ​

INeuroVec

Implementation of ​

INeuroVec.slice


concatenate() ​

ts
concatenate(other): INeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:311

Parameters ​

other ​

INeuroVec

Returns ​

INeuroVec

Implementation of ​

INeuroVec.concatenate


fromTypedArray() ​

ts
static fromTypedArray(space, data): MappedNeuroVec;

Defined in: src/vec/MappedNeuroVec.ts:397

Create a MappedNeuroVec from a typed array

Parameters ​

space ​

NeuroSpace

data ​

| Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike> | Int16Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

Returns ​

MappedNeuroVec

Released under the MIT License.