com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class HotSpots

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
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.
 
Method Summary
 String getConceptualizationOfSpatialRelationships()
          Returns the Conceptualization of Spatial Relationships parameter of this tool .
 double getDistanceBandOrThresholdDistance()
          Returns the Distance Band or Threshold Distance parameter of this tool .
 String getDistanceMethod()
          Returns the Distance Method parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 Object getInputField()
          Returns the Input Field parameter of this tool .
 Object getOutputFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 Object getProbabilityField()
          Returns the Probability Field parameter of this tool (Read only).
 Object getResultsField()
          Returns the Results Field parameter of this tool (Read only).
 Object getSelfPotentialField()
          Returns the Self Potential Field parameter of this tool .
 String getStandardization()
          Returns the Standardization parameter of this tool .
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 Object getWeightsMatrixFile()
          Returns the Weights Matrix File parameter of this tool .
 void setConceptualizationOfSpatialRelationships(String conceptualizationOfSpatialRelationships)
          Sets the Conceptualization of Spatial Relationships parameter of this tool .
 void setDistanceBandOrThresholdDistance(double distanceBandOrThresholdDistance)
          Sets the Distance Band or Threshold Distance parameter of this tool .
 void setDistanceMethod(String distanceMethod)
          Sets the Distance Method parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setInputField(Object inputField)
          Sets the Input Field parameter of this tool .
 void setOutputFeatureClass(Object outputFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setSelfPotentialField(Object selfPotentialField)
          Sets the Self Potential Field parameter of this tool .
 void setStandardization(String standardization)
          Sets the Standardization parameter of this tool .
 void setWeightsMatrixFile(Object weightsMatrixFile)
          Sets the Weights Matrix File parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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.
Method Detail

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