Class: InterpolationAnalystParameters

SuperMap.InterpolationAnalystParameters

The InterpolationAnalystParameters class

new SuperMap.InterpolationAnalystParameters(options)

InterpolationAnalystParameters.js, line 6
Name Type Description
options Object

The parameters.

Name Type Default Description
bounds SuperMap.Bounds | L.Bounds | ol.extent

The range of the interpolation analysis which is used to determine the range of the result raster dataset.
outputDatasetName string

The name of the interpolation analysis result dataset.
outputDatasourceName string

The name of the result datasource in the interpolation analysis.
dataset string optional

The name of the dataset in the datasource for interpolation analysis.When the InterpolationAnalystType is dataset, it is required.
inputPoints Array.<(SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point)> optional

The discrete point set for interpolation analysis. This parameter is a mandatory parameter when the InterpolationAnalystType is geometry.
zValueFieldName string optional

Stores the field name whose value is used in the interpolation analysis.The field of text type is not supported by interpolation analysis. When the interpolation analysis type (InterpolationAnalystType) is dataset, it is a required parameter.
searchRadius number 0 optional

Search radius is the search scope of points in the operation, whose unit is identical to that of the point dataset.
zValueScale number 1 optional

The zoom scale of the value to be interpolated.
resolution number optional

The resolution of the raster dataset of the interpolation result, the actual distance denoted by a cell, has the same unit with that of the point dataset.
filterQueryParameter SuperMap.FilterParameter optional

Attribute filter criteria.
pixelFormat SuperMap.PixelFormat optional

Specifies the pixel format of the output grid dataset.
InterpolationAnalystType string "dataset" optional

The interpolation type is dataset or geometry.

Members

boundsSuperMap.Bounds L.Bounds ol.extent

The range of the interpolation analysis which is used to determine the range of the result raster dataset. If default, then it is the range of the source dataset. Since this is a method of interpolation, the parameter is better less than or equal to the range of the source dataset.

clipParamObject

The parameter to clip the interpolation analysis result.

datasetstring

The name of the dataset in the datasource for interpolation analysis. This identifier is the format "dataset name@datasource alias".
When the InterpolationAnalystType is dataset, it is required.

filterQueryParameterSuperMap.FilterParameter

The property filter condition.The default is null, meaning analysis all points in the dataset

inputPointsArray.<(SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point)>

he discrete point (Z values included) set used in the interpolation analysis. When the InterpolationAnalystType is geometry, it is required. There is no need to specify the datasets inputDatasourceName, inputDatasetName and zValueFieldName through discrete data interpolation analysis.

InterpolationAnalystTypestring

InterpolationAnalystType. The interpolation contains dataset interpolation and the geometry interpolation. "dataset" represents the dataset interpolation; "geometry" represents discrete data interpolation. Default value is "dataset".

Default Value:
"dataset"

outputDatasetNamestring

The name of the interpolation analysis result dataset.

outputDatasourceNamestring

The name of the interpolation analysis result datasource.

pixelFormatSuperMap.PixelFormat

Specifies the pixel format of the output grid dataset. The supported pixel format is: BIT16, BIT32, DOUBLE, SINGLE, UBIT1, UBIT4, UBIT8, UBIT24, and UBIT32.

resolutionnumber

The resolution of the raster dataset of the interpolation result, the actual distance denoted by a cell, has the same unit with that of the point dataset. This value cannot be larger than the length of the bounds to be analyzed. The setting of this value should depend on the dataset extent. If the value of the cell (result_dataset_extent/resolution) is less than 500, this value will better show the trend of the density.

searchRadiusnumber

Search radius is the search scope of points in the operation, whose unit is identical to that of the point dataset. When calculating the Z value of a location (the default value is 0), the sampling points within the range whose radius is the value of the search extent will involve in the operation. Users need to set this value according to the distribution of points to be interpolated and the extent of the dataset.

zValueFieldNamestring

In the dataset interpolation analysis, The field name whose value is used in the interpolation analysis. The field of text type is not supported by interpolation analysis. It refers to the weight of each sampling point. You can set all of this field value to 1. In this case, all points have the same weight. When the InterpolationAnalystType is dataset, required.

zValueScalenumber

The zoom scale of the value to be interpolated whose default value is 1. Specifies the zoom scale of the value to be interpolated.

Default Value:
1

Methods

SuperMap.InterpolationAnalystParameters.toObject(interpolationAnalystParameters, tempObj)

InterpolationAnalystParameters.js, line 143

Transform the InterpolationAnalystParameters to JSON

Name Type Description
interpolationAnalystParameters SuperMap.InterpolationAnalystParameters

The InterpolationAnalystParameters class.
tempObj SuperMap.InterpolationAnalystParameters

The InterpolationAnalystParameters.
Returns:
The JSON object.

destroy()

InterpolationAnalystParameters.js, line 126

Disposes the resource. The property that references resource is set to null.