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

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

All Implemented Interfaces:

GPTool

public class GALayerToPoints
extends AbstractGPTool

Exports a geostatistical layer to points. The tool can also be used to predict values at unmeasured locations or to validate predictions made at measured locations. The GA Layer To Points tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• For data formats that support Null values, such as file and personal geodatabase feature classes, a Null value will be used to indicate that a prediction could not be made for that location or that the value showed be ignored when used as input. For data formats that do not support Null values, such as shapefiles, the value of -1.7976931348623158e+308 is used (this is the negative of the C++ defined constant DBL_MAX) to indicate that a prediction could not be made for that location.
• The fields in the output feature class can include the following (where applicable):

Field Summary

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

vals

Constructor Summary

GALayerToPoints()
Creates the GA Layer To Points tool with defaults.

GALayerToPoints(Object inGeostatLayer, Object inLocations, Object outFeatureClass)
Creates the GA Layer To Points tool with the required parameters.

Method Summary

Object	getInGeostatLayer() Returns the Input geostatistical layer parameter of this tool .
Object	getInLocations() Returns the Point observation locations parameter of this tool .
Object	getOutFeatureClass() Returns the Output statistics at point locations 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	getZField() Returns the Field to validate on parameter of this tool .
void	setInGeostatLayer(Object inGeostatLayer) Sets the Input geostatistical layer parameter of this tool .
void	setInLocations(Object inLocations) Sets the Point observation locations parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output statistics at point locations parameter of this tool .
void	setZField(Object zField) Sets the Field to validate on 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

GALayerToPoints

public GALayerToPoints()

Creates the GA Layer To Points tool with defaults.

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

GALayerToPoints

public GALayerToPoints(Object inGeostatLayer,
                       Object inLocations,
                       Object outFeatureClass)

Creates the GA Layer To 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:

inGeostatLayer - the geostatistical layer to be analyzed.

inLocations - point locations where predictions or validations will be performed.

outFeatureClass - the output feature class containing either the predictions or the predictions and the validation results.

Method Detail

getInGeostatLayer

public Object getInGeostatLayer()

Returns the Input geostatistical layer parameter of this tool . This parameter is the geostatistical layer to be analyzed. 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 the geostatistical layer to be analyzed. This is a required parameter.

Parameters:

inGeostatLayer - the geostatistical layer to be analyzed.

getInLocations

public Object getInLocations()

Returns the Point observation locations parameter of this tool . This parameter is point locations where predictions or validations will be performed. This is a required parameter.

Returns:

the Point observation locations

setInLocations

public void setInLocations(Object inLocations)

Sets the Point observation locations parameter of this tool . This parameter is point locations where predictions or validations will be performed. This is a required parameter.

Parameters:

inLocations - point locations where predictions or validations will be performed.

getZField

public Object getZField()

Returns the Field to validate on parameter of this tool . This parameter is if this field is left blank, predictions are made at the location points. If a field is selected, predictions are made at the location points and compared to their Z_value_field values, then a validation analysis is performed. This is an optional parameter.

Returns:

the Field to validate on

setZField

public void setZField(Object zField)

Sets the Field to validate on parameter of this tool . This parameter is if this field is left blank, predictions are made at the location points. If a field is selected, predictions are made at the location points and compared to their Z_value_field values, then a validation analysis is performed. This is an optional parameter.

Parameters:

zField - if this field is left blank, predictions are made at the location points. If a field is selected, predictions are made at the location points and compared to their Z_value_field values, then a validation analysis is performed.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output statistics at point locations parameter of this tool . This parameter is the output feature class containing either the predictions or the predictions and the validation results. This is a required parameter.

Returns:

the Output statistics at point locations

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output statistics at point locations parameter of this tool . This parameter is the output feature class containing either the predictions or the predictions and the validation results. This is a required parameter.

Parameters:

outFeatureClass - the output feature class containing either the predictions or the predictions and the validation results.

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