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

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

All Implemented Interfaces:

GPTool

public class GALayerToGrid
extends AbstractGPTool

Exports a Geostatistical layer to a raster. The GA Layer To Grid tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• The output raster will be created at the cell size specified in the Output cell size parameter.
• Select the number of predictions for each cell in the horizontal and vertical directions for block interpolation.

Field Summary

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

vals

Constructor Summary

GALayerToGrid()
Creates the GA Layer To Grid tool with defaults.

GALayerToGrid(Object inGeostatLayer, Object outSurfaceGrid)
Creates the GA Layer To Grid tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInGeostatLayer() Returns the Input geostatistical layer parameter of this tool .
Object	getOutSurfaceGrid() Returns the Output surface raster parameter of this tool .
int	getPointsPerBlockHorz() Returns the # of points in the cell (horizontal) parameter of this tool .
int	getPointsPerBlockVert() Returns the # of points in the cell (vertical) 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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInGeostatLayer(Object inGeostatLayer) Sets the Input geostatistical layer parameter of this tool .
void	setOutSurfaceGrid(Object outSurfaceGrid) Sets the Output surface raster parameter of this tool .
void	setPointsPerBlockHorz(int pointsPerBlockHorz) Sets the # of points in the cell (horizontal) parameter of this tool .
void	setPointsPerBlockVert(int pointsPerBlockVert) Sets the # of points in the cell (vertical) 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

GALayerToGrid

public GALayerToGrid()

Creates the GA Layer To Grid tool with defaults.

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

GALayerToGrid

public GALayerToGrid(Object inGeostatLayer,
                     Object outSurfaceGrid)

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

outSurfaceGrid - the raster to be created.

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.

getOutSurfaceGrid

public Object getOutSurfaceGrid()

Returns the Output surface raster parameter of this tool . This parameter is the raster to be created. This is a required parameter.

Returns:

the Output surface raster

setOutSurfaceGrid

public void setOutSurfaceGrid(Object outSurfaceGrid)

Sets the Output surface raster parameter of this tool . This parameter is the raster to be created. This is a required parameter.

Parameters:

outSurfaceGrid - the raster to be created.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is the cell size at which the output raster will be created. this value can be explicitly set under Raster Analysis from the Environment Settings. If not set, it is the shorter of the width or the height of the extent of the input point features, in the input spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is the cell size at which the output raster will be created. this value can be explicitly set under Raster Analysis from the Environment Settings. If not set, it is the shorter of the width or the height of the extent of the input point features, in the input spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - the cell size at which the output raster will be created. this value can be explicitly set under Raster Analysis from the Environment Settings. If not set, it is the shorter of the width or the height of the extent of the input point features, in the input spatial reference, divided by 250.

getPointsPerBlockHorz

public int getPointsPerBlockHorz()

Returns the # of points in the cell (horizontal) parameter of this tool . This parameter is the number of predictions for each cell in the horizontal direction for block interpolation. This is an optional parameter.

Returns:

the # of points in the cell (horizontal)

setPointsPerBlockHorz

public void setPointsPerBlockHorz(int pointsPerBlockHorz)

Sets the # of points in the cell (horizontal) parameter of this tool . This parameter is the number of predictions for each cell in the horizontal direction for block interpolation. This is an optional parameter.

Parameters:

pointsPerBlockHorz - the number of predictions for each cell in the horizontal direction for block interpolation.

getPointsPerBlockVert

public int getPointsPerBlockVert()

Returns the # of points in the cell (vertical) parameter of this tool . This parameter is the number of predictions for each cell in the vertical direction for block interpolation. This is an optional parameter.

Returns:

the # of points in the cell (vertical)

setPointsPerBlockVert

public void setPointsPerBlockVert(int pointsPerBlockVert)

Sets the # of points in the cell (vertical) parameter of this tool . This parameter is the number of predictions for each cell in the vertical direction for block interpolation. This is an optional parameter.

Parameters:

pointsPerBlockVert - the number of predictions for each cell in the vertical direction for block interpolation.

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