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

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

public class DirectionalDistribution
extends AbstractGPTool

Measures whether a distribution of features exhibits a directional trend (whether features are farther from a specified point in one direction than in another direction). The Directional Distribution (Standard Deviational Ellipse) tool is contained in the Spatial Statistics Tools tool box.
Learn about how Directional Distribution: Standard Deviational Ellipse works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DirectionalDistribution()
          Creates the Directional Distribution (Standard Deviational Ellipse) tool with defaults.
DirectionalDistribution(Object inputFeatureClass, Object outputEllipseFeatureClass, String ellipseSize)
          Creates the Directional Distribution (Standard Deviational Ellipse) tool with the required parameters.
 
Method Summary
 Object getCaseField()
          Returns the Case Field parameter of this tool .
 String getEllipseSize()
          Returns the Ellipse Size parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 Object getOutputEllipseFeatureClass()
          Returns the Output Ellipse Feature Class 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 setEllipseSize(String ellipseSize)
          Sets the Ellipse Size parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setOutputEllipseFeatureClass(Object outputEllipseFeatureClass)
          Sets the Output Ellipse Feature Class 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

DirectionalDistribution

public DirectionalDistribution()
Creates the Directional Distribution (Standard Deviational Ellipse) tool with defaults.

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


DirectionalDistribution

public DirectionalDistribution(Object inputFeatureClass,
                               Object outputEllipseFeatureClass,
                               String ellipseSize)
Creates the Directional Distribution (Standard Deviational Ellipse) 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, a feature class containing a distribution of features for which the standard deviational ellipse will be calculated.
outputEllipseFeatureClass - Feature Class, a polygon feature class that will contain the output ellipse feature.
ellipseSize - String, the size of output ellipses in standard deviations. The default ellipse size is 1; valid choices are 1, 2, or 3 standard deviations.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, a feature class containing a distribution of features for which the standard deviational ellipse 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, a feature class containing a distribution of features for which the standard deviational ellipse will be calculated. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, a feature class containing a distribution of features for which the standard deviational ellipse will be calculated.

getOutputEllipseFeatureClass

public Object getOutputEllipseFeatureClass()
Returns the Output Ellipse Feature Class parameter of this tool . This parameter is Feature Class, a polygon feature class that will contain the output ellipse feature. This is a required parameter.

Returns:
the Output Ellipse Feature Class

setOutputEllipseFeatureClass

public void setOutputEllipseFeatureClass(Object outputEllipseFeatureClass)
Sets the Output Ellipse Feature Class parameter of this tool . This parameter is Feature Class, a polygon feature class that will contain the output ellipse feature. This is a required parameter.

Parameters:
outputEllipseFeatureClass - Feature Class, a polygon feature class that will contain the output ellipse feature.

getEllipseSize

public String getEllipseSize()
Returns the Ellipse Size parameter of this tool . This parameter is String, the size of output ellipses in standard deviations. The default ellipse size is 1; valid choices are 1, 2, or 3 standard deviations. This is a required parameter.

Returns:
the Ellipse Size

setEllipseSize

public void setEllipseSize(String ellipseSize)
Sets the Ellipse Size parameter of this tool . This parameter is String, the size of output ellipses in standard deviations. The default ellipse size is 1; valid choices are 1, 2, or 3 standard deviations. This is a required parameter.

Parameters:
ellipseSize - String, the size of output ellipses in standard deviations. The default ellipse size is 1; valid choices are 1, 2, or 3 standard deviations.

getWeightField

public Object getWeightField()
Returns the Weight Field parameter of this tool . This parameter is Field, the numeric field used to weight locations according to their relative importance. 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 Field, the numeric field used to weight locations according to their relative importance. This is an optional parameter.

Parameters:
weightField - Field, the numeric field used to weight locations according to their relative importance.

getCaseField

public Object getCaseField()
Returns the Case Field parameter of this tool . This parameter is Field, field used to group features for separate directional distribution calculations. 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, field used to group features for separate directional distribution calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Parameters:
caseField - Field, field used to group features for separate directional distribution calculations. 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