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

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

public class GenerateSpatialWeightsMatrix
extends AbstractGPTool

Constructs a spatial weights matrix (.swm) file to represent the spatial relationships among features in a dataset. The Generate Spatial Weights Matrix tool is contained in the Spatial Statistics Tools tool box.
Learn more about how Generate Spatial Weights Matrix works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
GenerateSpatialWeightsMatrix()
          Creates the Generate Spatial Weights Matrix tool with defaults.
GenerateSpatialWeightsMatrix(Object inputFeatureClass, Object uniqueIDField, Object outputSpatialWeightsMatrixFile, String conceptualizationOfSpatialRelationships)
          Creates the Generate Spatial Weights Matrix tool with the required parameters.
 
Method Summary
 String getConceptualizationOfSpatialRelationships()
          Returns the Conceptualization of Spatial Relationships parameter of this tool .
 String getDistanceMethod()
          Returns the Distance Method parameter of this tool .
 double getExponent()
          Returns the Exponent parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 Object getInputTable()
          Returns the Input Table parameter of this tool .
 int getNumberOfNeighbors()
          Returns the Number of Neighbors parameter of this tool .
 Object getOutputSpatialWeightsMatrixFile()
          Returns the Output Spatial Weights Matrix File parameter of this tool .
 String getRowStandardization()
          Returns the Row Standardization parameter of this tool .
 double getThresholdDistance()
          Returns the Threshold Distance 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 getUniqueIDField()
          Returns the Unique ID Field parameter of this tool .
 void setConceptualizationOfSpatialRelationships(String conceptualizationOfSpatialRelationships)
          Sets the Conceptualization of Spatial Relationships parameter of this tool .
 void setDistanceMethod(String distanceMethod)
          Sets the Distance Method parameter of this tool .
 void setExponent(double exponent)
          Sets the Exponent parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setInputTable(Object inputTable)
          Sets the Input Table parameter of this tool .
 void setNumberOfNeighbors(int numberOfNeighbors)
          Sets the Number of Neighbors parameter of this tool .
 void setOutputSpatialWeightsMatrixFile(Object outputSpatialWeightsMatrixFile)
          Sets the Output Spatial Weights Matrix File parameter of this tool .
 void setRowStandardization(String rowStandardization)
          Sets the Row Standardization parameter of this tool .
 void setThresholdDistance(double thresholdDistance)
          Sets the Threshold Distance parameter of this tool .
 void setUniqueIDField(Object uniqueIDField)
          Sets the Unique ID 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

GenerateSpatialWeightsMatrix

public GenerateSpatialWeightsMatrix()
Creates the Generate Spatial Weights Matrix tool with defaults.

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


GenerateSpatialWeightsMatrix

public GenerateSpatialWeightsMatrix(Object inputFeatureClass,
                                    Object uniqueIDField,
                                    Object outputSpatialWeightsMatrixFile,
                                    String conceptualizationOfSpatialRelationships)
Creates the Generate Spatial Weights Matrix 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 Class, the feature class for which spatial relationships of features will be assessed.
uniqueIDField - Field, an integer field containing a different value for every feature in the Input Feature Class.
outputSpatialWeightsMatrixFile - File, the full pathname for the spatial weights matrix file (.swm) you want to create.
conceptualizationOfSpatialRelationships - String, note: Polygon Contiguity methods are only available with an ArcInfo license.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Class, the feature class for which spatial relationships of features will be assessed. 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 Class, the feature class for which spatial relationships of features will be assessed. This is a required parameter.

Parameters:
inputFeatureClass - Feature Class, the feature class for which spatial relationships of features will be assessed.

getUniqueIDField

public Object getUniqueIDField()
Returns the Unique ID Field parameter of this tool . This parameter is Field, an integer field containing a different value for every feature in the Input Feature Class. This is a required parameter.

Returns:
the Unique ID Field

setUniqueIDField

public void setUniqueIDField(Object uniqueIDField)
Sets the Unique ID Field parameter of this tool . This parameter is Field, an integer field containing a different value for every feature in the Input Feature Class. This is a required parameter.

Parameters:
uniqueIDField - Field, an integer field containing a different value for every feature in the Input Feature Class.

getOutputSpatialWeightsMatrixFile

public Object getOutputSpatialWeightsMatrixFile()
Returns the Output Spatial Weights Matrix File parameter of this tool . This parameter is File, the full pathname for the spatial weights matrix file (.swm) you want to create. This is a required parameter.

Returns:
the Output Spatial Weights Matrix File

setOutputSpatialWeightsMatrixFile

public void setOutputSpatialWeightsMatrixFile(Object outputSpatialWeightsMatrixFile)
Sets the Output Spatial Weights Matrix File parameter of this tool . This parameter is File, the full pathname for the spatial weights matrix file (.swm) you want to create. This is a required parameter.

Parameters:
outputSpatialWeightsMatrixFile - File, the full pathname for the spatial weights matrix file (.swm) you want to create.

getConceptualizationOfSpatialRelationships

public String getConceptualizationOfSpatialRelationships()
Returns the Conceptualization of Spatial Relationships parameter of this tool . This parameter is String, note: Polygon Contiguity methods are only available with an ArcInfo license. 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, note: Polygon Contiguity methods are only available with an ArcInfo license. This is a required parameter.

