|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.GenerateNetworkSpatialWeights
public class GenerateNetworkSpatialWeights
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.
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 |
---|
public GenerateNetworkSpatialWeights()
Initializes the array of tool parameters with the default values specified when the tool was created.
public GenerateNetworkSpatialWeights(Object inputFeatureClass, Object uniqueIDField, Object outputSpatialWeightsMatrixFile, Object inputNetwork, String impedanceAttribute)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other 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 |
---|
public Object getInputFeatureClass()
public void setInputFeatureClass(Object inputFeatureClass)
inputFeatureClass
- the point feature class for which Network spatial relationships among features will be assessed.public Object getUniqueIDField()
public void setUniqueIDField(Object uniqueIDField)
uniqueIDField
- an integer field containing a different value for every feature in the input feature class.public Object getOutputSpatialWeightsMatrixFile()
public void setOutputSpatialWeightsMatrixFile(Object outputSpatialWeightsMatrixFile)
outputSpatialWeightsMatrixFile
- the full path for the network spatial weights matrix (.swm) file created.public Object getInputNetwork()
public void setInputNetwork(Object inputNetwork)
inputNetwork
- the network dataset for which spatial relationships among features in the input feature class will be defined.public String getImpedanceAttribute()
public void setImpedanceAttribute(String impedanceAttribute)
impedanceAttribute
- the type of cost units to use as impedance in the analysis.public double getImpedanceCutoff()
public void setImpedanceCutoff(double impedanceCutoff)
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.public int getMaximumNumberOfNeighbors()
public void setMaximumNumberOfNeighbors(int maximumNumberOfNeighbors)
maximumNumberOfNeighbors
- an integer reflecting the maximum number of neighbors to find for each feature.public Object getBarriers()
public void setBarriers(Object barriers)
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.public String getUTurnPolicy()
public void setUTurnPolicy(String uTurnPolicy)
uTurnPolicy
- specifies optional U-turn restrictions.public Object getRestrictions()
public void setRestrictions(Object restrictions)
restrictions
- a list of restrictions. Check ON the restrictions to be honored in spatial relationship computations.public String getUseHierarchyInAnalysis()
public void setUseHierarchyInAnalysis(String useHierarchyInAnalysis)
useHierarchyInAnalysis
- specifies whether or not to use a hierarchy in the analysis.public Object getSearchTolerance()
public void setSearchTolerance(Object searchTolerance)
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.public String getConceptualizationOfSpatialRelationships()
public void setConceptualizationOfSpatialRelationships(String conceptualizationOfSpatialRelationships)
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).public double getExponent()
public void setExponent(double exponent)
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.public String getRowStandardization()
public void setRowStandardization(String rowStandardization)
rowStandardization
- row standardization is recommended whenever feature distribution is potentially biased due to sampling design or to an imposed aggregation scheme.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |