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

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

All Implemented Interfaces:

GPTool

public class GenerateNetworkSpatialWeights
extends AbstractGPTool

Constructs a spatial weights matrix file (.swm) using a Network dataset, defining feature spatial relationships in terms of the underlying network structure. The Generate Network Spatial Weights tool is contained in the Spatial Statistics Tools tool box.

Usage tips:

• Output from this tool is a spatial weights matrix file (.swm). Tools that require you to specify a Conceptualization of Spatial Relationships option will accept a ; select GET_SPATIAL_WEIGHTS_FROM_FILE for the Conceptualization of Spatial Relationships parameter and, for the Weights Matrix File parameter, specify the full pathname to the spatial weights file created using this tool.
• This tool was designed to work with point Input Feature Class data only.
• A quantifies the spatial relationships that exist among the features in your dataset. Many tools in the evaluate each feature within the context of its neighboring features. The spatial weights matrix file defines those neighbor relationships. For this tool, neighbor relationships are based on the time or distance between features, in the case where travel is restricted to a network. For more information about spatial weights and , see .
• The Unique ID field is used to relate features to one another (the relationship or weight between features 1 and 5, for example). Consequently, the Unique ID field values must be unique for every feature and typically should be a permanent field that will remain with the input feature class.
• The Maximum Number of Neighbors parameter for this tool specifies the exact number of neighbors that will be associated with each feature. The Impedance Cutoff overrides the number of neighbors parameter, so that some features may have fewer neighbors if the number of neighbors specified cannot be found within the cutoff distance/time.
• You can define spatial relationships using the hierarchy in the network dataset, if it has one, by checking the Use Hierarchy in Analysis parameter. The hierarchy classifies network edges into primary, secondary, and local roads. When using the hierarchy of the network to create spatial relationships among features, preference will be given to travel on primary roads more than secondary roads and secondary roads more than local roads.
• This tool does not honor the Environment output coordinate system. All feature geometry is projected to match the spatial reference associated with the prior to analysis. The resultant spatial weights matrix file created by this tool will reflect spatial relationships defined using the Network Dataset spatial reference. It is recommended that when performing analyses using a network spatial weights matrix file, the input feature class be projected to match the coordinate system of the network dataset used to create the network swm.
• 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

GenerateNetworkSpatialWeights()
Creates the Generate Network Spatial Weights tool with defaults.

GenerateNetworkSpatialWeights(Object inputFeatureClass, Object uniqueIDField, Object outputSpatialWeightsMatrixFile, Object inputNetwork, String impedanceAttribute)
Creates the Generate Network Spatial Weights tool with the required parameters.

Method Summary

