Global

(constant) cacheAPI

Enhanced fetch with universal caching

Source:

modules/data/utils/data-cache.js, line 1175

(constant) GRIDDED_SOURCES

Configuration for gridded data sources Maps source name to DataSource class and method mapping Centralized in utils to keep data.js clean

Source:

modules/data/utils/index.js, line 35

(constant) modelRegistry

Fat Worker for Neural Network operations. Holds all model instances and performs all heavy computation.

Source:

modules/analyze/components/utils/nn.worker.js, line 8

(private) _dx()

Centralized band derivative

Source:

modules/analyze/components/geoprocessor.js, line 362

(async, private) _ensureLibraries()

Source:

modules/analyze/components/geoprocessor.js, line 72

(async, private) _ensureWorker()

Source:

modules/analyze/components/geoprocessor.js, line 22

(async, private) _openFromArrayBuffer()

Source:

modules/analyze/components/geoprocessor.js, line 89

(async) _openGDALSource()

Helper to initialize GDAL and open a source dataset. Reduces code duplication.

Source:

modules/analyze/components/geoprocessor.js, line 706

(private) _runWorker()

Source:

modules/analyze/components/geoprocessor.js, line 52

(private) _toGeorasterObject()

Source:

modules/analyze/components/geoprocessor.js, line 281

(async, private) _toGeoTIFF()

Source:

modules/analyze/components/geoprocessor.js, line 213

(async, private) addCustomLegend(param0)

Adds a custom legend to the map based on the map type and position specified.

Parameters:

Name Type Description

param0

Object

Object containing the map type and position for the legend.

Properties

Name	Type	Description
`position`	string	The position for the legend (top, top left, left, bottom left, bottom, bottom right, right, top right).

Source:

modules/map/map.js, line 1828

(async) algebra(options) → {Promise.<Object>}

Performs arithmetic operations between two rasters.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Description
`op`	string	Operation to perform: "add", "sub", "mul", or "div".

data

Array.<Object>

Input data containing two objects with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 534

Returns:

Result containing the processed single-band GeoTIFF buffer.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.algebra({
  args: { op: 'sub' },
  data: [{ buffer: bufferA }, { buffer: bufferB }]
});

(async) aspect()

Calculates Aspect using GDAL.

Source:

modules/analyze/components/geoprocessor.js, line 592

(async) bandMath(options) → {Promise.<Object>}

Performs mathematical expressions on raster bands.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Description
`expr`	string	Mathematical expression (e.g., "(nir-red)/(nir+red)").
`bands`	Object.<string, number>	Mapping of variable names to band indices (e.g., { red: 0, nir: 3 }).

data

Array.<Object>

Input data containing one object with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 482

Returns:

Result containing the processed single-band GeoTIFF buffer.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.bandMath({
  args: { expr: "(nir - red) / (nir + red)", bands: { red: 0, nir: 3 } },
  data: [{ buffer: multispectralBuffer }]
});

(async) clip(options) → {Promise.<Object>}

Clips a raster to a pixel-based window.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Description
`window`	Array.<number>	Clipping window `[startX, startY, endX, endY]`.

data

Array.<Object>

Input data containing one object with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 1378

Returns:

Result containing clipped GeoTIFF buffer.

Type: Promise.<Object>

(async) clipGeo(options) → {Promise.<ArrayBuffer>}

Clips a GeoTIFF to the specified bounding box using GDAL WASM (GDALTranslate).

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Description
`bounds`	Array.<number>	Bounding box [minX, minY, maxX, maxY].

data

Array.<Object> | ArrayBuffer

Input data (ArrayBuffer of GeoTIFF).

Source:

modules/analyze/components/geoprocessor.js, line 742

Returns:

Clipped GeoTIFF buffer.

Type: Promise.<ArrayBuffer>

(private) convertAORCToNetCDF(data) → {Object}

Convert AORC data to NetCDF-compatible structure

Parameters:

Name	Type	Description
`data`	Object	AORC data

Source:

modules/data/utils/aorc-utils.js, line 810

Returns:

NetCDF-compatible structure

Type: Object

(async) convertGeoTIFFToGeoraster(tiff) → {Promise.<Object>}

Converts a GeoTIFF object (from geotiff.js) to the georaster format expected by layer functions

Parameters:

Name	Type	Description
`tiff`	Object	GeoTIFF object

Source:

modules/map/map.js, line 1649

Returns:

Georaster-like object

Type: Promise.<Object>

(private) convertToArray()

Convert data to array format

Source:

modules/data/utils/data-transformers.js, line 249

(private) convertToCSV()

Convert data to CSV format based on source

Source:

modules/data/utils/data-transformers.js, line 176

(private) convertToNetCDF()

Convert data to NetCDF format based on source

Source:

modules/data/utils/data-transformers.js, line 205

(private) createGoogleMapsGeoRasterLayer(georaster, styleOptions) → {Object}

Creates a georaster layer for Google Maps using canvas overlay

Parameters:

Name	Type	Description
`georaster`	Object	Georaster object with elevation data
`styleOptions`	Object	Styling options for the layer

Source:

modules/map/map.js, line 1201

Returns:

Google Maps overlay object

Type: Object

(private) createLeafletCanvasGeoRasterLayer(georaster, options) → {Object}

Creates a canvas-based georaster layer for Leaflet (fallback)

Parameters:

Name	Type	Description
`georaster`	Object	Georaster object with elevation data
`options`	Object	Layer options

Source:

modules/map/map.js, line 1514

Returns:

Leaflet canvas layer

Type: Object

(async, private) createLeafletGeoRasterLayer(georaster, styleOptions) → {Object}

Creates a georaster layer for Leaflet

Parameters:

Name	Type	Description
`georaster`	Object	Georaster object with elevation data
`styleOptions`	Object	Styling options for the layer

Source:

modules/map/map.js, line 1319

Returns:

Leaflet layer object

Type: Object

createSegmentationModel()

Creates a simple Fully Convolutional Network (FCN) for segmentation. Preserves spatial dimensions using padding='same'.

Source:

modules/analyze/components/utils/nn.worker.js, line 109

(private) createSimpleGeoRasterOverlay(georaster, options) → {Object}

Creates a simple image overlay from georaster data

Parameters:

Name	Type	Description
`georaster`	Object	Georaster object with elevation data
`options`	Object	Layer options

Source:

modules/map/map.js, line 1397

Returns:

Leaflet image overlay

Type: Object

createStore()

Create a fetch store for the given URL

Source:

external/gridded-data/zarr/zarr.js, line 83

createTransformer()

Creates a simple Transformer model for time-series. Uses 1D convolution as a proxy for embedding + MultiHeadAttention (if available) or simplified attention. Since standard TF.js layers might be limited, we use a functional approach.

Source:

modules/analyze/components/utils/nn.worker.js, line 154

createZarrStore(url) → {Object}

Utility function for creating Zarr stores and arrays using zarrita

Parameters:

Name	Type	Description
`url`	string	Base URL for the Zarr store

Source:

external/gridded-data/zarr/zarr.js, line 76

Returns:

Zarrita utilities

Type: Object

(async) decompressGzip(compressedData) → {Promise.<ArrayBuffer>}

Decompresses gzip data

Parameters:

Name	Type	Description
`compressedData`	ArrayBuffer	Gzipped data

Source:

external/gridded-data/geospatial/geospatial.js, line 255

Returns:

Decompressed data

Type: Promise.<ArrayBuffer>

determinePRISMRegion(bbox) → {string}

Determine appropriate region based on bounding box

Parameters:

Name	Type	Description
`bbox`	Array	Bounding box [west, south, east, north]

Source:

modules/data/datasources/prism.js, line 296

Returns:

Region code (us, ak, hi, pr)

Type: string

drawHtmlTable()

Renders a simple HTML table from 2D array data.

Source:

modules/visualize/visualize.js, line 1373

(async) execute(params, args, data) → {Promise.<Object>}

Executes a raster operation based on params.

Parameters:

Name Type Description

params

Object

Action configuration.

Properties

Name	Type	Description
`action`	string	The name of the function to execute (e.g. 'slope', 'hillshade').

args

Object

Arguments specific to the action.

data

Array.<Object>

Array of input data objects, each containing a buffer property (ArrayBuffer).

Source:

modules/analyze/components/geoprocessor.js, line 406

Returns:

Result object { ok, result, ... }.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.execute({
  params: { action: 'slope' },
  args: { cellSize: 30 },
  data: [{ buffer: arrayBuffer }]
});

(async) extractGRIB2Data(grib2Data, options) → {Promise.<Object>}

Extract GRIB2 data in HydroLang format

Parameters:

Name	Type	Description
`grib2Data`	Object	Parsed GRIB2 data from parseGRIB2
`options`	Object	Extraction options

Source:

external/gridded-data/grib2/grib2.js, line 4173

Returns:

Extracted data in HydroLang format

Type: Promise.<Object>

