Class: StatisticalMapLayer

Defined in: src/layers/StatisticalMapLayer.ts:81

Layer with data values and colormap (smart mode)

Extends

• DataLayer

Constructors

Constructor

new StatisticalMapLayer(
   id, 
   data, 
   indices, 
   colorMap, 
   config?): StatisticalMapLayer;

Defined in: src/layers/StatisticalMapLayer.ts:113

Parameters

id

string

data

Float32Array<ArrayBufferLike> | number[]

indices

Uint32Array<ArrayBufferLike> | number[] | null

colorMap

string | ColorMap | Color[]

config?

StatisticalMapLayerConfig = {}

Returns

StatisticalMapLayer

Overrides

DataLayer.constructor

Properties

id

id: string;

Defined in: src/layers.ts:103

Inherited from

DataLayer.id

---

visible

visible: boolean;

Defined in: src/layers.ts:104

Inherited from

DataLayer.visible

---

opacity

opacity: number;

Defined in: src/layers.ts:105

Inherited from

DataLayer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

DataLayer.blendMode

---

order

order: number;

Defined in: src/layers.ts:107

Inherited from

DataLayer.order

---

needsUpdate

needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

DataLayer.needsUpdate

---

_onChangeCallback

_onChangeCallback: (() => void) | null;

Defined in: src/layers.ts:110

Callback set by the parent surface to trigger re-compositing on change.

Inherited from

DataLayer._onChangeCallback

Methods

setVisible()

setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

DataLayer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

DataLayer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

DataLayer.setBlendMode

---

registerOutlineLayer()

static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

DataLayer.registerOutlineLayer

---

registerTemporalLayer()

static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

DataLayer.registerTemporalLayer

---

fromConfig()

static fromConfig(config): Layer;

Defined in: src/layers.ts:199

Create a concrete Layer instance from a plain object configuration. Supports: base, rgba, data, outline.

Parameters

config

Record<string, any>

Returns

Layer

Inherited from

DataLayer.fromConfig

---

getData()

getData(): Float32Array<ArrayBufferLike> | null;

Defined in: src/layers.ts:447

Returns

Float32Array<ArrayBufferLike> | null

Inherited from

DataLayer.getData

---

getRange()

getRange(): [number, number];

Defined in: src/layers.ts:508

Returns

[number, number]

Inherited from

DataLayer.getRange

---

getThreshold()

getThreshold(): [number, number];

Defined in: src/layers.ts:512

Returns

[number, number]

Inherited from

DataLayer.getThreshold

---

getColorMapName()

getColorMapName(): string;

Defined in: src/layers.ts:516

Returns

string

Inherited from

DataLayer.getColorMapName

---

setMeshAdjacency()

Call Signature

setMeshAdjacency(geometry): void;

Defined in: src/layers/StatisticalMapLayer.ts:159

Set mesh adjacency from a SurfaceGeometry or raw face data. Required before calling applyClusterThreshold().

Parameters

geometry

SurfaceGeometry

Returns

void

Call Signature

setMeshAdjacency(faces, vertexCount): void;

Defined in: src/layers/StatisticalMapLayer.ts:160

Set mesh adjacency from a SurfaceGeometry or raw face data. Required before calling applyClusterThreshold().

Parameters

faces

Uint32Array<ArrayBufferLike> | number[]

vertexCount

number

Returns

void

---

applyFDR()

applyFDR(q): void;

Defined in: src/layers/StatisticalMapLayer.ts:186

Apply FDR (Benjamini-Hochberg) correction. Only vertices with p <= BH-threshold will be visible.

Parameters

q

number

False discovery rate (typically 0.05)

Returns

void

Throws

If p-values were not provided at construction

---

applyBonferroni()

applyBonferroni(alpha): void;

Defined in: src/layers/StatisticalMapLayer.ts:206

Apply Bonferroni correction. Only vertices with p <= alpha/V will be visible.

Parameters

alpha

number

Family-wise error rate (typically 0.05)

Returns

void

Throws

If p-values were not provided at construction

---

applyClusterThreshold()

applyClusterThreshold(threshold, opts): void;

Defined in: src/layers/StatisticalMapLayer.ts:228

Apply cluster-based thresholding. Identifies connected components of supra-threshold vertices via BFS, then removes clusters smaller than minClusterSize.

Parameters

threshold

number

Absolute value threshold for activation

opts

Options with minClusterSize

minClusterSize

number

Returns

void

Throws

If mesh adjacency has not been set

---

clearCorrection()

clearCorrection(): void;

Defined in: src/layers/StatisticalMapLayer.ts:279

Remove all statistical corrections, restoring all supra-threshold vertices.

Returns

void

---

setDualThreshold()

setDualThreshold(config): void;

Defined in: src/layers/StatisticalMapLayer.ts:302

Enable dual-threshold mode with separate positive/negative colormaps.

• Positive values use positiveColorMap within positiveRange
• Negative values use negativeColorMap within negativeRange
• Values between the two ranges (dead zone) are transparent

Parameters

config

DualThresholdConfig

Returns

void

---

clearDualThreshold()

clearDualThreshold(): void;

Defined in: src/layers/StatisticalMapLayer.ts:321

Disable dual-threshold mode, reverting to single-colormap rendering.

Returns

void

---

getCorrectionMethod()

getCorrectionMethod(): CorrectionMethod;

Defined in: src/layers/StatisticalMapLayer.ts:337

Current correction method: 'none', 'fdr', 'bonferroni', or 'cluster'

Returns

CorrectionMethod

---

getFDRQ()

getFDRQ(): number;

Defined in: src/layers/StatisticalMapLayer.ts:342

Current FDR q-value (0 if FDR not active)

Returns

number

---

getBonferroniAlpha()

getBonferroniAlpha(): number;

Defined in: src/layers/StatisticalMapLayer.ts:347

Current Bonferroni alpha (0 if Bonferroni not active)

Returns

number

---

getClusterMinSize()

getClusterMinSize(): number;

Defined in: src/layers/StatisticalMapLayer.ts:352

Current cluster minimum size (0 if cluster not active)

Returns

number

---

getClusterThreshold()

getClusterThreshold(): number;

Defined in: src/layers/StatisticalMapLayer.ts:357

Current cluster threshold value (0 if cluster not active)

Returns

number

---

getVertexStatInfo()

getVertexStatInfo(vertexIndex): VertexStatInfo | null;

Defined in: src/layers/StatisticalMapLayer.ts:367

Get statistical metadata for a vertex.

Parameters

vertexIndex

number

The vertex to query

Returns

VertexStatInfo | null

Stat info, or null if the vertex index is out of range

---

setColorMap()

setColorMap(colorMap): void;

Defined in: src/layers/StatisticalMapLayer.ts:405

Parameters

colorMap

string | ColorMap | Color[]

Returns

void

Overrides

DataLayer.setColorMap

---

setRange()

setRange(range): void;

Defined in: src/layers/StatisticalMapLayer.ts:413

Parameters

range

[number, number]

Returns

void

Overrides

DataLayer.setRange

---

setThreshold()

setThreshold(threshold): void;

Defined in: src/layers/StatisticalMapLayer.ts:421

Parameters

threshold

[number, number]

Returns

void

Overrides

DataLayer.setThreshold

---

setData()

setData(data, indices?): void;

Defined in: src/layers/StatisticalMapLayer.ts:429

Parameters

data

Float32Array<ArrayBufferLike> | number[]

indices?

Uint32Array<ArrayBufferLike> | number[] | null

Returns

void

Overrides

DataLayer.setData

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: src/layers/StatisticalMapLayer.ts:448

Get RGBA values for this layer Must be implemented by subclasses

Parameters

vertexCount

number

Returns

Float32Array

Overrides

DataLayer.getRGBAData

---

update()

update(updates): void;

Defined in: src/layers/StatisticalMapLayer.ts:519

Update layer data Must be implemented by subclasses

Parameters

updates

StatisticalMapLayerUpdateData

Returns

void

Overrides

DataLayer.update

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/layers/StatisticalMapLayer.ts:532

Serialize common layer state for state persistence. Override in subclasses.

Returns

Record<string, unknown>

Overrides

DataLayer.toStateJSON

---

dispose()

dispose(): void;

Defined in: src/layers/StatisticalMapLayer.ts:545

Returns

void

Overrides

DataLayer.dispose