com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class DensifySamplingNetwork

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.DensifySamplingNetwork

All Implemented Interfaces:

GPTool

public class DensifySamplingNetwork
extends AbstractGPTool

Uses The Densify Sampling Network tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• The input geostatistical layer must be a kriging layer.
• The selection criteria are based upon;
  • STDERR = O0(s)
  • STDERR_THRESHOLD = O1(s)
  • QUARTILE_THRESHOLD = O2(s)
• The case might arise where only a single new location is generated when more were requested. This happens when the new location keeps on being selected based on the selection criteria. This can be prevented by specifying a value for the Inhibition distance parameter.
• To decide which locations have the least influence on the prediction surface you may use the feature class that was used to create the kriging layer for the Input candidate point features parameter.

Field Summary

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

vals

Constructor Summary

DensifySamplingNetwork()
Creates the Densify Sampling Network tool with defaults.

DensifySamplingNetwork(Object inGeostatLayer, Object outFeatureClass, int numberOutputPoints)
Creates the Densify Sampling Network tool with the required parameters.

Method Summary

Object	getInCandidatePointFeatures() Returns the Input candidate point features parameter of this tool .
Object	getInGeostatLayer() Returns the Input geostatistical layer parameter of this tool .
Object	getInhibitionDistance() Returns the Inhibition distance parameter of this tool .
Object	getInWeightRaster() Returns the Input weight raster [0;Inf] parameter of this tool .
int	getNumberOutputPoints() Returns the Number of output points parameter of this tool .
Object	getOutFeatureClass() Returns the Output point feature class parameter of this tool .
String	getSelectionCriteria() Returns the Selection criteria parameter of this tool .
double	getThreshold() Returns the Threshold value 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.
void	setInCandidatePointFeatures(Object inCandidatePointFeatures) Sets the Input candidate point features parameter of this tool .
void	setInGeostatLayer(Object inGeostatLayer) Sets the Input geostatistical layer parameter of this tool .
void	setInhibitionDistance(Object inhibitionDistance) Sets the Inhibition distance parameter of this tool .
void	setInWeightRaster(Object inWeightRaster) Sets the Input weight raster [0;Inf] parameter of this tool .
void	setNumberOutputPoints(int numberOutputPoints) Sets the Number of output points parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output point feature class parameter of this tool .
void	setSelectionCriteria(String selectionCriteria) Sets the Selection criteria parameter of this tool .
void	setThreshold(double threshold) Sets the Threshold value 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

DensifySamplingNetwork

public DensifySamplingNetwork()

Creates the Densify Sampling Network tool with defaults.

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

DensifySamplingNetwork

public DensifySamplingNetwork(Object inGeostatLayer,
                              Object outFeatureClass,
                              int numberOutputPoints)

Creates the Densify Sampling Network 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:

inGeostatLayer - input a geostatistical layer resulting from a Kriging model.

outFeatureClass - the name of the output feature class.

numberOutputPoints - specify how many sample locations to generate.

Method Detail

getInGeostatLayer

public Object getInGeostatLayer()

Returns the Input geostatistical layer parameter of this tool . This parameter is input a geostatistical layer resulting from a Kriging model. This is a required parameter.

Returns:

the Input geostatistical layer

setInGeostatLayer

public void setInGeostatLayer(Object inGeostatLayer)

Sets the Input geostatistical layer parameter of this tool . This parameter is input a geostatistical layer resulting from a Kriging model. This is a required parameter.

Parameters:

inGeostatLayer - input a geostatistical layer resulting from a Kriging model.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output point feature class parameter of this tool . This parameter is the name of the output feature class. This is a required parameter.

Returns:

the Output point feature class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output point feature class parameter of this tool . This parameter is the name of the output feature class. This is a required parameter.

Parameters:

outFeatureClass - the name of the output feature class.

getNumberOutputPoints

public int getNumberOutputPoints()

Returns the Number of output points parameter of this tool . This parameter is specify how many sample locations to generate. This is a required parameter.

Returns:

the Number of output points

setNumberOutputPoints

public void setNumberOutputPoints(int numberOutputPoints)

Sets the Number of output points parameter of this tool . This parameter is specify how many sample locations to generate. This is a required parameter.

Parameters:

numberOutputPoints - specify how many sample locations to generate.

getSelectionCriteria

public String getSelectionCriteria()

Returns the Selection criteria parameter of this tool . This parameter is methods to densify a sampling network. This is an optional parameter.

Returns:

the Selection criteria

setSelectionCriteria

public void setSelectionCriteria(String selectionCriteria)

Sets the Selection criteria parameter of this tool . This parameter is methods to densify a sampling network. This is an optional parameter.

Parameters:

selectionCriteria - methods to densify a sampling network.

getThreshold

public double getThreshold()

Returns the Threshold value parameter of this tool . This parameter is the threshold value used to densify the sampling network, applicable only when STDERR_THRESHOLD or QUARTILE_THRESHOLD selection criteria are used. This is an optional parameter.

Returns:

the Threshold value

setThreshold

public void setThreshold(double threshold)

Sets the Threshold value parameter of this tool . This parameter is the threshold value used to densify the sampling network, applicable only when STDERR_THRESHOLD or QUARTILE_THRESHOLD selection criteria are used. This is an optional parameter.

Parameters:

threshold - the threshold value used to densify the sampling network, applicable only when STDERR_THRESHOLD or QUARTILE_THRESHOLD selection criteria are used.

getInWeightRaster

public Object getInWeightRaster()

Returns the Input weight raster [0;Inf] parameter of this tool . This parameter is a raster used to determine which locations to weight for preference. This is an optional parameter.

Returns:

the Input weight raster [0;Inf]

setInWeightRaster

public void setInWeightRaster(Object inWeightRaster)

Sets the Input weight raster [0;Inf] parameter of this tool . This parameter is a raster used to determine which locations to weight for preference. This is an optional parameter.

Parameters:

inWeightRaster - a raster used to determine which locations to weight for preference.

getInCandidatePointFeatures

public Object getInCandidatePointFeatures()

Returns the Input candidate point features parameter of this tool . This parameter is sample locations to pick from. This is an optional parameter.

Returns:

the Input candidate point features

setInCandidatePointFeatures

public void setInCandidatePointFeatures(Object inCandidatePointFeatures)

Sets the Input candidate point features parameter of this tool . This parameter is sample locations to pick from. This is an optional parameter.

Parameters:

inCandidatePointFeatures - sample locations to pick from.

getInhibitionDistance

public Object getInhibitionDistance()

Returns the Inhibition distance parameter of this tool . This parameter is used to prevent any samples being placed within this distance from each other. This is an optional parameter.

Returns:

the Inhibition distance

setInhibitionDistance

public void setInhibitionDistance(Object inhibitionDistance)

Sets the Inhibition distance parameter of this tool . This parameter is used to prevent any samples being placed within this distance from each other. This is an optional parameter.

Parameters:

inhibitionDistance - used to prevent any samples being placed within this distance from each other.

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