(async) fillSinks(params) → {Promise.<ArrayBuffer>}

Fills sinks in a DEM (Priority-Flood).

Parameters:

Name	Type	Description
`params`	Object	{ args: {}, data: ArrayBuffer }

Source:

modules/analyze/components/geoprocessor.js, line 1112

Returns:

Filled DEM GeoTIFF.

Type: Promise.<ArrayBuffer>

flattenND(data) → {Array}

Recursively flattens an n-dimensional array.

Parameters:

Name	Type	Description
`data`	Array	The nested array to flatten.

Source:

modules/analyze/components/utils/nn.utils.js, line 14

Returns:

A flat array.

Type: Array

formatPRISMTimePeriod(date, dataType) → {string}

Parse date to PRISM time period format

Parameters:

Name	Type	Description
`date`	Date	Input date
`dataType`	string	Type of data ('daily', 'monthly', 'annual', 'normals')

Source:

modules/data/datasources/prism.js, line 272

Returns:

Formatted time period string

Type: string

(private) generateNWMDateRange(startDate, endDate, frequency) → {Array.<Date>}

Generate NWM date range

Parameters:

Name	Type	Description
`startDate`	Date	Start date
`endDate`	Date	End date
`frequency`	string	Frequency (hourly, daily)

Source:

modules/data/utils/nwm-utils.js, line 312

Returns:

Array of dates

Type: Array.<Date>

generatePRISMFileURL(variable, region, resolution, timePeriod, format, stability) → {string}

Generate PRISM file URL based on parameters

Parameters:

Name	Type	Description
`variable`	string	Variable name (ppt, tmin, etc.)
`region`	string	Region code (us, ak, hi, pr)
`resolution`	string	Resolution code (15s, 30s, 25m)
`timePeriod`	string	Time period string
`format`	string	Format type ('new' or 'legacy')
`stability`	string	Stability level (legacy only)

Source:

modules/data/datasources/prism.js, line 250

Returns:

Complete download URL

Type: string

getArrayData()

Get full array data

Source:

external/gridded-data/zarr/zarr.js, line 104

getChunk()

Get array chunk

Source:

external/gridded-data/zarr/zarr.js, line 114

(async) getFile(params, args, data) → {Promise.<Object>}

Get a raw cached file for manual processing

Parameters:

Name Type Description

params

Object

Parameters object

Properties

Name	Type	Description
`source`	string	Data source
`datatype`	string	Data type

args

Object

Arguments object

Properties

Name	Type	Description
`key`	string	Cache key to retrieve

data

Object

Data object (unused)

Source:

modules/data/data.js, line 541

Returns:

Raw file data and metadata

Type: Promise.<Object>

getInfo() → {Object}

Get GRIB2 library info

Source:

external/gridded-data/grib2/grib2.js, line 4269

Returns:

Library info

Type: Object

(private) getLeafletColorForElevation(normalizedValue, colorScheme) → {Object}

Gets color for elevation value in Leaflet format

Parameters:

Name	Type	Description
`normalizedValue`	number	Normalized elevation (0-1)
`colorScheme`	string \| Array	Color scheme name or array of hex colors

Source:

modules/map/map.js, line 1547

Returns:

RGB color object

Type: Object

(private) getMap() → {Object}

Returns the current map instance (Leaflet or Google Maps)

Source:

modules/map/map.js, line 2171

Returns:

Map instance

Type: Object

(private) getNWMTemporalInfo(datasetConfig) → {Object}

Get NWM temporal information

Parameters:

Name	Type	Description
`datasetConfig`	Object	NWM dataset configuration

Source:

modules/data/utils/nwm-utils.js, line 295

Returns:

Temporal information

Type: Object

getRecommendedPRISMResolution(region, dataType, format) → {string}

Get recommended resolution for region and data type

Parameters:

Name	Type	Description
`region`	string	Region code
`dataType`	string	Data type
`format`	string	Format type ('new' or 'legacy')

Source:

modules/data/datasources/prism.js, line 340

Returns:

Recommended resolution code

Type: string

getRegion()

Get array region

Source:

external/gridded-data/zarr/zarr.js, line 121

goldfeldQuandtTest(params, args, data) → {Object}

Performs Goldfeld-Quandt test for heteroscedasticity.

Parameters:

Name	Type	Description
`params`	Object	Not used by this function.
`args`	Object	Not used by this function.
`data`	Object	Contains: residuals (Array of residuals from a regression model) and independentVar (Array of values of the independent variable).

Author:

riya-patil

