Skip to content

Class: FileBackedNeuroVec

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

File-backed NeuroVec that loads data on demand Maintains an LRU cache of recently accessed volumes

Implements

Constructors

Constructor

ts
new FileBackedNeuroVec(
   space, 
   dataGetter, 
   options?): FileBackedNeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:34

Parameters

space

NeuroSpace

dataGetter

(timeIndex) => Float32Array

options?
maxCacheSize?

number

dataSetter?

(timeIndex, data) => void

Returns

FileBackedNeuroVec

Properties

space

ts
readonly space: NeuroSpace;

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

Implementation of

INeuroVec.space

Accessors

length

Get Signature

ts
get length(): number;

Defined in: src/vec/FileBackedNeuroVec.ts:52

Returns

number

Implementation of

INeuroVec.length


dim

Get Signature

ts
get dim(): number[];

Defined in: src/vec/FileBackedNeuroVec.ts:56

Returns

number[]

Implementation of

INeuroVec.dim


spacing

Get Signature

ts
get spacing(): number[];

Defined in: src/vec/FileBackedNeuroVec.ts:60

Returns

number[]

Implementation of

INeuroVec.spacing


origin

Get Signature

ts
get origin(): number[];

Defined in: src/vec/FileBackedNeuroVec.ts:64

Returns

number[]

Implementation of

INeuroVec.origin

Methods

getData()

ts
getData(): any;

Defined in: src/vec/FileBackedNeuroVec.ts:68

Returns

any

Implementation of

INeuroVec.getData


getRange()

ts
getRange(): [number, number];

Defined in: src/vec/FileBackedNeuroVec.ts:72

Returns

[number, number]

Implementation of

INeuroVec.getRange


getAt()

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

Defined in: src/vec/FileBackedNeuroVec.ts:89

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/FileBackedNeuroVec.ts:102

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/FileBackedNeuroVec.ts:126

Parameters

t

number

Returns

NeuroVol

Implementation of

INeuroVec.getVolume


getSeries()

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

Defined in: src/vec/FileBackedNeuroVec.ts:144

Parameters

i

number

j

number

k

number

Returns

number[]

Implementation of

INeuroVec.getSeries


getTimeSeries()

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

Defined in: src/vec/FileBackedNeuroVec.ts:149

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/FileBackedNeuroVec.ts:167

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/FileBackedNeuroVec.ts:190

Parameters

method

DetrendMethod

options?
order?

number

Returns

INeuroVec

Implementation of

INeuroVec.detrend


temporalFilter()

ts
temporalFilter(filter): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:195

Parameters

filter

TemporalFilter

Returns

INeuroVec

Implementation of

INeuroVec.temporalFilter


convolve()

ts
convolve(kernel): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:200

Parameters

kernel

number[]

Returns

INeuroVec

Implementation of

INeuroVec.convolve


temporalSmooth()

ts
temporalSmooth(sigma): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:205

Parameters

sigma

number

Returns

INeuroVec

Implementation of

INeuroVec.temporalSmooth


temporalMean()

ts
temporalMean(): NeuroVol;

Defined in: src/vec/FileBackedNeuroVec.ts:210

Returns

NeuroVol

Implementation of

INeuroVec.temporalMean


temporalStd()

ts
temporalStd(): NeuroVol;

Defined in: src/vec/FileBackedNeuroVec.ts:238

Returns

NeuroVol

Implementation of

INeuroVec.temporalStd


temporalMin()

ts
temporalMin(): NeuroVol;

Defined in: src/vec/FileBackedNeuroVec.ts:270

Returns

NeuroVol

Implementation of

INeuroVec.temporalMin


temporalMax()

ts
temporalMax(): NeuroVol;

Defined in: src/vec/FileBackedNeuroVec.ts:274

Returns

NeuroVol

Implementation of

INeuroVec.temporalMax


temporalMedian()

ts
temporalMedian(): NeuroVol;

Defined in: src/vec/FileBackedNeuroVec.ts:278

Returns

NeuroVol

Implementation of

INeuroVec.temporalMedian


temporalCorrelation()

ts
temporalCorrelation(seed): NeuroVol;

Defined in: src/vec/FileBackedNeuroVec.ts:282

Parameters

seed

[number, number, number]

Returns

NeuroVol

Implementation of

INeuroVec.temporalCorrelation


temporalCorrelationMap()

ts
temporalCorrelationMap(seedVol): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:287

Parameters

seedVol

NeuroVol

Returns

INeuroVec

Implementation of

INeuroVec.temporalCorrelationMap


zscore()

ts
zscore(): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:291

Returns

INeuroVec

Implementation of

INeuroVec.zscore


percentSignalChange()

ts
percentSignalChange(baseline?): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:296

Parameters

baseline?

number[]

Returns

INeuroVec

Implementation of

INeuroVec.percentSignalChange


clone()

ts
clone(): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:301

Returns

INeuroVec

Implementation of

INeuroVec.clone


slice()

ts
slice(startTime, endTime): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:308

Parameters

startTime

number

endTime

number

Returns

INeuroVec

Implementation of

INeuroVec.slice


concatenate()

ts
concatenate(other): INeuroVec;

Defined in: src/vec/FileBackedNeuroVec.ts:338

Parameters

other

INeuroVec

Returns

INeuroVec

Implementation of

INeuroVec.concatenate


clearCache()

ts
clearCache(): void;

Defined in: src/vec/FileBackedNeuroVec.ts:433

Clear the cache

Returns

void


getCacheStats()

ts
getCacheStats(): object;

Defined in: src/vec/FileBackedNeuroVec.ts:441

Get cache statistics

Returns

object

size
ts
size: number;
maxSize
ts
maxSize: number;
hitRate
ts
hitRate: number;

Released under the MIT License.