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

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

All Implemented Interfaces:

GPTool

public class CentralFeature
extends AbstractGPTool

Identifies the most centrally located feature in a point, line, or polygon feature class. The Central Feature tool is contained in the Spatial Statistics Tools tool box.

Usage tips:

• The feature associated with the smallest accumulated distance to all other features in the dataset is the most centrally located feature; this feature is selected and copied to a newly created Output Feature Class.
• Calculations based on either Euclidean or Manhattan distance require to accurately measure distances.
• For line and polygon features, feature centroids are used in distance computations. For multipoints, polylines, or polygons with multiple parts, the centroid is computed using the weighted mean center of all feature parts. The weighting for point features is 1, for line features is length, and for polygon features is area.
• Map layers can be used to define the Input Feature Class. When using a layer with a selection, only the selected features are included in the analysis.
• The Case Field is used to group features for separate Central Feature computations. The Case Field can be of numeric, date, or string type.
• Self-potential is the distance or weight between a feature and itself. Often this weight is zero, but in some cases you may want to specify another fixed value or a different value for every feature (perhaps , for example).
• When using shapefiles, keep in mind that they cannot store null values. Tools or other procedures that create shapefiles from non-shapefile inputs may store or interpret null values as zero. This can lead to unexpected results. See also .

Field Summary

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

vals

Constructor Summary

CentralFeature()
Creates the Central Feature tool with defaults.

CentralFeature(Object inputFeatureClass, Object outputFeatureClass, String distanceMethod)
Creates the Central Feature tool with the required parameters.

Method Summary

Object	getCaseField() Returns the Case Field 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	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getSelfPotentialWeightField() Returns the Self Potential Weight Field 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	getWeightField() Returns the Weight Field parameter of this tool .
void	setCaseField(Object caseField) Sets the Case Field 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	setOutputFeatureClass(Object outputFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setSelfPotentialWeightField(Object selfPotentialWeightField) Sets the Self Potential Weight Field parameter of this tool .
void	setWeightField(Object weightField) Sets the Weight Field 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

CentralFeature

public CentralFeature()

Creates the Central Feature tool with defaults.

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

CentralFeature

public CentralFeature(Object inputFeatureClass,
                      Object outputFeatureClass,
                      String distanceMethod)

Creates the Central Feature 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 containing a distribution of features from which to identify the most centrally located feature.

outputFeatureClass - the feature class that will contain the most centrally located feature in the Input Feature Class.

distanceMethod - specifies how distances are calculated from each feature to neighboring features.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the feature class containing a distribution of features from which to identify the most centrally located feature. 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 containing a distribution of features from which to identify the most centrally located feature. This is a required parameter.

Parameters:

inputFeatureClass - the feature class containing a distribution of features from which to identify the most centrally located feature.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class that will contain the most centrally located feature in the Input Feature Class. 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 feature class that will contain the most centrally located feature in the Input Feature Class. This is a required parameter.

Parameters:

outputFeatureClass - the feature class that will contain the most centrally located feature in the Input Feature Class.

getDistanceMethod

public String getDistanceMethod()

Returns the Distance Method parameter of this tool . This parameter is specifies how distances are calculated from each feature to neighboring features. 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 specifies how distances are calculated from each feature to neighboring features. This is a required parameter.

Parameters:

distanceMethod - specifies how distances are calculated from each feature to neighboring features.

getWeightField

public Object getWeightField()

Returns the Weight Field parameter of this tool . This parameter is the numeric field used to weight distances in the origin-destination distance matrix. This is an optional parameter.

Returns:

the Weight Field

setWeightField

public void setWeightField(Object weightField)

Sets the Weight Field parameter of this tool . This parameter is the numeric field used to weight distances in the origin-destination distance matrix. This is an optional parameter.

Parameters:

weightField - the numeric field used to weight distances in the origin-destination distance matrix.

getSelfPotentialWeightField

public Object getSelfPotentialWeightField()

Returns the Self Potential Weight Field parameter of this tool . This parameter is the field representing self-potential—the distance or weight between a feature and itself. This is an optional parameter.

Returns:

the Self Potential Weight Field

setSelfPotentialWeightField

public void setSelfPotentialWeightField(Object selfPotentialWeightField)

Sets the Self Potential Weight Field parameter of this tool . This parameter is the field representing self-potential—the distance or weight between a feature and itself. This is an optional parameter.

Parameters:

selfPotentialWeightField - the field representing self-potential—the distance or weight between a feature and itself.

getCaseField

public Object getCaseField()

Returns the Case Field parameter of this tool . This parameter is field used to group features for separate central feature computations. The case field can be of numeric, date, or string type. This is an optional parameter.

Returns:

the Case Field

setCaseField

public void setCaseField(Object caseField)

Sets the Case Field parameter of this tool . This parameter is field used to group features for separate central feature computations. The case field can be of numeric, date, or string type. This is an optional parameter.

Parameters:

caseField - field used to group features for separate central feature computations. The case field can be of numeric, date, or string type.

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