Source:

modules/analyze/components/stats.js, line 2738

Throws:

If the input arrays have different lengths.
Type Error

Returns:

Object containing test statistic and p-value.

Type: Object

Example

const residuals = [1.2, 2.3, 0.8, 1.9, 1.5, 2.6];
const independentVar = [3, 4, 5, 6, 7, 8];
const result = stats.goldfeldQuandtTest({ data: { residuals, independentVar } });
console.log(result);

gridToTensor(params) → {tf.Tensor}

Converts 2D grid data (e.g., from GRIB2/Zarr decoders) to a Tensor. Can handle adding a channel dimension if needed (e.g., for CNNs).

Parameters:

Name	Type	Description
`params`	Object	{ data, rows, cols }

Source:

modules/analyze/components/utils/nn.utils.js, line 45

Returns:

Tensor of shape [1, rows, cols, 1]

Type: tf.Tensor

(async) hillshade(options) → {Promise.<ArrayBuffer>}

Calculates Hillshade using GDAL.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Attributes	Default	Description
`zFactor`	number	<optional>	1	Vertical exaggeration.
`scale`	number	<optional>	1	Ratio of vertical units to horizontal.
`azimuth`	number	<optional>	315	Azimuth of the light (degrees).
`altitude`	number	<optional>	45	Altitude of the light (degrees).

data

Array.<Object>

