IntegrateLabelCellsResults

Wrapper around the integrated cell labelling results on the Wasm heap, typically produced by integrateLabelCells.

Methods

delta(optionsopt) → {Float64Array|Float64WasmArray}

Source:

labelCells.js, line 680

Parameters:

Name Type Attributes Default Description

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`copy`	boolean \| string	<optional>	`true`	Copying mode, see `possibleCopy` for details.

Returns:

Array of length equal to the number of cells, containing the difference in scores between the best and second-best references.

Type: Float64Array | Float64WasmArray

free()

Source:

labelCells.js, line 690

Returns:

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

numberOfCells() → {number}

Source:

labelCells.js, line 614

Returns:

Number of cells that were labelled.

Type: number

numberOfReferences() → {number}

Source:

labelCells.js, line 607

Returns:

Number of labels used in integratedLabelCells.

Type: number

predicted(optionsopt) → {Int32Array|Int32WasmArray}

Source:

labelCells.js, line 625

Parameters:

Name Type Attributes Default Description

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`copy`	boolean \| string	<optional>	`true`	Copying mode, see `possibleCopy` for details.

Returns:

Array of length equal to the number of cells, containing the index of the best reference for each cell.

Type: Int32Array | Int32WasmArray

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

Source:

labelCells.js, line 642

Parameters:

Name Type Attributes Default Description

i

number

Index of the cell of interest.

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`asTypedArray`	boolean	<optional>	`true`	Whether to return a Float64Array. If `false`, a Float64WasmArray is returned instead.
`buffer`	Float64WasmArray	<optional> <nullable>	`null`	Buffer in which to store the output. This should have the same length as the `numberOfReferences`.

Returns:

Array containing the scores for this cell across all labels. If buffer is supplied, the function returns buffer if asTypedArray = false, or a view on buffer if asTypedArray = true.

Type: Float64Array | Float64WasmArray

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

Source:

labelCells.js, line 667

Parameters:

Name Type Attributes Default Description

i

number

Index of the reference of interest.

options

object

{}

Optional parameters.

Properties

Name	Type	Attributes	Default	Description
`copy`	boolean \| string	<optional>	`true`	Copying mode, see `possibleCopy` for details.

Returns:

Array containing the scores across all cells for this label.

Type: Float64Array | Float64WasmArray