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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.TinRaster

All Implemented Interfaces:

GPTool

public class TinRaster
extends AbstractGPTool

This tool converts a TIN to a raster. The TIN to Raster tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• TIN To Raster interpolates cell z-values from the input TIN at the specified resolution or sampling interval to produce the output raster.
• Because interpolation of the input TIN surface occurs at regular intervals, some loss of information in the output raster should be expected. How well the raster represents the TIN is dependent on the resolution of the raster and the degree and interval of TIN surface variation. Generally, as the resolution is increased, the output raster more closely represents the TIN surface. Because the raster is a cell structure, it cannot maintain the hard and soft breakline edges that may be present in the TIN.
• You can accept the TIN's XMIN, YMIN as the default origin and the XMAX, YMAX as the upper right corner of the extent to generate a raster covering the full extent of the TIN. Alternatively, you can specify the output raster's origin, extent, and resolution or cell spacing to create a raster covering only a portion of the TIN.
• The Output Data Type determines the data type of the output raster. Floating point preserves the accuracy of z-values, possibly at the expense of disk storage space. On average, integer grids require less storage space than floating-point grids when dealing with terrain data. If the accuracy requirements of your z-values are such that they can be represented by integer data, consider using the INT option.
• The output raster may be file based or created as a raster dataset in a geodatabase. Supported file-based formats include ESRI Grid, ERDAS IMAGINE, and TIFF. The format is determined based on the output name. If the output path references a geodatabase, a geodatabase raster will be created. If the output resides in a normal file folder and does not include a file extension, an ESRI Grid will be produced. Use of the extensions .img and .tif will produce IMAGINE or TIFF files.

Field Summary

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

vals

Constructor Summary

TinRaster()
Creates the TIN to Raster tool with defaults.

TinRaster(Object inTin, Object outRaster)
Creates the TIN to Raster tool with the required parameters.

Method Summary

String	getDataType() Returns the Output Data Type parameter of this tool .
Object	getInTin() Returns the Input TIN parameter of this tool .
String	getMethod() Returns the Method parameter of this tool .
Object	getOutRaster() Returns the Output Raster 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.
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setDataType(String dataType) Sets the Output Data Type parameter of this tool .
void	setInTin(Object inTin) Sets the Input TIN 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	setSampleDistance(String sampleDistance) Sets the Sampling Distance parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor 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

TinRaster

public TinRaster()

Creates the TIN to Raster tool with defaults.

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

TinRaster

public TinRaster(Object inTin,
                 Object outRaster)

Creates the TIN 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:

inTin - the TIN to be converted.

outRaster - the output raster.

Method Detail

getInTin

public Object getInTin()

Returns the Input TIN parameter of this tool . This parameter is the TIN to be converted. This is a required parameter.

Returns:

the Input TIN

setInTin

public void setInTin(Object inTin)

Sets the Input TIN parameter of this tool . This parameter is the TIN to be converted. This is a required parameter.

Parameters:

inTin - the TIN to be converted.

getOutRaster

public Object getOutRaster()

Returns the Output Raster parameter of this tool . This parameter is the output raster. 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 output raster. This is a required parameter.

Parameters:

outRaster - the output raster.

getDataType

public String getDataType()

Returns the Output Data Type parameter of this tool . This parameter is choose whether the output raster will be floating point or integer. By default, the output raster is floating point. 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 choose whether the output raster will be floating point or integer. By default, the output raster is floating point. This is an optional parameter.

Parameters:

dataType - choose whether the output raster will be floating point or integer. By default, the output raster is floating point.

getMethod

public String getMethod()

Returns the Method parameter of this tool . This parameter is choose an interpolation method. By default, cell values are calculated using the LINEAR method. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(String method)

Sets the Method parameter of this tool . This parameter is choose an interpolation method. By default, cell values are calculated using the LINEAR method. This is an optional parameter.

Parameters:

method - choose an interpolation method. By default, cell values are calculated using the LINEAR method.

getSampleDistance

public String getSampleDistance()

Returns the Sampling Distance parameter of this tool . This parameter is choose the sampling distance. 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 choose the sampling distance. This is an optional parameter.

Parameters:

sampleDistance - choose the sampling distance.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor by which the heights of the resultant raster will be multiplied from those of the input TIN; used to convert z-units to x and y-units. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is the factor by which the heights of the resultant raster will be multiplied from those of the input TIN; used to convert z-units to x and y-units. This is an optional parameter.

Parameters:

zFactor - the factor by which the heights of the resultant raster will be multiplied from those of the input TIN; used to convert z-units to x and y-units.

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