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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.HotSpotsRendered

All Implemented Interfaces:

GPTool

public class HotSpotsRendered

extends AbstractGPTool

Calculates Gi* statistics and applies a cold-to-hot type of rendering to the output z scores. The Hot Spot Analysis with Rendering tool is contained in the Spatial Statistics Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The Gi* rendered model combines the functions Hot Spot Analysis; and Z Score Rendering;
• This tool is appropriate for rendering output from the Collect Events; tool.
• Current map layers may be used to define the input feature class. When using layers, only the currently selected features are used in the Getis-Ord Gi* operation.
• This tool will only work on the windows operating system. If you are not using windows, please run the Hot Spot Analysis; tool by itself.
• Learn more about working with layers and table views;
• The following environment settings affect this tool: Cluster Tolerance; Extent; M Domain; Configuration Keyword; Coordinate System; Output has M Values; Output Spatial Grid; Output has Z Values; Default Z Value; Output XY Domain; , and Output Z Domain;

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

HotSpotsRendered()
Creates the Hot Spot Analysis with Rendering tool with defaults.

HotSpotsRendered(java.lang.Object inputFeatureClass, java.lang.Object inputField, java.lang.Object outputLayerFile, java.lang.Object outputFeatureClass, double distanceBandOrThresholdDistance)
Creates the Hot Spot Analysis with Rendering tool with the required parameters.

Method Summary

double	getDistanceBandOrThresholdDistance() Returns the Distance Band or Threshold Distance parameter of this tool .
java.lang.Object	getInputFeatureClass() Returns the Input Feature Class parameter of this tool .
java.lang.Object	getInputField() Returns the Input Field parameter of this tool .
java.lang.Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool .
java.lang.Object	getOutputLayerFile() Returns the Output Layer File parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setDistanceBandOrThresholdDistance(double distanceBandOrThresholdDistance) Sets the Distance Band or Threshold Distance parameter of this tool .
void	setInputFeatureClass(java.lang.Object inputFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInputField(java.lang.Object inputField) Sets the Input Field parameter of this tool .
void	setOutputFeatureClass(java.lang.Object outputFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutputLayerFile(java.lang.Object outputLayerFile) Sets the Output Layer 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

HotSpotsRendered

public HotSpotsRendered()

Creates the Hot Spot Analysis with Rendering tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

HotSpotsRendered

public HotSpotsRendered(java.lang.Object inputFeatureClass,
                        java.lang.Object inputField,
                        java.lang.Object outputLayerFile,
                        java.lang.Object outputFeatureClass,
                        double distanceBandOrThresholdDistance)

Creates the Hot Spot Analysis with Rendering 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.

outputLayerFile - Layer File, the layer file to store the cold-to-hot rendering information. You must include the .lyr extension as part of the file name.

outputFeatureClass - Feature Class, the output feature class to receive the results field and Gi z score.

distanceBandOrThresholdDistance - Double, specifies a distance cutoff value. Features outside the specified Distance Band or Threshold Distance are ignored in the hot spot analysis. The value entered for this parameter should be in the units of the Input Feature Class' coordinate system. There is one exception. If the Output Coordinate System environment variable is set, the value entered for this parameter should be in the units of the coordinate system set in that environment. A value of zero indicates that no threshold distance is applied. This is only valid with the "Inverse Distance" and "Inverse Distance Squared" spatial conceptualizations. This parameter has no effect when "Polygon Contiguity" and "Get Spatial Weights From File" spatial conceptualizations are selected.

Method Detail

getInputFeatureClass

public java.lang.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(java.lang.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 java.lang.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(java.lang.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.

getOutputLayerFile

public java.lang.Object getOutputLayerFile()

Returns the Output Layer File parameter of this tool . This parameter is Layer File, the layer file to store the cold-to-hot rendering information. You must include the .lyr extension as part of the file name. This is a required parameter.

Returns:

the Output Layer File

setOutputLayerFile

public void setOutputLayerFile(java.lang.Object outputLayerFile)

Sets the Output Layer File parameter of this tool . This parameter is Layer File, the layer file to store the cold-to-hot rendering information. You must include the .lyr extension as part of the file name. This is a required parameter.

Parameters:

outputLayerFile - Layer File, the layer file to store the cold-to-hot rendering information. You must include the .lyr extension as part of the file name.

getOutputFeatureClass

public java.lang.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(java.lang.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.

getDistanceBandOrThresholdDistance

public double getDistanceBandOrThresholdDistance()

Returns the Distance Band or Threshold Distance parameter of this tool . This parameter is Double, specifies a distance cutoff value. Features outside the specified Distance Band or Threshold Distance are ignored in the hot spot analysis. The value entered for this parameter should be in the units of the Input Feature Class' coordinate system. There is one exception. If the Output Coordinate System environment variable is set, the value entered for this parameter should be in the units of the coordinate system set in that environment. A value of zero indicates that no threshold distance is applied. This is only valid with the "Inverse Distance" and "Inverse Distance Squared" spatial conceptualizations. This parameter has no effect when "Polygon Contiguity" and "Get Spatial Weights From File" spatial conceptualizations are selected. This is a required 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 distance cutoff value. Features outside the specified Distance Band or Threshold Distance are ignored in the hot spot analysis. The value entered for this parameter should be in the units of the Input Feature Class' coordinate system. There is one exception. If the Output Coordinate System environment variable is set, the value entered for this parameter should be in the units of the coordinate system set in that environment. A value of zero indicates that no threshold distance is applied. This is only valid with the "Inverse Distance" and "Inverse Distance Squared" spatial conceptualizations. This parameter has no effect when "Polygon Contiguity" and "Get Spatial Weights From File" spatial conceptualizations are selected. This is a required parameter.

Parameters:

distanceBandOrThresholdDistance - Double, specifies a distance cutoff value. Features outside the specified Distance Band or Threshold Distance are ignored in the hot spot analysis. The value entered for this parameter should be in the units of the Input Feature Class' coordinate system. There is one exception. If the Output Coordinate System environment variable is set, the value entered for this parameter should be in the units of the coordinate system set in that environment. A value of zero indicates that no threshold distance is applied. This is only valid with the "Inverse Distance" and "Inverse Distance Squared" spatial conceptualizations. This parameter has no effect when "Polygon Contiguity" and "Get Spatial Weights From File" spatial conceptualizations are selected.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias