com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class TerrainToRaster

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analyst3dtools.TerrainToRaster
All Implemented Interfaces:
GPTool

public class TerrainToRaster
extends AbstractGPTool

Converts a terrain dataset into a raster. The Terrain to Raster tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
TerrainToRaster()
          Creates the Terrain to Raster tool with defaults.
TerrainToRaster(Object inTerrain, Object outRaster)
          Creates the Terrain to Raster tool with the required parameters.
 
Method Summary
 String getDataType()
          Returns the Output Data Type parameter of this tool .
 Object getInTerrain()
          Returns the Input Terrain parameter of this tool .
 String getMethod()
          Returns the Method parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster parameter of this tool .
 double getPyramidLevelResolution()
          Returns the Pyramid Level Resolution parameter of this tool .
 String getSampleDistance()
          Returns the Sampling Distance 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 setDataType(String dataType)
          Sets the Output Data Type parameter of this tool .
 void setInTerrain(Object inTerrain)
          Sets the Input Terrain parameter of this tool .
 void setMethod(String method)
          Sets the Method parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output Raster parameter of this tool .
 void setPyramidLevelResolution(double pyramidLevelResolution)
          Sets the Pyramid Level Resolution parameter of this tool .
 void setSampleDistance(String sampleDistance)
          Sets the Sampling Distance 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

TerrainToRaster

public TerrainToRaster()
Creates the Terrain to Raster tool with defaults.

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


TerrainToRaster

public TerrainToRaster(Object inTerrain,
                       Object outRaster)
Creates the Terrain to Raster 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:
inTerrain - the terrain dataset to be converted.
outRaster - the raster to be created.
Method Detail

getInTerrain

public Object getInTerrain()
Returns the Input Terrain parameter of this tool . This parameter is the terrain dataset to be converted. This is a required parameter.

Returns:
the Input Terrain

setInTerrain

public void setInTerrain(Object inTerrain)
Sets the Input Terrain parameter of this tool . This parameter is the terrain dataset to be converted. This is a required parameter.

Parameters:
inTerrain - the terrain dataset to be converted.

getOutRaster

public Object getOutRaster()
Returns the Output Raster parameter of this tool . This parameter is the raster to be created. This is a required parameter.

Returns:
the Output Raster

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output Raster parameter of this tool . This parameter is the raster to be created. This is a required parameter.

Parameters:
outRaster - the raster to be created.

getDataType

public String getDataType()
Returns the Output Data Type parameter of this tool . This parameter is the data type of the output raster. It can be either 32 bit floating point or 32 bit integer. This is an optional parameter.

Returns:
the Output Data Type

setDataType

public void setDataType(String dataType)
Sets the Output Data Type parameter of this tool . This parameter is the data type of the output raster. It can be either 32 bit floating point or 32 bit integer. This is an optional parameter.

Parameters:
dataType - the data type of the output raster. It can be either 32 bit floating point or 32 bit integer.

getMethod

public String getMethod()
Returns the Method parameter of this tool . This parameter is the interpolation method. The default is LINEAR. This is an optional parameter.

Returns:
the Method

setMethod

public void setMethod(String method)
Sets the Method parameter of this tool . This parameter is the interpolation method. The default is LINEAR. This is an optional parameter.

Parameters:
method - the interpolation method. The default is LINEAR.

getSampleDistance

public String getSampleDistance()
Returns the Sampling Distance parameter of this tool . This parameter is controls the cellsize of the output raster. The cellsize is set in one of two ways. You can use the OBSERVERS option to specify how many cells you want on the longest side. The tool will then calculate the cellsize for you. Alternately, you can use the CELLSIZE option to give an explicit value. This is an optional parameter.

Returns:
the Sampling Distance

setSampleDistance

public void setSampleDistance(String sampleDistance)
Sets the Sampling Distance parameter of this tool . This parameter is controls the cellsize of the output raster. The cellsize is set in one of two ways. You can use the OBSERVERS option to specify how many cells you want on the longest side. The tool will then calculate the cellsize for you. Alternately, you can use the CELLSIZE option to give an explicit value. This is an optional parameter.

Parameters:
sampleDistance - controls the cellsize of the output raster. The cellsize is set in one of two ways. You can use the OBSERVERS option to specify how many cells you want on the longest side. The tool will then calculate the cellsize for you. Alternately, you can use the CELLSIZE option to give an explicit value.

getPyramidLevelResolution

public double getPyramidLevelResolution()
Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution, given in z-tolerance or window size, of the pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Returns:
the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)
Sets the Pyramid Level Resolution parameter of this tool . This parameter is the resolution, given in z-tolerance or window size, of the pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Parameters:
pyramidLevelResolution - the resolution, given in z-tolerance or window size, of the pyramid level to use for conversion. The default is 0, full resolution.

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