Find Hot Spots

pointLayer

(Required)

The point feature layer for which hot spots will be calculated.

Syntax: As described in Feature input, this parameter 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

REST web example:

• {"url" : "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}

REST scripting example:

• "pointLayer" : {"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}

Analysis using bins requires a projected coordinate system. When aggregating layers into bins, the input layer or processing extent (processSR) must have a projected coordinate system. At 10.5.1, 10.6, and 10.6.1, if a projected coordinate system is not specified when running analysis, the World Cylindrical Equal Area (WKID 54034) projection will be used. At 10.7 or later, if a projected coordinate system is not specified when running analysis, a projection will be picked based on the extent of the data.

binSize

(Required)

The distance for the square bins the pointLayer will be aggregated into.

REST web example: 108.3

REST scripting example: "binSize" : 100

binSizeUnit

(Required)

The distance unit for the bins with which hot spots will be calculated. The linear unit to be used with the value specified in binSize. The default is Meters. When generating bins the number and units specified determine the height and length of the square.

Values: Meters | Kilometers | Feet | Miles | NauticalMiles | Yards

REST web example: Meters

REST scripting example: "binSizeUnit" : "Miles"

neighborhoodDistance

(Required)

The size of the neighborhood within which to calculate the hot spots. The radius size must be larger than binSize.

REST web example: 150.5

REST scripting example: "neighborhood" : 100

neighborhoodDistanceUnit

(Required)

The distance unit for the radius defining the neighborhood where the hot spots will be calculated. The linear unit to be used with the value specified in binSize. The default is Meters.

Values: Meters | Kilometers | Feet | Miles | NauticalMiles | Yards

REST web example: Miles

REST scripting example: "neighborhoodUnit" : "Miles"

timeStepInterval

A numeric value that specifies duration of the time step interval. The default is none. This option is only available if the input points are time-enabled and represent an instant in time.

REST web example: 20

REST scripting example: "timeStepInterval" : 20

timeStepIntervalUnit

A string that specifies units of the time step interval. The default is none. This option is only available if the input points are time-enabled and represent an instant in time.

Values: Milliseconds | Seconds | Minutes | Hours | Days | Weeks| Months | Years

REST web example: Minutes

REST scripting example: "timeStepIntervalUnit" : "Minutes"

timeStepAlignment

Defines how aggregation will occur based on a given timeStepInterval. Options are as follows:

• StartTime—Time is aligned to the first feature in time.
• EndTime—Time is aligned to the last feature in time.
• ReferenceTime—Time is aligned a specified time in timeStepReference.

REST web example:StartTime

REST scripting example:"timeStepAlignment" : "StartTime"

timeStepReference

(Required if timeStepAlignment is ReferenceTime )

A date that specifies the reference time to align the time slices to, represented in milliseconds from epoch. The default is January 1, 1970, at 12:00 a.m. (epoch time stamp 0). This option is only available if the input points are time-enabled and of time type instant.

REST web example: 946684800000

REST scripting example: "timeStepReference" : 946684800000

outputName

(Required)

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

REST web example: myOutput

REST scripting example: "outputName" : "myOutput"

context

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.

{
"extent" : {extent},
"processSR" : {spatial reference},
"outSR" : {spatial reference},
"dataStore":{data store}
}

f

The response format. The default response format is html.

Values: html | json

output

The result of Find Hot Spots is a feature layer that provides information about statistically significant hot and cold features. The output is always polygons of the bin size specified at tool run.

The result layer has the following attributes:

• An ID field (FID)—An integer field with a unique value for every feature.
• Join_Count—An integer field is created with values reflecting the number of points in each aggregation bin.
• Hot/Cold Intensity—A numeric (double) field with standard deviations representing the intensity of spatial clustering.
• Confidence Bin—Symbolizes the results. Values range from -3 to +3 and reflect statistical significance. Use blue to draw values less than zero and red to draw values greater than zero. Use the darkest blue for features equal to -3, medium blue for -2, and light blue for -1. Use the darkest red for features equal to 3, medium red for 2, and the lightest red or pink for 1. A confidence bin value of zero means no statistically significant clustering, and these features should be drawn in white or beige (the color selected should be neutral).

{"url": 
"http://<analysis url>/FindHotSpots/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.

{
"paramName":"output", 
"dataType":"GPRecordSet",
"value":{"url":"<hosted featureservice layer url>"}
}

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