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

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

All Implemented Interfaces:

GPTool

public class ClustersOutliersRendered
extends AbstractGPTool

Given a set of weighted features, identifies hot spots, cold spots, and spatial outliers using the Anselin Local Moran's I statistic. It then applies cold-to-hot rendering to the z-score results. The Cluster/Outlier Analysis with Rendering tool is contained in the Spatial Statistics Tools tool box.

Usage tips:

• The Cluster/Outlier Analysis with Rendering tool combines the and tools in a model. The Output Layer File is automatically added to the TOC with hot/cold rendering applied to feature z-scores.
• Begining with ArcGIS 9.3, output from the is automatically added to the TOC with default rendering applied to thefield, showing statistically significant hot spots, cold spots and spatial outliers.

Field Summary

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

vals

Constructor Summary

ClustersOutliersRendered()
Creates the Cluster/Outlier Analysis with Rendering tool with defaults.

ClustersOutliersRendered(Object inputFeatureClass, Object inputField, Object outputLayerFile, Object outputFeatureClass)
Creates the Cluster/Outlier Analysis with Rendering tool with the required parameters.

Method Summary

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	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

ClustersOutliersRendered

public ClustersOutliersRendered()

Creates the Cluster/Outlier Analysis with Rendering tool with defaults.

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

ClustersOutliersRendered

public ClustersOutliersRendered(Object inputFeatureClass,
                                Object inputField,
                                Object outputLayerFile,
                                Object outputFeatureClass)

Creates the Cluster/Outlier 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 cluster analysis will be performed.

inputField - the field to be evaluated.

outputLayerFile - the output layer file to store rendering information.

outputFeatureClass - the output feature class to receive the results field, z-score, p-value, and cluster type designation.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

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

Parameters:

inputFeatureClass - the feature class for which cluster analysis will be performed.

getInputField

public Object getInputField()

Returns the Input Field parameter of this tool . This parameter is the field 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 field to be evaluated. This is a required parameter.

Parameters:

inputField - the field to be evaluated.

getOutputLayerFile

public Object getOutputLayerFile()

Returns the Output Layer File parameter of this tool . This parameter is the output layer file to store rendering information. 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 output layer file to store rendering information. This is a required parameter.

Parameters:

outputLayerFile - the output layer file to store rendering information.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class to receive the results field, z-score, p-value, and cluster type designation. 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 field, z-score, p-value, and cluster type designation. This is a required parameter.

Parameters:

outputFeatureClass - the output feature class to receive the results field, z-score, p-value, and cluster type designation.

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