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

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

All Implemented Interfaces:

GPTool

public class CreateSpatiallyBalancedPoints
extends AbstractGPTool

The Create Spatially Balanced Points tool is contained in the Geostatistical Analyst Tools tool box.

Field Summary

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

vals

Constructor Summary

CreateSpatiallyBalancedPoints()
Creates the Create Spatially Balanced Points tool with defaults.

CreateSpatiallyBalancedPoints(Object inProbabilityRaster, Object outFeatureClass, int numberOutputPoints)
Creates the Create Spatially Balanced Points tool with the required parameters.

Method Summary

Object	getInProbabilityRaster() Returns the Inclusion probability raster [0,1] 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	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	setInProbabilityRaster(Object inProbabilityRaster) Sets the Inclusion probability raster [0,1] 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 .

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

CreateSpatiallyBalancedPoints

public CreateSpatiallyBalancedPoints()

Creates the Create Spatially Balanced Points tool with defaults.

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

CreateSpatiallyBalancedPoints

public CreateSpatiallyBalancedPoints(Object inProbabilityRaster,
                                     Object outFeatureClass,
                                     int numberOutputPoints)

Creates the Create Spatially Balanced Points 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:

inProbabilityRaster - this raster defines the inclusion probabilities for each location in the area of interest. The location values range from 0 (low inclusion probability) to 1 (high inclusion probability).

outFeatureClass - the output feature class contains the selected sample locations and their inclusion probabilities.

numberOutputPoints - specify how many sample locations to generate.

Method Detail

getInProbabilityRaster

public Object getInProbabilityRaster()

Returns the Inclusion probability raster [0,1] parameter of this tool . This parameter is this raster defines the inclusion probabilities for each location in the area of interest. The location values range from 0 (low inclusion probability) to 1 (high inclusion probability). This is a required parameter.

Returns:

the Inclusion probability raster [0,1]

setInProbabilityRaster

public void setInProbabilityRaster(Object inProbabilityRaster)

Sets the Inclusion probability raster [0,1] parameter of this tool . This parameter is this raster defines the inclusion probabilities for each location in the area of interest. The location values range from 0 (low inclusion probability) to 1 (high inclusion probability). This is a required parameter.

Parameters:

inProbabilityRaster - this raster defines the inclusion probabilities for each location in the area of interest. The location values range from 0 (low inclusion probability) to 1 (high inclusion probability).

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output point feature class parameter of this tool . This parameter is the output feature class contains the selected sample locations and their inclusion probabilities. 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 output feature class contains the selected sample locations and their inclusion probabilities. This is a required parameter.

Parameters:

outFeatureClass - the output feature class contains the selected sample locations and their inclusion probabilities.

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.

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