Object	getBarriers() Returns the Barriers parameter of this tool .
String	getConceptualizationOfSpatialRelationships() Returns the Conceptualization of Spatial Relationships parameter of this tool .
double	getExponent() Returns the Exponent parameter of this tool .
String	getImpedanceAttribute() Returns the Impedance Attribute parameter of this tool .
double	getImpedanceCutoff() Returns the Impedance Cutoff parameter of this tool .
Object	getInputFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInputNetwork() Returns the Input Network parameter of this tool .
int	getMaximumNumberOfNeighbors() Returns the Maximum Number of Neighbors parameter of this tool .
Object	getOutputSpatialWeightsMatrixFile() Returns the Output Spatial Weights Matrix File parameter of this tool .
Object	getRestrictions() Returns the Restrictions parameter of this tool .
String	getRowStandardization() Returns the Row Standardization parameter of this tool .
Object	getSearchTolerance() Returns the Search Tolerance 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 .
String	getUseHierarchyInAnalysis() Returns the Use Hierarchy in Analysis parameter of this tool .
String	getUTurnPolicy() Returns the U-turn Policy parameter of this tool .
void	setBarriers(Object barriers) Sets the Barriers parameter of this tool .
void	setConceptualizationOfSpatialRelationships(String conceptualizationOfSpatialRelationships) Sets the Conceptualization of Spatial Relationships parameter of this tool .
void	setExponent(double exponent) Sets the Exponent parameter of this tool .
void	setImpedanceAttribute(String impedanceAttribute) Sets the Impedance Attribute parameter of this tool .
void	setImpedanceCutoff(double impedanceCutoff) Sets the Impedance Cutoff parameter of this tool .
void	setInputFeatureClass(Object inputFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInputNetwork(Object inputNetwork) Sets the Input Network parameter of this tool .
void	setMaximumNumberOfNeighbors(int maximumNumberOfNeighbors) Sets the Maximum Number of Neighbors parameter of this tool .
void	setOutputSpatialWeightsMatrixFile(Object outputSpatialWeightsMatrixFile) Sets the Output Spatial Weights Matrix File parameter of this tool .
void	setRestrictions(Object restrictions) Sets the Restrictions parameter of this tool .
void	setRowStandardization(String rowStandardization) Sets the Row Standardization parameter of this tool .
void	setSearchTolerance(Object searchTolerance) Sets the Search Tolerance parameter of this tool .
void	setUniqueIDField(Object uniqueIDField) Sets the Unique ID Field parameter of this tool .
void	setUseHierarchyInAnalysis(String useHierarchyInAnalysis) Sets the Use Hierarchy in Analysis parameter of this tool .
void	setUTurnPolicy(String uTurnPolicy) Sets the U-turn Policy 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

GenerateNetworkSpatialWeights

public GenerateNetworkSpatialWeights()

Creates the Generate Network Spatial Weights tool with defaults.

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

GenerateNetworkSpatialWeights

public GenerateNetworkSpatialWeights(Object inputFeatureClass,
                                     Object uniqueIDField,
                                     Object outputSpatialWeightsMatrixFile,
                                     Object inputNetwork,
                                     String impedanceAttribute)

Creates the Generate Network Spatial Weights 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 point feature class for which Network spatial relationships among features will be assessed.

uniqueIDField - an integer field containing a different value for every feature in the input feature class.

outputSpatialWeightsMatrixFile - the full path for the network spatial weights matrix (.swm) file created.

inputNetwork - the network dataset for which spatial relationships among features in the input feature class will be defined.

impedanceAttribute - the type of cost units to use as impedance in the analysis.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the point feature class for which Network spatial relationships among 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 the point feature class for which Network spatial relationships among features will be assessed. This is a required parameter.

Parameters:

inputFeatureClass - the point feature class for which Network spatial relationships among features will be assessed.

getUniqueIDField

public Object getUniqueIDField()

Returns the Unique ID Field parameter of this tool . This parameter is 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 an integer field containing a different value for every feature in the input feature class. This is a required parameter.

Parameters:

uniqueIDField - 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 the full path for the network spatial weights matrix (.swm) file created. 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 the full path for the network spatial weights matrix (.swm) file created. This is a required parameter.

Parameters:

outputSpatialWeightsMatrixFile - the full path for the network spatial weights matrix (.swm) file created.

getInputNetwork

public Object getInputNetwork()

Returns the Input Network parameter of this tool . This parameter is the network dataset for which spatial relationships among features in the input feature class will be defined. This is a required parameter.

Returns:

the Input Network

setInputNetwork

public void setInputNetwork(Object inputNetwork)

Sets the Input Network parameter of this tool . This parameter is the network dataset for which spatial relationships among features in the input feature class will be defined. This is a required parameter.

Parameters:

inputNetwork - the network dataset for which spatial relationships among features in the input feature class will be defined.

getImpedanceAttribute

public String getImpedanceAttribute()

Returns the Impedance Attribute parameter of this tool . This parameter is the type of cost units to use as impedance in the analysis. This is a required parameter.

Returns:

the Impedance Attribute

setImpedanceAttribute

public void setImpedanceAttribute(String impedanceAttribute)

Sets the Impedance Attribute parameter of this tool . This parameter is the type of cost units to use as impedance in the analysis. This is a required parameter.

Parameters:

impedanceAttribute - the type of cost units to use as impedance in the analysis.

getImpedanceCutoff

public double getImpedanceCutoff()

Returns the Impedance Cutoff parameter of this tool . This parameter is specifies a cutoff value for Inverse and Fixed conceptualizations of spatial relationships. Enter this value using the units specified by the Impedance Attribute parameter. a value of zero indicates that no threshold is applied. When this parameter is left blank, a default threshold value is computed based on input feature class extent and the number of features. This is an optional parameter.

Returns:

the Impedance Cutoff

setImpedanceCutoff

public void setImpedanceCutoff(double impedanceCutoff)

Sets the Impedance Cutoff parameter of this tool . This parameter is specifies a cutoff value for Inverse and Fixed conceptualizations of spatial relationships. Enter this value using the units specified by the Impedance Attribute parameter. a value of zero indicates that no threshold is applied. When this parameter is left blank, a default threshold value is computed based on input feature class extent and the number of features. This is an optional parameter.

Parameters:

impedanceCutoff - specifies a cutoff value for Inverse and Fixed conceptualizations of spatial relationships. Enter this value using the units specified by the Impedance Attribute parameter. a value of zero indicates that no threshold is applied. When this parameter is left blank, a default threshold value is computed based on input feature class extent and the number of features.

getMaximumNumberOfNeighbors

public int getMaximumNumberOfNeighbors()

Returns the Maximum Number of Neighbors parameter of this tool . This parameter is an integer reflecting the maximum number of neighbors to find for each feature. This is an optional parameter.

Returns:

the Maximum Number of Neighbors

setMaximumNumberOfNeighbors

public void setMaximumNumberOfNeighbors(int maximumNumberOfNeighbors)

Sets the Maximum Number of Neighbors parameter of this tool . This parameter is an integer reflecting the maximum number of neighbors to find for each feature. This is an optional parameter.

Parameters:

maximumNumberOfNeighbors - an integer reflecting the maximum number of neighbors to find for each feature.

getBarriers

public Object getBarriers()

Returns the Barriers parameter of this tool . This parameter is the name of a point feature class with features representing blocked intersections, road closures, accident sites, or other locations where travel is blocked along the network. This is an optional parameter.

Returns:

the Barriers

setBarriers

public void setBarriers(Object barriers)

Sets the Barriers parameter of this tool . This parameter is the name of a point feature class with features representing blocked intersections, road closures, accident sites, or other locations where travel is blocked along the network. This is an optional parameter.

Parameters:

barriers - the name of a point feature class with features representing blocked intersections, road closures, accident sites, or other locations where travel is blocked along the network.

getUTurnPolicy

public String getUTurnPolicy()

Returns the U-turn Policy parameter of this tool . This parameter is specifies optional U-turn restrictions. This is an optional parameter.

Returns:

the U-turn Policy

setUTurnPolicy

public void setUTurnPolicy(String uTurnPolicy)

Sets the U-turn Policy parameter of this tool . This parameter is specifies optional U-turn restrictions. This is an optional parameter.

Parameters:

uTurnPolicy - specifies optional U-turn restrictions.

getRestrictions

public Object getRestrictions()

Returns the Restrictions parameter of this tool . This parameter is a list of restrictions. Check ON the restrictions to be honored in spatial relationship computations. This is an optional parameter.

Returns:

the Restrictions

setRestrictions

public void setRestrictions(Object restrictions)

Sets the Restrictions parameter of this tool . This parameter is a list of restrictions. Check ON the restrictions to be honored in spatial relationship computations. This is an optional parameter.

Parameters:

restrictions - a list of restrictions. Check ON the restrictions to be honored in spatial relationship computations.

getUseHierarchyInAnalysis

public String getUseHierarchyInAnalysis()

Returns the Use Hierarchy in Analysis parameter of this tool . This parameter is specifies whether or not to use a hierarchy in the analysis. This is an optional parameter.

Returns:

the Use Hierarchy in Analysis

setUseHierarchyInAnalysis

public void setUseHierarchyInAnalysis(String useHierarchyInAnalysis)

Sets the Use Hierarchy in Analysis parameter of this tool . This parameter is specifies whether or not to use a hierarchy in the analysis. This is an optional parameter.

Parameters:

useHierarchyInAnalysis - specifies whether or not to use a hierarchy in the analysis.

getSearchTolerance

public Object getSearchTolerance()

Returns the Search Tolerance parameter of this tool . This parameter is the search threshold used to locate features in the Input Feature Class onto the Network Dataset. This parameter includes a search value and the units for the tolerance. This is an optional parameter.

Returns:

the Search Tolerance

setSearchTolerance

public void setSearchTolerance(Object searchTolerance)

Sets the Search Tolerance parameter of this tool . This parameter is the search threshold used to locate features in the Input Feature Class onto the Network Dataset. This parameter includes a search value and the units for the tolerance. This is an optional parameter.

Parameters:

searchTolerance - the search threshold used to locate features in the Input Feature Class onto the Network Dataset. This parameter includes a search value and the units for the tolerance.

getConceptualizationOfSpatialRelationships

public String getConceptualizationOfSpatialRelationships()

Returns the Conceptualization of Spatial Relationships parameter of this tool . This parameter is specifies how the weighting associated with each spatial relationship is specified. For INVERSE, features farther away have a smaller weight than features nearby. For FIXED, features within the Impedance Cutoff of a target feature are neighbors (weight of 1); features outside the Impedance Cutoff of a target feature are not (weight of 0). This is an optional 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 specifies how the weighting associated with each spatial relationship is specified. For INVERSE, features farther away have a smaller weight than features nearby. For FIXED, features within the Impedance Cutoff of a target feature are neighbors (weight of 1); features outside the Impedance Cutoff of a target feature are not (weight of 0). This is an optional parameter.

Parameters:

conceptualizationOfSpatialRelationships - specifies how the weighting associated with each spatial relationship is specified. For INVERSE, features farther away have a smaller weight than features nearby. For FIXED, features within the Impedance Cutoff of a target feature are neighbors (weight of 1); features outside the Impedance Cutoff of a target feature are not (weight of 0).

getExponent

public double getExponent()

Returns the Exponent parameter of this tool . This parameter is parameter for the INVERSE Conceptualization of Spatial Relationships calculation. Typical values are 1 or 2. Weights drop off quicker with distance as this exponent value increases. This is an optional parameter.

Returns:

the Exponent

setExponent

public void setExponent(double exponent)

Sets the Exponent parameter of this tool . This parameter is parameter for the INVERSE Conceptualization of Spatial Relationships calculation. Typical values are 1 or 2. Weights drop off quicker with distance as this exponent value increases. This is an optional parameter.

Parameters:

exponent - parameter for the INVERSE Conceptualization of Spatial Relationships calculation. Typical values are 1 or 2. Weights drop off quicker with distance as this exponent value increases.

getRowStandardization

public String getRowStandardization()

Returns the Row Standardization parameter of this tool . This parameter is 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 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 - row standardization is recommended whenever feature distribution is potentially biased due to sampling design or to an imposed aggregation scheme.

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