Class: NeuroAtlas

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

NeuroAtlas Class

Constructors

Constructor

new NeuroAtlas(atlasVol, metadata): NeuroAtlas;

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

Parameters

atlasVol

ClusteredNeuroVol

metadata

AtlasMetadata

Returns

NeuroAtlas

Properties

name

readonly name: string;

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

---

atlas

readonly atlas: ClusteredNeuroVol;

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

---

labels

readonly labels: string[];

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

---

ids

readonly ids: number[];

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

---

cmap

readonly cmap: number[][];

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

---

hemi?

readonly optional hemi?: string[];

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

---

network?

readonly optional network?: string[];

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

---

origLabels?

readonly optional origLabels?: string[];

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

Methods

getROI()

getROI(params): ROIVol | null;

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

Retrieves an ROI by label or id.

label is looked up first among the unique label-map keys (origLabels when the atlas has them, e.g. Left_V1), then among the region names in labels. A region name shared by several regions (e.g. V1, present in both hemispheres) is ambiguous and throws; use the qualified name 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:167

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:281

Displays information about the NeuroAtlas instance.

Returns

void

---

loadAtlas()

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

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

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(options?): Promise<NeuroAtlas>;

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

Static method to load the Glasser atlas.

Region colours are drawn from a seeded generator (see GlasserAtlasOptions); they are reproducible, and identical across loads unless a different seed or rng is passed.

Parameters

options?

boolean | GlasserAtlasOptions

Options, or a boolean for useCache (the former signature).

Returns

Promise<NeuroAtlas>

---

loadSchaeferAtlas()

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

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

Static method to load the Schaefer atlas.

Parameters

options?

SchaeferAtlasOptions = {}

Configuration options for loading the atlas.

Returns

Promise<NeuroAtlas>