Build Multi-Variable Grid

binType (Required)

The type of bin that will be used to generate the result grid. The default is Square.

Analysis using Square or Hexagon bins requires a projected coordinate system. When aggregating layers into bins, the input layer or processing extent (processSR ) must have a projected coordinate system. If a projected coordinate system is not specified when running analysis, a projection will be picked based on the extent of the data.

Values: Hexagon | Square

REST examples

1
2
3
4
5
//REST web example
Hexagon

//REST scripting example
"binType": "Hexagon"

binSize (Required)

The distance for the bins of type binType in the output polygon layer. variableCalculations will be calculated at the center of each bin. When generating Square bins, the number and units specified determine the height and length of the square. For Hexagon bins, the number and units specified determine the distance between parallel sides.

REST examples

1
2
3
4
5
//REST web example
108.3

//REST scripting example
"binSize": 100

binSizeUnit (Required)

The distance unit for the bins will be used to calculate variableCalculations.

Values: Meters | Kilometers | Feet | FeetInt | FeetUS | Miles |MilesInt | MilesUS | NauticalMiles | NauticalMilesInt | NauticalMilesUS | Yards | YardsInt | YardsUS

REST examples

1
2
3
4
5
//REST web example
Meters

//REST scripting example
"binSizeUnit": "Miles"

inputLayers (Required)

A list of input layers that will be used in analysis. Each input layer follows the same formatting as described in the Feature Input topic. This can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features

• A URL to a big data catalog service layer with an optional filter to select specific features

• A feature collection

In the REST web example for inputLayers below, two layers are being used in analysis. The layer at index 0 will be filtered to only use features where OID is greater than 2.

REST web example

1
2
3
4
5
6
7
8
[
  {
     "url":"https://organization.example.com/<context>/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter":"OID > 2"
  },
  {
     "url":"https://organization.example.com/<context>/rest/services/Hosted/weatherPoints/FeatureServer/0"
  }
]

variableCalculations (Required)

A JSON array containing objects that describe the variables that will be calculated for each layer in inputLayers.

outputName (Required)

The task will create a feature service of the results. You define the name of the service.

REST examples

1
2
3
4
5
//REST web example
myOutput

//REST scripting example
"outputName": "myOutput"

context (Optional)

The context parameter contains additional settings that affect task execution. For this task, there are four settings:

• Extent (extent )—A bounding box that defines the analysis area. Only those features that intersect the bounding box will be analyzed.
• Processing spatial reference (processSR )—The features will be projected into this coordinate system for analysis.
• Output spatial reference (outSR )—The features will be projected into this coordinate system after the analysis to be saved. The output spatial reference for the spatiotemporal big data store is always WGS84.
• Data store (dataStore )—Results will be saved to the specified data store. The default is the spatiotemporal big data store.

Syntax:

1
2
3
4
5
6
{
  "extent": {extent},
  "processSR": {spatial reference},
  "outSR": {spatial reference},
  "dataStore": {data store}
}

f

The response format. The default response format is html .

Values: html | json | pjson

outFieldName

The name of the field that will be created in the result layer to store a variable.

searchDistance

Defines the maximum distance that the tool will search from the center of each bin to find a feature in the layer for DistanceToNearest and AttributeOfNearest. If no feature is within the distance, null is returned. For AttributeOfSummaryRelated , searchDistance is optional and defines the radius of a circular neighborhood surrounding each bin. All features that intersect this neighborhood will be used to calculate statisticType. If a distance is not defined, only features that intersect a bin will be used to calculate statisticType.

searchDistanceUnit

Defines the maximum distance unit that the tool will search from the center of each bin to find a feature in the layer for DistanceToNearest and AttributeOfNearest. If no feature is within the distance, null is returned. For AttributeOfSummaryRelated , searchDistance is optional and defines the radius of a circular neighborhood surrounding each bin. All features that intersect this neighborhood will be used to calculate statisticType. If a distance is not defined, only features that intersect a bin will be used to calculate statisticType.

attributeField

The name of a field in the input layer. The value of this field in the closest feature to each bin will be included in the result layer. Required by AttributeOfNearest.

statisticField

The name of a field in the input layer. The field's values will be used to calculate statisticType. Required by AttributeSummaryOfRelated.

statisticType

Required by AttributeSummaryOfRelated. Can be defined as one of the following types:

• Count—For a numeric field, this totals the number of features near or intersecting each bin. For a string field, this totals the number of strings for all features near or intersecting each bin.
• Sum—Adds the total value of all features near or intersecting each bin. This is used for numeric fields.
• Mean—Calculates the average of all features near or intersecting each bin. This is used for numeric fields.
• Min—Finds the smallest value of all features near or intersecting each bin. This is used for numeric fields.
• Max—Finds the largest value of all features near or intersecting each bin. This is used for numeric fields.
• Range—Finds the difference between Min and Max. This is used for numeric fields.
• Stddev—Finds the standard deviation of all features near or intersecting each bin. This is used for numeric fields.
• Var—Finds the variance of all features near or intersecting each bin. This is used for numeric fields.
• Any—Returns a sample string of all features near or intersecting each bin. This is used for string fields.

filter

Optional for all variable types. This is formatted as described in the Feature Input topic.

output

The result output will always contain polygon features. The number of resulting polygons is based on binSize, variableCalculations, and the extent of the input data. The layer will only contain the variables specified in variableCalculations.

1
{"url": "https://<analysis-url>/BuildMultiVariableGrid/jobs/<jobId>/results/output"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request. The value contains the URL of the feature service layer.

1
2
3
4
5
{
  "paramName": "output",
  "dataType": "GPRecordSet",
  "value":{"url": "<hosted featureservice layer url>"}
}

See Feature output for more information about how the result layer is accessed.