Abstract Class: ROI

Defined in: src/roi/ROI_base.ts:10

Abstract base class for Region of Interest (ROI) objects.

Direct translation of Python's ROI abstract base class.

Extended by

• ROICoords

Constructors

Constructor

new ROI(): ROI;

Returns

ROI

Properties

space

abstract readonly space: NeuroSpace;

Defined in: src/roi/ROI_base.ts:11

---

coords

abstract readonly coords: number[][];

Defined in: src/roi/ROI_base.ts:12

Accessors

length

Get Signature

get abstract length(): number;

Defined in: src/roi/ROI_base.ts:17

Get the number of voxels in the ROI.

Returns

number

Methods

indices()

abstract indices(): number[];

Defined in: src/roi/ROI_base.ts:22

Get linear indices for the coordinates.

Returns

number[]

---

toString()

abstract toString(): string;

Defined in: src/roi/ROI_base.ts:27

String representation of the ROI.

Returns

string