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 the Getis-Ord Gi* statistic for hot spot analysis and then 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.

Usage tips:

• The Gi* rendered model combines the and tools.
• Beginning with the ArcGIS 9.3 release, output from the tool is automatically added to the TOC with default hot/cold rendering applied to the z-score field.

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(Object inputFeatureClass, Object inputField, Object outputLayerFile, Object outputFeatureClass)
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 .
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	getOutputLayerFile() Returns the Output Layer File 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.
void	setDistanceBandOrThresholdDistance(double distanceBandOrThresholdDistance) Sets the Distance Band or Threshold Distance 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	setOutputLayerFile(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(Object inputFeatureClass,
                        Object inputField,
                        Object outputLayerFile,
                        Object outputFeatureClass)

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 - the feature class for which hot spot analysis will be performed.

inputField - the numeric field (number of victims, jobs, incident severity, and so on) to be evaluated.

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

outputFeatureClass - the output feature class to receive the results fields.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is 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 the feature class for which hot spot analysis will be performed. This is a required parameter.

Parameters:

inputFeatureClass - 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 the numeric field (number of victims, jobs, incident severity, 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 the numeric field (number of victims, jobs, incident severity, and so on) to be evaluated. This is a required parameter.

Parameters:

inputField - the numeric field (number of victims, jobs, incident severity, and so on) to be evaluated.

getOutputLayerFile

public Object getOutputLayerFile()

Returns the Output Layer File parameter of this tool . This parameter is 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(Object outputLayerFile)

Sets the Output Layer File parameter of this tool . This parameter is 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 - 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 Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class to receive the results fields. 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 the output feature class to receive the results fields. This is a required parameter.

Parameters:

outputFeatureClass - the output feature class to receive the results fields.

getDistanceBandOrThresholdDistance

public double getDistanceBandOrThresholdDistance()

Returns the Distance Band or Threshold Distance parameter of this tool . This parameter is 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. When this field is left blank, a default distance value will be computed and applied. 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 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. When this field is left blank, a default distance value will be computed and applied. This is an optional parameter.

Parameters:

distanceBandOrThresholdDistance - 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. When this field is left blank, a default distance value will be computed and applied.

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