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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.HighLowClustering
All Implemented Interfaces:
GPTool

public class HighLowClustering
extends AbstractGPTool

Measures the degree of clustering for either high values or low values The High/Low Clustering (Getis-Ord General G) tool is contained in the Spatial Statistics Tools tool box.
Learn more about how High/Low Clustering: Getis-Ord General G works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
HighLowClustering()
          Creates the High/Low Clustering (Getis-Ord General G) tool with defaults.
HighLowClustering(Object inputFeatureClass, Object inputField, String conceptualizationOfSpatialRelationships, String distanceMethod, String standardization)
          Creates the High/Low Clustering (Getis-Ord General G) tool with the required parameters.
 
Method Summary
 String getConceptualizationOfSpatialRelationships()
          Returns the Conceptualization of Spatial Relationships parameter of this tool .
 String getDisplayOutputGraphically()
          Returns the Display Output Graphically 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 .
 double getObservedGeneralG()
          Returns the Observed General G parameter of this tool (Read only).
 double getPValue()
          Returns the PValue parameter of this tool (Read only).
 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 .
 double getZScore()
          Returns the ZScore parameter of this tool (Read only).
 void setConceptualizationOfSpatialRelationships(String conceptualizationOfSpatialRelationships)
          Sets the Conceptualization of Spatial Relationships parameter of this tool .
 void setDisplayOutputGraphically(String displayOutputGraphically)
          Sets the Display Output Graphically 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 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

HighLowClustering

public HighLowClustering()
Creates the High/Low Clustering (Getis-Ord General G) tool with defaults.

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


HighLowClustering

public HighLowClustering(Object inputFeatureClass,
                         Object inputField,
                         String conceptualizationOfSpatialRelationships,
                         String distanceMethod,
                         String standardization)
Creates the High/Low Clustering (Getis-Ord General G) 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 the General G statistic will be calculated.
inputField - Field, the numeric field used for analysis (incidents or weights).
conceptualizationOfSpatialRelationships - String, specifies how spatial relationships among features are conceptualized.
distanceMethod - String, specifies how feature to feature distance are calculated.
standardization - String, row standardization is recommended whenever the distribution of your features is potentially biased due to sampling design or an imposed aggregation scheme.
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 the General G statistic will be calculated. 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 the General G statistic will be calculated. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, the feature class for which the General G statistic will be calculated.

getInputField

public Object getInputField()
Returns the Input Field parameter of this tool . This parameter is Field, the numeric field used for analysis (incidents or weights). 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 field used for analysis (incidents or weights). This is a required parameter.

Parameters:
inputField - Field, the numeric field used for analysis (incidents or weights).

getDisplayOutputGraphically

public String getDisplayOutputGraphically()
Returns the Display Output Graphically parameter of this tool . This parameter is String, specifies whether the tool will display General G results graphically. This is an optional parameter.

Returns:
the Display Output Graphically

setDisplayOutputGraphically

public void setDisplayOutputGraphically(String displayOutputGraphically)
Sets the Display Output Graphically parameter of this tool . This parameter is String, specifies whether the tool will display General G results graphically. This is an optional parameter.

Parameters:
displayOutputGraphically - String, specifies whether the tool will display General G results graphically.

getConceptualizationOfSpatialRelationships

public String getConceptualizationOfSpatialRelationships()
Returns the Conceptualization of Spatial Relationships parameter of this tool . This parameter is String, specifies how spatial relationships among features are conceptualized. 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, specifies how spatial relationships among features are conceptualized. This is a required parameter.

Parameters:
conceptualizationOfSpatialRelationships - String, specifies how spatial relationships among features are conceptualized.

getDistanceMethod

public String getDistanceMethod()
Returns the Distance Method parameter of this tool . This parameter is String, specifies how feature to feature distance are calculated. 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 feature to feature distance are calculated. This is a required parameter.

Parameters:
distanceMethod - String, specifies how feature to feature distance are calculated.

getStandardization

public String getStandardization()
Returns the Standardization parameter of this tool . This parameter is String, row standardization is recommended whenever the distribution of your features is potentially biased due to sampling design or an imposed aggregation scheme. 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, row standardization is recommended whenever the distribution of your features is potentially biased due to sampling design or an imposed aggregation scheme. This is a required parameter.

Parameters:
standardization - String, row standardization is recommended whenever the distribution of your features is potentially biased due to sampling design or an imposed aggregation scheme.

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 be in units that 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 be in units that 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 be in units that 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.

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 among features in the Input Feature Class. 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 among features in the Input Feature Class. This is an optional parameter.

Parameters:
weightsMatrixFile - File, the pathname to a file containing spatial weights that define spatial relationships among features in the Input Feature Class.

getObservedGeneralG

public double getObservedGeneralG()
Returns the Observed General G parameter of this tool (Read only). This is an derived parameter.

Returns:
the Observed General G

getZScore

public double getZScore()
Returns the ZScore parameter of this tool (Read only). This is an derived parameter.

Returns:
the ZScore

getPValue

public double getPValue()
Returns the PValue parameter of this tool (Read only). This is an derived parameter.

Returns:
the PValue

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