com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class HotSpots
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.HotSpots
- All Implemented Interfaces:
- GPTool
public class HotSpots
- extends AbstractGPTool
Calculates the Getis-Ord Gi* statistic for hot spot analysis.
The Hot Spot Analysis (Getis-Ord Gi*) tool is contained in the Spatial Statistics Tools tool box.
Learn more about how Hot Spot Analysis: Getis-Ord Gi* works
Software restrictions: none
Illustration:
Usage tips:
- This tool honors the environment output coordinate system; . Feature geometry; is projected to the output coordinate system prior to analysis, so values entered for the Distance Band/Threshold Distance parameter should match those specified in the output coordinate system. All mathematical computations are based on the output coordinate system spatial reference;
- Calculations based on either Euclidean or Manhattan distance require projected data; to accurately measure distances.
- If you will be running several analyses on a single dataset (e.g., analyzing several different fields) or if you have a dataset with more than 3000 features, it is recommended that you construct the spatial weights matrix file; prior to analysis.
- Given a set of weighted features, the Getis-Ord Gi* statistic identifies spatial clusters of high values (hot spots) and spatial clusters of low values (cold spots).
- This tool creates as derived output the Z score and p-value fieldnames.
- The output from the Hot Spot Analysis tool is a Z score and p-value for each feature. These values represent the statistical significance of the spatial clustering of values, given the conceptualization of spatial relationships and the scale of analysis (distance parameter).
- A high Z score and small p-value (probability) for a feature indicates a spatial clustering of high values. A low negative Z score and small p-value indicates a spatial clustering of low values. The higher (or lower) the Z score, the more intense the clustering. A Z score near zero indicates no apparent spatial clustering.
- The Z score is based on the Randomization Null Hypothesis computation. For more information on Z scores, see What is a Z score? What is a p-value?;
- The input field should contain a variety of values. The math for this statistic requires some variation in the variable being analyzed; it cannot solve if all input values are 1, for example. If you have incident data, and want to analyze incident intensity, consider aggregating your incident data or using the Collect Events; tool prior to analysis.
- Whenever using shapefiles keep in mind that they cannot store null values. Tools or other procedures that create shapefiles from non-shapefile inputs may store or interpret null values as zero. This can lead to unexpected results.
- The Conceptualization of Spatial Relationships used for analysis should be based on your understanding of spatial interaction among the features being analyzed. For this tool the fixed distance or contiguity spatial conceptualization methods are generally more appropriate than the inverse distance conceptualization methods.
- For the Fixed Distance option, the distance band used for analysis should be based on your understanding of spatial interaction among the features being analyzed. Alternatively, features may be evaluated for a range of distance values or at the specific distance; where spatial autocorrelation is maximized.
- Use a Conceptualization of Spatial Relationships and/or Distance Band value that will ensure every feature has at LEAST one neighbor. Especially if the input data is skewed (does not create a nice bell curve when you plot the values as a histogram), you want to make sure that the number of neighbors is neither too small (most features have only one or two neighbors) nor too large (several features include all other features as neighbors), because that would make resultant Z scores less reliable. The Z scores are reliable (even with skewed data) as long as each feature is associated with several neighbors (approximately 8, as a rule of thumb). This tool can be applied to skewed data because it is "asymptotically normal".
- For Inverse Distance conceptualization options: when zero is entered for the "Distance Band or Threshold Distance" parameter all features are considered neighbors of all other features; when this parameter is left blank, a default threshold distance will be applied.
- When the spatial conceptualization is an Inverse Distance method (Inverse Distance, Inverse Distance Squared, or Zone of Indifference) any two points that are coincident will be given a weight of one to avoid zero division. This assures features are not excluded from analysis.
- With inverse distance conceptualizations, weights for distances less than 1 become unstable. The weighting for features separated by less than 1 unit of distance (common with Geographic Coordinate System; projections), are given a weight of 1.
- Analysis on features with a Geographic Coordinate System projection is not recommended with the inverse distance spatial conceptualization methods.
- This tool computes the Gi* statistic where each feature is its own neighbor; however, if you specify a Self Potential field in which all values are zero, the tool performs the Gi statistic (local calculations for a feature exclude the feature's own value).
- In ArcGIS version 9.2, the "Global" standardization option was removed. Global standardization returns the same results as no standardization. Models built with previous versions of ArcGIS that use the Global standardization option may need to be rebuilt.
- See the Modeling Spatial Relationships; help page for further explanation of this tool's parameters.
- Current map layers may be used to define the input feature class. When using layers, only the currently selected features are included in the analysis.
- Learn more about working with layers and table views;
- When this tool runs in ArcMap, the output feature class is automatically added to the Table of Contents (TOC) with default rendering applied to the Z Score field. The hot to cold rendering applied is defined by a layer file in /ArcToolbox/Templates/Layers. You can reapply the default rendering, if needed, by importing; the template layer symbology.
|
Constructor Summary |
HotSpots()
Creates the Hot Spot Analysis (Getis-Ord Gi*) tool with defaults. |
HotSpots(Object inputFeatureClass,
Object inputField,
Object outputFeatureClass,
String conceptualizationOfSpatialRelationships,
String distanceMethod,
String standardization)
Creates the Hot Spot Analysis (Getis-Ord Gi*) tool with the required parameters. |
HotSpots
public HotSpots()
- Creates the Hot Spot Analysis (Getis-Ord Gi*) tool with defaults.
Initializes the array of tool parameters with the default values specified when the tool was created.
HotSpots
public HotSpots(Object inputFeatureClass,
Object inputField,
Object outputFeatureClass,
String conceptualizationOfSpatialRelationships,
String distanceMethod,
String standardization)
- Creates the Hot Spot Analysis (Getis-Ord Gi*) tool with the required parameters.
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
- Parameters:
inputFeatureClass - Feature Layer, the feature class for which hot spot analysis will be performed.inputField - Field, the numeric count field (number of victims, crimes, jobs, and so on) to be evaluated.outputFeatureClass - Feature Class, the output feature class to receive the Results field and Gi z score.conceptualizationOfSpatialRelationships - String, polygon contiguity is only available with an ArcInfo license.distanceMethod - String, specifies how distances are calculated when measuring concentrations.standardization - String, the standardization of spatial weights provides more accurate results.
getInputFeatureClass
public Object getInputFeatureClass()
- Returns the Input Feature Class parameter of this tool .
This parameter is Feature Layer, the feature class for which hot spot analysis will be performed.
This is a required parameter.
- Returns:
- the Input Feature Class
setInputFeatureClass
public void setInputFeatureClass(Object inputFeatureClass)
- Sets the Input Feature Class parameter of this tool .
This parameter is Feature Layer, the feature class for which hot spot analysis will be performed.
This is a required parameter.
- Parameters:
inputFeatureClass - Feature Layer, the feature class for which hot spot analysis will be performed.
getInputField
public Object getInputField()
- Returns the Input Field parameter of this tool .
This parameter is Field, the numeric count field (number of victims, crimes, jobs, and so on) to be evaluated.
This is a required parameter.
- Returns:
- the Input Field
setInputField
public void setInputField(Object inputField)
- Sets the Input Field parameter of this tool .
This parameter is Field, the numeric count field (number of victims, crimes, jobs, and so on) to be evaluated.
This is a required parameter.
- Parameters:
inputField - Field, the numeric count field (number of victims, crimes, jobs, and so on) to be evaluated.
getOutputFeatureClass
public Object getOutputFeatureClass()
- Returns the Output Feature Class parameter of this tool .
This parameter is Feature Class, the output feature class to receive the Results field and Gi z score.
This is a required parameter.
- Returns:
- the Output Feature Class
setOutputFeatureClass
public void setOutputFeatureClass(Object outputFeatureClass)
- Sets the Output Feature Class parameter of this tool .
This parameter is Feature Class, the output feature class to receive the Results field and Gi z score.
This is a required parameter.
- Parameters:
outputFeatureClass - Feature Class, the output feature class to receive the Results field and Gi z score.
getConceptualizationOfSpatialRelationships
public String getConceptualizationOfSpatialRelationships()
- Returns the Conceptualization of Spatial Relationships parameter of this tool .
This parameter is String, polygon contiguity is only available with an ArcInfo license.
This is a required parameter.
- Returns:
- the Conceptualization of Spatial Relationships
setConceptualizationOfSpatialRelationships
public void setConceptualizationOfSpatialRelationships(String conceptualizationOfSpatialRelationships)
- Sets the Conceptualization of Spatial Relationships parameter of this tool .
This parameter is String, polygon contiguity is only available with an ArcInfo license.
This is a required parameter.
- Parameters:
conceptualizationOfSpatialRelationships - String, polygon contiguity is only available with an ArcInfo license.
getDistanceMethod
public String getDistanceMethod()
- Returns the Distance Method parameter of this tool .
This parameter is String, specifies how distances are calculated when measuring concentrations.
This is a required parameter.
- Returns:
- the Distance Method
setDistanceMethod
public void setDistanceMethod(String distanceMethod)
- Sets the Distance Method parameter of this tool .
This parameter is String, specifies how distances are calculated when measuring concentrations.
This is a required parameter.
- Parameters:
distanceMethod - String, specifies how distances are calculated when measuring concentrations.
getStandardization
public String getStandardization()
- Returns the Standardization parameter of this tool .
This parameter is String, the standardization of spatial weights provides more accurate results.
This is a required parameter.
- Returns:
- the Standardization
setStandardization
public void setStandardization(String standardization)
- Sets the Standardization parameter of this tool .
This parameter is String, the standardization of spatial weights provides more accurate results.
This is a required parameter.
- Parameters:
standardization - String, the standardization of spatial weights provides more accurate results.
getDistanceBandOrThresholdDistance
public double getDistanceBandOrThresholdDistance()
- Returns the Distance Band or Threshold Distance parameter of this tool .
This parameter is Double, specifies a cutoff distance for Inverse Distance and Fixed Distance options. Features outside the specified cutoff for a target feature are ignored in analyses for that feature. However, for Zone of Indifference, the influence of features outside the given distance is reduced with distance while those inside the distance threshold are equally considered. The value entered should match those of the Output Coordinate System.
For the Inverse Distance conceptualizations of spatial relationships: A value of zero for this parameter indicates that no threshold distance is applied; when this parameter is left blank, a default threshold value will be computed and applied.
This parameter has no effect when "Polygon Contiguity" or "Get Spatial Weights From File" spatial conceptualizations are selected.
This is an optional parameter.
- Returns:
- the Distance Band or Threshold Distance
setDistanceBandOrThresholdDistance
public void setDistanceBandOrThresholdDistance(double distanceBandOrThresholdDistance)
- Sets the Distance Band or Threshold Distance parameter of this tool .
This parameter is Double, specifies a cutoff distance for Inverse Distance and Fixed Distance options. Features outside the specified cutoff for a target feature are ignored in analyses for that feature. However, for Zone of Indifference, the influence of features outside the given distance is reduced with distance while those inside the distance threshold are equally considered. The value entered should match those of the Output Coordinate System.
For the Inverse Distance conceptualizations of spatial relationships: A value of zero for this parameter indicates that no threshold distance is applied; when this parameter is left blank, a default threshold value will be computed and applied.
This parameter has no effect when "Polygon Contiguity" or "Get Spatial Weights From File" spatial conceptualizations are selected.
This is an optional parameter.
- Parameters:
distanceBandOrThresholdDistance - Double, specifies a cutoff distance for Inverse Distance and Fixed Distance options. Features outside the specified cutoff for a target feature are ignored in analyses for that feature. However, for Zone of Indifference, the influence of features outside the given distance is reduced with distance while those inside the distance threshold are equally considered. The value entered should match those of the Output Coordinate System.
For the Inverse Distance conceptualizations of spatial relationships: A value of zero for this parameter indicates that no threshold distance is applied; when this parameter is left blank, a default threshold value will be computed and applied.
This parameter has no effect when "Polygon Contiguity" or "Get Spatial Weights From File" spatial conceptualizations are selected.
getSelfPotentialField
public Object getSelfPotentialField()
- Returns the Self Potential Field parameter of this tool .
This parameter is Field, the field representing self-potential: The distance or weight between a feature and itself.
This is an optional parameter.
- Returns:
- the Self Potential Field
setSelfPotentialField
public void setSelfPotentialField(Object selfPotentialField)
- Sets the Self Potential Field parameter of this tool .
This parameter is Field, the field representing self-potential: The distance or weight between a feature and itself.
This is an optional parameter.
- Parameters:
selfPotentialField - Field, the field representing self-potential: The distance or weight between a feature and itself.
getWeightsMatrixFile
public Object getWeightsMatrixFile()
- Returns the Weights Matrix File parameter of this tool .
This parameter is File, the pathname to a file containing spatial weights that define spatial relationships between features.
This is an optional parameter.
- Returns:
- the Weights Matrix File
setWeightsMatrixFile
public void setWeightsMatrixFile(Object weightsMatrixFile)
- Sets the Weights Matrix File parameter of this tool .
This parameter is File, the pathname to a file containing spatial weights that define spatial relationships between features.
This is an optional parameter.
- Parameters:
weightsMatrixFile - File, the pathname to a file containing spatial weights that define spatial relationships between features.
getResultsField
public Object getResultsField()
- Returns the Results Field parameter of this tool (Read only).
This is an derived parameter.
- Returns:
- the Results Field
getProbabilityField
public Object getProbabilityField()
- Returns the Probability Field parameter of this tool (Read only).
This is an derived parameter.
- Returns:
- the Probability Field
getToolName
public String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias
