ReducedDimensionResult

ReducedDimensionResult

An interface to the wobbegong representation of a reduced dimension result.

Constructor

new ReducedDimensionResult(summary, path, fetch_range)

Source:
Parameters:
Name Type Description
summary object

A summary of the reduced dimension result's contents, according to the wobbegong specifications.
path string

Path to the reduced dimension result's directory. This may be a relative or absolute path, depending on how the files are hosted.
fetch_range function

A function that accepts file (a path to a file inside path), start and end. It should retrieve bytes from file in the interval [start, end) and return a Uint8Array containing those bytes. It may also return a promise that resolves to such a Uint8Array.

Classes

ReducedDimensionResult

Methods

(async) column(i, optionsopt) → {Array|Int32Array|Float64Array}

Source:
Parameters:
Name Type Attributes Default Description
i number

Row index.
options object <optional>
 {}

Further options.

Properties
Name Type Attributes Default Description
missing string <optional>
 "null"

How to handle missing values for integer arrays, see the corresponding option in decodeIntegers.
Returns:

Array of length equal to the number of rows, containing the contents of column i.

Type
Array | Int32Array | Float64Array

numberOfColumns() → {number}

Source:
Returns:

Number of columns.

Type
number

numberOfRows() → {number}

Source:
Returns:

Number of rows.

Type
number

type() → {string}

Source:
Returns:

Type of the matrix, typically either boolean, integer or double.

Type
string