PerCellAdtQcMetricsResults

PerCellAdtQcMetricsResults

Wrapper for the ADT-based metrics allocated on the Wasm heap, typically produced by computePerCellAdtQcMetrics.

Classes

PerCellAdtQcMetricsResults

Methods

detected(optionsopt) → {Int32Array|Int32WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
options object <optional>
{}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean <optional>
true

Whether to copy the results from the Wasm heap, see possibleCopy.

Returns:

Array containing the total number of detected ADT features for each cell.

Type
Int32Array | Int32WasmArray

free()

Source:
Returns:

Frees the memory allocated on the Wasm heap for this object. This invalidates this object and all references to it.

numberOfCells() → {number}

Source:
Returns:

Number of cells in this object.

Type
number

numberOfSubsets() → {number}

Source:
Returns:

Number of feature subsets in this object.

Type
number

subsetSum(i, optionsopt) → {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
i number

Index of the feature subset of interest.

options object <optional>
{}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean <optional>
true

Whether to copy the results from the Wasm heap, see possibleCopy.

Returns:

Array containing the total count in the ADT subset i for each cell.

Type
Float64Array | Float64WasmArray

sum(optionsopt) → {Float64Array|Float64WasmArray}

Source:
Parameters:
Name Type Attributes Default Description
options object <optional>
{}

Optional parameters.

Properties
Name Type Attributes Default Description
copy boolean <optional>
true

Whether to copy the results from the Wasm heap, see possibleCopy.

Returns:

Array containing the total ADT count for each cell.

Type
Float64Array | Float64WasmArray