Parameters:
conceptualizationOfSpatialRelationships - String, note: Polygon Contiguity methods are only available with an ArcInfo license.

getDistanceMethod

public String getDistanceMethod()
Returns the Distance Method parameter of this tool . This parameter is String, specifies how distances among features are calculated. This is an optional 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 distances among features are calculated. This is an optional parameter.

Parameters:
distanceMethod - String, specifies how distances among features are calculated.

getExponent

public double getExponent()
Returns the Exponent parameter of this tool . This parameter is Double, parameter for inverse distance calculation. Typical values are 1 or 2. This is an optional parameter.

Returns:
the Exponent

setExponent

public void setExponent(double exponent)
Sets the Exponent parameter of this tool . This parameter is Double, parameter for inverse distance calculation. Typical values are 1 or 2. This is an optional parameter.

Parameters:
exponent - Double, parameter for inverse distance calculation. Typical values are 1 or 2.

getThresholdDistance

public double getThresholdDistance()
Returns the Threshold Distance parameter of this tool . This parameter is Double, specifies a cutoff distance for Inverse Distance and Fixed Distance conceptualizations of spatial relationships. Enter this value using the units specified in the environment output coordinate system. A value of zero indicates that no threshold distance is applied. When this parameter is left blank, a default threshold value is computed based on output feature class extent and the number of features. This is an optional parameter.

Returns:
the Threshold Distance

setThresholdDistance

public void setThresholdDistance(double thresholdDistance)
Sets the Threshold Distance parameter of this tool . This parameter is Double, specifies a cutoff distance for Inverse Distance and Fixed Distance conceptualizations of spatial relationships. Enter this value using the units specified in the environment output coordinate system. A value of zero indicates that no threshold distance is applied. When this parameter is left blank, a default threshold value is computed based on output feature class extent and the number of features. This is an optional parameter.

Parameters:
thresholdDistance - Double, specifies a cutoff distance for Inverse Distance and Fixed Distance conceptualizations of spatial relationships. Enter this value using the units specified in the environment output coordinate system. A value of zero indicates that no threshold distance is applied. When this parameter is left blank, a default threshold value is computed based on output feature class extent and the number of features.

getNumberOfNeighbors

public int getNumberOfNeighbors()
Returns the Number of Neighbors parameter of this tool . This parameter is Integer, an integer reflecting either the minimum or the exact number of neighbors. For K_NEAREST_NEIGHBORS, each feature will have exactly this specified number of neighbors. For INVERSE_DISTANCE or FIXED_DISTANCE each feature will have at least this many neighbors (the threshold distance will be extended to ensure this many neighbors, if necessary). When there are island polygons and one of the CONTIGUITY Conceptualizations of Spatial Relationships is selected, then this specified number of nearest polygons will be associated with those island polygons. This is an optional parameter.

Returns:
the Number of Neighbors

setNumberOfNeighbors

public void setNumberOfNeighbors(int numberOfNeighbors)
Sets the Number of Neighbors parameter of this tool . This parameter is Integer, an integer reflecting either the minimum or the exact number of neighbors. For K_NEAREST_NEIGHBORS, each feature will have exactly this specified number of neighbors. For INVERSE_DISTANCE or FIXED_DISTANCE each feature will have at least this many neighbors (the threshold distance will be extended to ensure this many neighbors, if necessary). When there are island polygons and one of the CONTIGUITY Conceptualizations of Spatial Relationships is selected, then this specified number of nearest polygons will be associated with those island polygons. This is an optional parameter.

Parameters:
numberOfNeighbors - Integer, an integer reflecting either the minimum or the exact number of neighbors. For K_NEAREST_NEIGHBORS, each feature will have exactly this specified number of neighbors. For INVERSE_DISTANCE or FIXED_DISTANCE each feature will have at least this many neighbors (the threshold distance will be extended to ensure this many neighbors, if necessary). When there are island polygons and one of the CONTIGUITY Conceptualizations of Spatial Relationships is selected, then this specified number of nearest polygons will be associated with those island polygons.

getRowStandardization

public String getRowStandardization()
Returns the Row Standardization parameter of this tool . This parameter is String, row standardization is recommended whenever feature distribution is potentially biased due to sampling design or to an imposed aggregation scheme. This is an optional parameter.

Returns:
the Row Standardization

setRowStandardization

public void setRowStandardization(String rowStandardization)
Sets the Row Standardization parameter of this tool . This parameter is String, row standardization is recommended whenever feature distribution is potentially biased due to sampling design or to an imposed aggregation scheme. This is an optional parameter.

Parameters:
rowStandardization - String, row standardization is recommended whenever feature distribution is potentially biased due to sampling design or to an imposed aggregation scheme.

getInputTable

public Object getInputTable()
Returns the Input Table parameter of this tool . This parameter is File, a table containing numeric weights relating every feature to every other feature in the input feature class. Required fields are , NID (neighbor ID), and WEIGHT. This is an optional parameter.

Returns:
the Input Table

setInputTable

public void setInputTable(Object inputTable)
Sets the Input Table parameter of this tool . This parameter is File, a table containing numeric weights relating every feature to every other feature in the input feature class. Required fields are , NID (neighbor ID), and WEIGHT. This is an optional parameter.

Parameters:
inputTable - File, a table containing numeric weights relating every feature to every other feature in the input feature class. Required fields are , NID (neighbor ID), and WEIGHT.

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