Class: LogicalNeuroVol

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

LogicalNeuroVol class for binary/logical 3D neuroimaging volumes.

This class represents volumetric data where each voxel is either true or false. It's useful for masks, ROIs, and binary classifications.

Direct translation of Python's LogicalNeuroVol class.

Extends

• DenseNeuroVol

Constructors

Constructor

new LogicalNeuroVol(
   space, 
   data?, 
   indices?, 
   label?): LogicalNeuroVol;

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

Creates a LogicalNeuroVol instance.

Parameters

space

NeuroSpace

The spatial metadata for the volume

data?

Uint8Array<ArrayBufferLike> | boolean[]

Optional binary data (0 or 1 values)

indices?

number[]

Optional indices to set to true (all others will be false)

label?

string = ""

Optional label for the volume

Returns

LogicalNeuroVol

Overrides

DenseNeuroVol.constructor

Properties

space

readonly space: NeuroSpace;

Defined in: src/volume/DenseNeuroVol.ts:22

Inherited from

DenseNeuroVol.space

Accessors

length

Get Signature

get length(): number;

Defined in: src/volume/DenseNeuroVol.ts:38

Returns

number

Inherited from

DenseNeuroVol.length

---

dim

Get Signature

get dim(): number[];

Defined in: src/volume/DenseNeuroVol.ts:42

Returns

number[]

Inherited from

DenseNeuroVol.dim

---

spacing

Get Signature

get spacing(): number[];

Defined in: src/volume/DenseNeuroVol.ts:46

Returns

number[]

Inherited from

DenseNeuroVol.spacing

---

origin

Get Signature

get origin(): number[];

Defined in: src/volume/DenseNeuroVol.ts:50

Returns

number[]

Inherited from

DenseNeuroVol.origin

Methods

getData()

getData(): TypedArray;

Defined in: src/volume/DenseNeuroVol.ts:54

Returns

TypedArray

Inherited from

DenseNeuroVol.getData

---

setData()

setData(newData): void;

Defined in: src/volume/DenseNeuroVol.ts:62

Replace underlying data in-place to preserve typed array type and views. Useful for fast volume updates (e.g., refreshed overlays) without realloc.

Parameters

newData

TypedArray

Returns

void

Inherited from

DenseNeuroVol.setData

---

get()

get(index): number;

Defined in: src/volume/DenseNeuroVol.ts:70

Parameters

index

number

Returns

number

Inherited from

DenseNeuroVol.get

---

getAt()

getAt(
   i, 
   j, 
   k): number;

Defined in: src/volume/DenseNeuroVol.ts:74

Parameters

i

number

j

number

k

number

Returns

number

Inherited from

DenseNeuroVol.getAt

---

setAt()

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

Defined in: src/volume/DenseNeuroVol.ts:79

Parameters

i

number

j

number

k

number

value

number

Returns

void

Inherited from

DenseNeuroVol.setAt

---

isIdentityMatrix()

isIdentityMatrix(matrix): boolean;

Defined in: src/volume/DenseNeuroVol.ts:84

Parameters

matrix

Matrix

Returns

boolean

Inherited from

DenseNeuroVol.isIdentityMatrix

---

getSlice()

getSlice(zlevel, outAxes): NeuroSlice;

Defined in: src/volume/DenseNeuroVol.ts:106

Parameters

zlevel

number

outAxes

AxisSet3D

Returns

NeuroSlice

Inherited from

DenseNeuroVol.getSlice

---

getRange()

getRange(): [number, number];

Defined in: src/volume/DenseNeuroVol.ts:206

Returns

[number, number]

Inherited from

DenseNeuroVol.getRange

---

getSliceAt()

getSliceAt(
   coord, 
   outAxes, 
   interpolation?): NeuroSlice;

Defined in: src/volume/DenseNeuroVol.ts:231

Parameters

coord

number[]

outAxes

AxisSet3D

interpolation?

"nearest" | "trilinear"

Returns

NeuroSlice

Inherited from

DenseNeuroVol.getSliceAt

---

getBool()

getBool(index): boolean;

Defined in: src/volume/LogicalNeuroVol.ts:66

Get the value at a specific voxel as boolean.

Parameters

index

number

Returns

boolean

---

getBoolAt()

getBoolAt(
   i, 
   j, 
   k): boolean;

Defined in: src/volume/LogicalNeuroVol.ts:73

Get the value at specific coordinates as boolean.

Parameters

i

number

j

number

k

number

Returns

boolean

---

setBool()

setBool(index, value): void;

Defined in: src/volume/LogicalNeuroVol.ts:81

Set a boolean value at a specific index.

Parameters

index

number

value

boolean

Returns

void

---

setBoolAt()

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

Defined in: src/volume/LogicalNeuroVol.ts:88

Set a boolean value at specific coordinates.

Parameters

i

number

j

number

k

number

value

boolean

Returns

void

---

asLogical()

asLogical(): LogicalNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:96

Convert to logical representation (returns self since already logical).

Returns

LogicalNeuroVol

---

asDense()

asDense(): DenseNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:103

Convert to dense representation.

Returns

DenseNeuroVol

---

count()

count(): number;

Defined in: src/volume/LogicalNeuroVol.ts:115

Count the number of true voxels.

Returns

number

---

getTrueIndices()

getTrueIndices(): number[];

Defined in: src/volume/LogicalNeuroVol.ts:126

Get the indices of all true voxels.

Returns

number[]

---

getTrueCoords()

getTrueCoords(): number[][];

Defined in: src/volume/LogicalNeuroVol.ts:139

Get the coordinates of all true voxels.

Returns

number[][]

---

and()

and(other): LogicalNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:158

Logical AND operation with another LogicalNeuroVol.

Parameters

other

LogicalNeuroVol

Returns

LogicalNeuroVol

---

or()

or(other): LogicalNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:174

Logical OR operation with another LogicalNeuroVol.

Parameters

other

LogicalNeuroVol

Returns

LogicalNeuroVol

---

xor()

xor(other): LogicalNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:190

Logical XOR operation with another LogicalNeuroVol.

Parameters

other

LogicalNeuroVol

Returns

LogicalNeuroVol

---

not()

not(): LogicalNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:206

Logical NOT operation.

Returns

LogicalNeuroVol

---

fromThreshold()

static fromThreshold(
   vol, 
   threshold, 
   comparison?): LogicalNeuroVol;

Defined in: src/volume/LogicalNeuroVol.ts:218

Create a logical volume from a threshold operation.

Parameters

vol

NeuroVol

threshold

number

comparison?

"gt" | "lt" | "gte" | "lte" | "eq" | "neq"

Returns

LogicalNeuroVol

---

getSliceTypedArrayType()

getSliceTypedArrayType(): NumericType;

Defined in: src/volume/LogicalNeuroVol.ts:253

Returns

NumericType

Overrides

DenseNeuroVol.getSliceTypedArrayType

---

getDataConstructor()

getDataConstructor(): (length) => Uint8Array;

Defined in: src/volume/LogicalNeuroVol.ts:257

Returns

(length) => Uint8Array

Overrides

DenseNeuroVol.getDataConstructor