Last updated

API / geotoolkit / ivaapbackend / reservoir / RemoteReservoirDataSource / RemoteReservoirDataSource

Namespace: RemoteReservoirDataSource

reservoir.RemoteReservoirDataSource.RemoteReservoirDataSource

Table of contents

Type Aliases

Contents

Type Aliases

ArrayCells

Ƭ ArrayCells: Object

The cells coordinates stored in three (x, y ,z) typed arrays.

Type declaration

NameTypeDescription
ijkUint16ArrayIJK indices of values in a contiguous typed array
ijkcountCoordinatesThe number of I, J and K indices this set of values cover.
xFloat32ArrayThe cells X coordinates, stored in a contiguous typed array. Each cell is stored as 8 contiguous x values, representing the 8 corners of the cell.
yFloat32ArrayThe cells Y coordinates, stored in a contiguous typed array. Each cell is stored as 8 contiguous y values, representing the 8 corners of the cell.
zFloat32ArrayThe cells Z coordinates, stored in a contiguous typed array. Each cell is stored as 8 contiguous z values, representing the 8 corners of the cell.

ArrayValues

Ƭ ArrayValues: Object

Type declaration

NameTypeDescription
ijkUint16ArrayIJK indices of values in a contiguous typed array
ijkcountCoordinatesThe number of I, J and K indices this set of values cover.
nanvaluenumberThe value representing the absence of value. Default is -999.25
valuesFloat32Arrayvalues in contiguous typed array
valuesrangeRangevalues range

LegacyCell

Ƭ LegacyCell: CellPosition & { value: number }

Defines Cell properties


LegacyValues

Ƭ LegacyValues: Object

Defines Values properties

Type declaration

NameTypeDescription
values{ ijk: number[] ; value: number }[]values
valuesrangeRangevalues range

MetaInfo

Ƭ MetaInfo: Object

Defines meta information from backend

Type declaration

NameTypeDescription
areaOfUseBBox{ geometry: { coordinates: [[x: number, y: number, z: number], [x: number, y: number, z: number]] ; type: string } ; type: string }bounding box geometry
areaOfUseBBox.geometry{ coordinates: [[x: number, y: number, z: number], [x: number, y: number, z: number]] ; type: string }The geometry of this boundingBox
areaOfUseBBox.geometry.coordinates[[x: number, y: number, z: number], [x: number, y: number, z: number]]The start and end coordinates of the bounding box
areaOfUseBBox.geometry.typestringThe geometry type
areaOfUseBBox.typestringThe type name of this parameter
infvaluenumberinfinite value
levelsnumber[]array of levels
namestringname of data reservoir
nanvaluenumberNaN value
ninumberi dimension
njnumberj dimension
nknumberk dimension
origin{ x: number ; y: number ; z: number }origin
origin.xnumberx origin
origin.ynumbery origin
origin.znumberz origin
properties{ kind: string ; max: number ; min: number ; name: string ; uid: string }[]array of properties
unitstringunit of measurement
zfield{ desc: string ; format: number ; id: number ; iskey: boolean ; name: string }z field
zfield.descstringzfield description
zfield.formatnumberzfield format type
zfield.idnumberzfield identifier
zfield.iskeybooleana flag indicating whether the field is an indexed key
zfield.namestringzfield name

Options

Ƭ Options: Options & OptionsBase & { efficientdatalayout?: boolean }

options


OptionsBase

Ƭ OptionsBase: Object

Type declaration

NameTypeDescription
error?{ cell?: number ; value?: number }Error tolerance for ZFP compression. Default value is 0 (lossless). Any value above 0 will reduce the accuracy of the data by the absolute amount specified, but will result in greater compression.
error.cell?numberAbsolute error for compression of cells geometry. Because geometry coordinates are very sensitive to compression, it is recommended to leave 0 (lossless compression).
error.value?numberAbsolute error for compression of values. A value too high will impact values accuracy. Recommended value can be computed from metaDatas: valueError = (maxValue - minValue) / 1000 .
zfp?booleanEnable ZFP decompression. It is supported if browser supports WebAssembly