Input data containing a DEM { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 728

Returns:

Hillshade raster buffer.

Type: Promise.<ArrayBuffer>

imgToTensor(params) → {tf.Tensor4D}

Converts an image (HTMLImageElement, Canvas, or pixel array) to a 4D Tensor. Useful for CNN inputs.

Parameters:

Name	Type	Description
`params`	Object	{ image, width, height, channels }

Source:

modules/analyze/components/utils/nn.utils.js, line 25

Returns:

Tensor of shape [1, height, width, channels]

Type: tf.Tensor4D

(async) info(options) → {Promise.<Object>}

Extracts metadata from a GeoTIFF buffer.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Description
`data`	Array.<Object>	Input data containing one object with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 448

Returns:

Metadata object including width, height, bbox, origin, resolution, and native directory.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.info({
  data: [{ buffer: arrayBuffer }]
});

isLoaded() → {boolean}

Check if GRIB2 library is loaded

Source:

external/gridded-data/grib2/grib2.js, line 4261

Returns:

True if loaded

Type: boolean

(async) load(options) → {Promise.<Object>}

Load function for GRIB2 library integration

Parameters:

Name	Type	Description
`options`	Object	Load options

Source:

external/gridded-data/grib2/grib2.js, line 4231

Returns:

Loaded GRIB2 library interface

Type: Promise.<Object>

(async, private) loadGeoRasterLayerPlugin() → {Promise.<void>}

Attempts to load the GeoRasterLayer plugin for Leaflet

Source:

modules/map/map.js, line 1614

Returns:

Type: Promise.<void>

(async) loadGeoTIFFFromBuffer(arrayBuffer) → {Promise.<Object>}

Loads GeoTIFF from array buffer directly

Parameters:

Name	Type	Description
`arrayBuffer`	ArrayBuffer	Raw TIFF data

Source:

external/gridded-data/geospatial/geospatial.js, line 278

Returns:

Parsed TIFF data

Type: Promise.<Object>

(async) mapPixels(options) → {Promise.<Float32Array>}

Map a function over every pixel in a raster.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Description
`func`	function \| string	Function(val, x, y) or string body.

data

Array.<Object>

Input data { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 1192

Returns:

Raw raster data (Float32Array).

Type: Promise.<Float32Array>

(async) mask(options) → {Promise.<Object>}

Creates a binary mask based on min/max threshold values.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Attributes	Default	Description
`min`	number	<optional>	-Infinity	Minimum value (inclusive).
`max`	number	<optional>	Infinity	Maximum value (inclusive).

data

Array.<Object>

Input data containing one object with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 766

Returns:

Result containing binary mask (0 or 1).

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.mask({
  args: { min: 0, max: 1000 },
  data: [{ buffer: demBuffer }]
});

openArray()

Open a Zarr array from the store

Source:

external/gridded-data/zarr/zarr.js, line 93

(async) parseGRIB2(buffer) → {Promise.<Object>}

Parse GRIB2 file buffer using standalone parser

Parameters:

Name	Type	Description
`buffer`	ArrayBuffer	GRIB2 file buffer

Source:

external/gridded-data/grib2/grib2.js, line 4209

Returns:

Parsed GRIB2 data

Type: Promise.<Object>

(async) pca(options) → {Promise.<Object>}

Performs Principal Component Analysis (PCA) on multiband rasters.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Attributes	Description
`components`	number	<optional>	Number of PCA components to keep. Defaults to all bands.

data

Array.<Object>

Input data containing a multiband raster { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 1246

Returns:

Result containing multi-band GeoTIFF with principal components.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.pca({
  args: { components: 3 },
  data: [{ buffer: multibandBuffer }]
});

(private) preprocess(params, data) → {Array}

Preprocesses 1D data into LSTM-ready 3D format.

Parameters:

Name	Type	Description
`params`	Object	Contains: inputWindow (timeSteps), outputWindow (predictions).
`data`	Array	1D array of values.

Source:

modules/analyze/components/nn.js, line 465

Returns:

[X, y] where X is 3D array and y is 2D array.

Type: Array

(private) processAORCBulkExtraction(args, datasetConfig) → {Promise.<Object>}

Process AORC bulk extraction request

Parameters:

Name	Type	Description
`args`	Object	Request arguments
`datasetConfig`	Object	AORC dataset configuration

Source:

modules/data/utils/aorc-utils.js, line 758

Returns:

Bulk extraction results

Type: Promise.<Object>

processGriddedSource(source, dataType, args, datasources) → {Promise}

Generic processor for all gridded data sources Replaces 8 individual processXXXData functions with a single unified handler Centralized in utils to keep data.js clean

Parameters:

Name	Type	Description
`source`	string	Source name (e.g., 'aorc', 'mrms', 'hrrr')
`dataType`	string	Data type (e.g., 'point-data', 'grid-data')
`args`	Object	Arguments for data extraction
`datasources`	Object	Datasources configuration object

Source:

modules/data/utils/index.js, line 111

Returns:

Result from data source

Type: Promise

(async) recenter(param0)

Parameters:

Name	Type	Description
`param0`	*

Source:

modules/map/map.js, line 728

(async) reproject(options) → {Promise.<Object>}

Reprojects a raster to a different Coordinate Reference System (CRS).

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Attributes	Default	Description
`dstCRS`	string			Destination CRS definition (WKT or Proj4 string).
`srcCRS`	string	<optional>		Source CRS definition. If not provided, attempts to read from GeoTIFF keys.
`width`	number	<optional>		Output width.
`height`	number	<optional>		Output height.
`method`	string	<optional>	'nearest'	Resampling method ('nearest', 'bilinear').

data

Array.<Object>

Input data containing one object with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 1450

Returns:

Result containing reprojected GeoTIFF buffer.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.reproject({
  args: { dstCRS: 'EPSG:3857' },
  data: [{ buffer: bufferIn4326 }]
});

(async) saveFile(params, args, data) → {Promise.<boolean>}

Save processed data with a user-defined key

Parameters:

Name Type Description

params

Object

Parameters object

Properties

Name	Type	Description
`source`	string	Data source
`datatype`	string	Data type

args

Object

Arguments object

Properties

Name	Type	Description
`key`	string	User-defined key for the dataset
`name`	string	Optional human-readable name

data

Object

Data object to save

Source:

modules/data/data.js, line 576

Returns:

Success status

Type: Promise.<boolean>

seriesToTensor(params) → {Object}

Prepares time-series data for LSTM (Samples, TimeSteps, Features).

Parameters:

Name	Type	Description
`params`	Object	{ data, windowSize }

Source:

modules/analyze/components/utils/nn.utils.js, line 60

Returns:

{ inputs, outputs } tensors

Type: Object

(async) slope()

Calculates Slope using GDAL.

Source:

modules/analyze/components/geoprocessor.js, line 582

sourceType(args, dataType) → {string}

Generates the URL for CHIRPS data based on user arguments.

Parameters:

Name	Type	Description
`args`	Object	Arguments for the request
`dataType`	string	Type of data requested (mapped to dataset key)

Source:

modules/data/datasources/chirps.js, line 106

Returns:

Fully constructed URL

Type: string

(async) streamExtract(options) → {Promise.<Object>}

Extracts stream networks based on flow accumulation threshold.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Attributes	Default	Description
`threshold`	number	<optional>	1000	Accumulation threshold to define a stream.

data

Array.<Object>

Input data containing a DEM { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 1078

Returns:

Result containing binary stream mask.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.streamExtract({
  args: { threshold: 500 },
  data: [{ buffer: demBuffer }]
});

(async) tile(options) → {Promise.<Object>}

Splits a raster into smaller tiles.

Parameters:

Name Type Description

options

Object

Properties

Name Type Description

args

Object

Arguments.

Properties

Name	Type	Attributes	Default	Description
`tileSize`	number	<optional>	256	Width/Height of tiles in pixels.

data

Array.<Object>

Input data containing one object with { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 800

Returns:

Result containing array of tile objects.

Type: Promise.<Object>

Example

await hydro.analyze.geoprocessor.tile({
  args: { tileSize: 512 },
  data: [{ buffer: largeRasterBuffer }]
});

transformVariable()

Transform a single gridded data variable with comprehensive manipulations

Source:

modules/data/data.js, line 649

validatePRISMVariable(variable, dataType) → {boolean}

Validate PRISM variable availability for data type

Parameters:

Name	Type	Description
`variable`	string	Variable name
`dataType`	string	Data type ('normals', 'monthly', 'daily')

Source:

modules/data/datasources/prism.js, line 324

Returns:

True if variable is available for data type

Type: boolean

(async) vectorize(options) → {Promise.<Object>}

Vectorizes a binary raster mask into GeoJSON Polygons.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`args`	Object	<optional>	{}	Arguments.
`data`	Array.<Object>			Input data containing a DEM/Mask { buffer: ArrayBuffer }.

Source:

modules/analyze/components/geoprocessor.js, line 1165

Returns:

Resulting GeoJSON FeatureCollection.

Type: Promise.<Object>

Example

const geojson = await hydro.analyze.geoprocessor.vectorize({
  data: [{ buffer: maskBuffer }]
});

whitesTest(params, args, data) → {Object}

Performs White's test for heteroscedasticity.

Parameters:

Name	Type	Description
`params`	Object	Not used by this function.
`args`	Object	Not used by this function.
`data`	Object	Contains: errors (array of residuals) and regressors (array of regressor vars).

Author:

riya-patil

Source:

modules/analyze/components/stats.js, line 2612

Throws:

If the input arrays have different lengths.
Type Error

Returns:

Object containing test statistic and p-value.

Type: Object

Example

const params = {
  errors: [1, 2, 3, 4, 5],
  regressors: [[1, 1], [2, 1], [3, 1], [4, 1], [5, 1]]
};
hydro.analyze.stats.whitesTest({ data: params });

Members

(constant) cacheAPI

(constant) GRIDDED_SOURCES

(constant) modelRegistry

Methods

(private) _dx()

(async, private) _ensureLibraries()

(async, private) _ensureWorker()

(async, private) _openFromArrayBuffer()

(async) _openGDALSource()

(private) _runWorker()

(private) _toGeorasterObject()

(async, private) _toGeoTIFF()

(async, private) addCustomLegend(param0)

Parameters:

Properties

(async) algebra(options) → {Promise.<Object>}

Parameters:

Properties

Properties

Returns:

Example

(async) aspect()

(async) bandMath(options) → {Promise.<Object>}

Parameters:

Properties

Properties

Returns:

Example

(async) clip(options) → {Promise.<Object>}

Parameters:

Properties

Properties

Returns:

(async) clipGeo(options) → {Promise.<ArrayBuffer>}

Parameters:

Properties

Properties

Returns:

(private) convertAORCToNetCDF(data) → {Object}

Parameters:

Returns:

(async) convertGeoTIFFToGeoraster(tiff) → {Promise.<Object>}

Parameters:

Returns:

(private) convertToArray()

(private) convertToCSV()

(private) convertToNetCDF()

(private) createGoogleMapsGeoRasterLayer(georaster, styleOptions) → {Object}

Parameters:

Returns:

(private) createLeafletCanvasGeoRasterLayer(georaster, options) → {Object}

Parameters:

Returns:

(async, private) createLeafletGeoRasterLayer(georaster, styleOptions) → {Object}

Parameters:

Returns:

createSegmentationModel()

(private) createSimpleGeoRasterOverlay(georaster, options) → {Object}

Parameters:

Returns:

createStore()

createTransformer()

createZarrStore(url) → {Object}

Parameters:

Returns:

(async) decompressGzip(compressedData) → {Promise.<ArrayBuffer>}

Parameters:

Returns:

determinePRISMRegion(bbox) → {string}

Parameters:

Returns:

drawHtmlTable()

(async) execute(params, args, data) → {Promise.<Object>}

Parameters:

Properties

Returns:

Example

(async) extractGRIB2Data(grib2Data, options) → {Promise.<Object>}