Class: NeuroAtlas

Defined in: src/atlas/NeuroAtlas.ts:39

NeuroAtlas Class

Constructors

Constructor

new NeuroAtlas(atlasVol, metadata): NeuroAtlas;

Defined in: src/atlas/NeuroAtlas.ts:49

Parameters

atlasVol

ClusteredNeuroVol

metadata

AtlasMetadata

Returns

NeuroAtlas

Properties

name

readonly name: string;

Defined in: src/atlas/NeuroAtlas.ts:40

---

atlas

readonly atlas: ClusteredNeuroVol;

Defined in: src/atlas/NeuroAtlas.ts:41

---

labels

readonly labels: string[];

Defined in: src/atlas/NeuroAtlas.ts:42

---

ids

readonly ids: number[];

Defined in: src/atlas/NeuroAtlas.ts:43

---

cmap

readonly cmap: number[][];

Defined in: src/atlas/NeuroAtlas.ts:44

---

hemi?

readonly optional hemi?: string[];

Defined in: src/atlas/NeuroAtlas.ts:45

---

network?

readonly optional network?: string[];

Defined in: src/atlas/NeuroAtlas.ts:46

---

origLabels?

readonly optional origLabels?: string[];

Defined in: src/atlas/NeuroAtlas.ts:47

Methods

getROI()

getROI(params): ROIVol | null;

Defined in: src/atlas/NeuroAtlas.ts:64

Retrieves an ROI by label or id.

Parameters

params

Object containing either 'label' or 'id'.

label?

string

id?

number

Returns

ROIVol | null

---

mergeAtlases()

mergeAtlases(otherAtlas): NeuroAtlas;

Defined in: src/atlas/NeuroAtlas.ts:103

Merges two atlases into a new NeuroAtlas instance.

Parameters

otherAtlas

NeuroAtlas

The other NeuroAtlas to merge with.

Returns

NeuroAtlas

---

show()

show(): void;

Defined in: src/atlas/NeuroAtlas.ts:196

Displays information about the NeuroAtlas instance.

Returns

void

---

loadAtlas()

static loadAtlas(
   url, 
   metadataUrl, 
   useCache?): Promise<NeuroAtlas>;

Defined in: src/atlas/NeuroAtlas.ts:210

Static method to load an atlas from a URL or local cache.

Parameters

url

string

URL to download the atlas data.

metadataUrl

string

URL to download the atlas metadata.

useCache?

boolean = true

Whether to use cached data if available.

Returns

Promise<NeuroAtlas>

---

loadGlasserAtlas()

static loadGlasserAtlas(useCache?): Promise<NeuroAtlas>;

Defined in: src/atlas/NeuroAtlas.ts:283

Static method to load the Glasser atlas.

Parameters

useCache?

boolean = true

Whether to use cached data if available.

Returns

Promise<NeuroAtlas>

---

loadSchaeferAtlas()

static loadSchaeferAtlas(options?): Promise<NeuroAtlas>;

Defined in: src/atlas/NeuroAtlas.ts:387

Static method to load the Schaefer atlas.

Parameters

options?

SchaeferAtlasOptions = {}

Configuration options for loading the atlas.

Returns

Promise<NeuroAtlas>