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

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

All Implemented Interfaces:

GPTool

public class SubsetFeatures
extends AbstractGPTool

Divides the original dataset into two parts: one part to be used to model the spatial structure and produce a surface, the other to be used to compare and validate the output surface. The Subset Features tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• If multipart features are used as input, the output will be a subset of multipart features and not individual features.
• If you want the random sequence used to create the subsets to be repeatable, you need to specify a nonzero seed value in the environment variable.

Field Summary

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

vals

Constructor Summary

SubsetFeatures()
Creates the Subset Features tool with defaults.

SubsetFeatures(Object inFeatures, Object outTrainingFeatures)
Creates the Subset Features tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input feature class parameter of this tool .
Object	getOutTestFeatures() Returns the Output test feature class parameter of this tool .
Object	getOutTrainingFeatures() Returns the Output training feature class parameter of this tool .
double	getSizeOfTrainingDataset() Returns the Size of training feature subset parameter of this tool .
String	getSubsetSizeUnits() Returns the Subset size units 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	setInFeatures(Object inFeatures) Sets the Input feature class parameter of this tool .
void	setOutTestFeatures(Object outTestFeatures) Sets the Output test feature class parameter of this tool .
void	setOutTrainingFeatures(Object outTrainingFeatures) Sets the Output training feature class parameter of this tool .
void	setSizeOfTrainingDataset(double sizeOfTrainingDataset) Sets the Size of training feature subset parameter of this tool .
void	setSubsetSizeUnits(String subsetSizeUnits) Sets the Subset size units 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

SubsetFeatures

public SubsetFeatures()

Creates the Subset Features tool with defaults.

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

SubsetFeatures

public SubsetFeatures(Object inFeatures,
                      Object outTrainingFeatures)

Creates the Subset Features 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:

inFeatures - points, lines, or polygon features to create a subset from.

outTrainingFeatures - the subset of training features to be created.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input feature class parameter of this tool . This parameter is points, lines, or polygon features to create a subset from. This is a required parameter.

Returns:

the Input feature class

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input feature class parameter of this tool . This parameter is points, lines, or polygon features to create a subset from. This is a required parameter.

Parameters:

inFeatures - points, lines, or polygon features to create a subset from.

getOutTrainingFeatures

public Object getOutTrainingFeatures()

Returns the Output training feature class parameter of this tool . This parameter is the subset of training features to be created. This is a required parameter.

Returns:

the Output training feature class

setOutTrainingFeatures

public void setOutTrainingFeatures(Object outTrainingFeatures)

Sets the Output training feature class parameter of this tool . This parameter is the subset of training features to be created. This is a required parameter.

Parameters:

outTrainingFeatures - the subset of training features to be created.

getOutTestFeatures

public Object getOutTestFeatures()

Returns the Output test feature class parameter of this tool . This parameter is the subset of test features to be created. This is an optional parameter.

Returns:

the Output test feature class

setOutTestFeatures

public void setOutTestFeatures(Object outTestFeatures)

Sets the Output test feature class parameter of this tool . This parameter is the subset of test features to be created. This is an optional parameter.

Parameters:

outTestFeatures - the subset of test features to be created.

getSizeOfTrainingDataset

public double getSizeOfTrainingDataset()

Returns the Size of training feature subset parameter of this tool . This parameter is the size of the output training feature class entered either as a percentage of the input features or as an absolute number of features. This is an optional parameter.

Returns:

the Size of training feature subset

setSizeOfTrainingDataset

public void setSizeOfTrainingDataset(double sizeOfTrainingDataset)

Sets the Size of training feature subset parameter of this tool . This parameter is the size of the output training feature class entered either as a percentage of the input features or as an absolute number of features. This is an optional parameter.

Parameters:

sizeOfTrainingDataset - the size of the output training feature class entered either as a percentage of the input features or as an absolute number of features.

getSubsetSizeUnits

public String getSubsetSizeUnits()

Returns the Subset size units parameter of this tool . This parameter is type of subset size. This is an optional parameter.

Returns:

the Subset size units

setSubsetSizeUnits

public void setSubsetSizeUnits(String subsetSizeUnits)

Sets the Subset size units parameter of this tool . This parameter is type of subset size. This is an optional parameter.

Parameters:

subsetSizeUnits - type of subset size.

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