Skip to content

Class: ParcelIndex

Defined in: src/parcellation.ts:249

Canonical parcel/native index for one mesh parcellation.

Owns parcel metadata, per-vertex parcel ids, and value-expansion helpers.

Constructors

Constructor

ts
new ParcelIndex(parcelData, vertexLabels): ParcelIndex;

Defined in: src/parcellation.ts:254

Parameters

parcelData

ParcelData

vertexLabels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

Returns

ParcelIndex

Methods

getParcelData()

ts
getParcelData(): ParcelData;

Defined in: src/parcellation.ts:263

Returns

ParcelData


getParcelLookup()

ts
getParcelLookup(): Map<number, ParcelRecord>;

Defined in: src/parcellation.ts:267

Returns

Map<number, ParcelRecord>


getVertexLabels()

ts
getVertexLabels(): Uint32Array;

Defined in: src/parcellation.ts:271

Returns

Uint32Array


getParcelIdForVertex()

ts
getParcelIdForVertex(vertexIndex): number | null;

Defined in: src/parcellation.ts:275

Parameters

vertexIndex

number

Returns

number | null


getParcelRecord()

ts
getParcelRecord(parcelId): ParcelRecord | null;

Defined in: src/parcellation.ts:284

Parameters

parcelId

number

Returns

ParcelRecord | null


getParcelRecordForVertex()

ts
getParcelRecordForVertex(vertexIndex): ParcelRecord | null;

Defined in: src/parcellation.ts:288

Parameters

vertexIndex

number

Returns

ParcelRecord | null


getParcelValue()

ts
getParcelValue(parcelId, valueColumn?): number | null;

Defined in: src/parcellation.ts:293

Parameters

parcelId

number

valueColumn?

string = 'value'

Returns

number | null


setParcelData()

ts
setParcelData(parcelData): void;

Defined in: src/parcellation.ts:307

Parameters

parcelData

ParcelData

Returns

void


setVertexLabels()

ts
setVertexLabels(vertexLabels): void;

Defined in: src/parcellation.ts:312

Parameters

vertexLabels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

Returns

void


setParcellation()

ts
setParcellation(parcelData, vertexLabels): void;

Defined in: src/parcellation.ts:316

Parameters

parcelData

ParcelData

vertexLabels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

Returns

void


mapParcelValues()

ts
mapParcelValues(valueColumn?): Float32Array;

Defined in: src/parcellation.ts:324

Parameters

valueColumn?

string = 'value'

Returns

Float32Array

Released under the MIT License.