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

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

All Implemented Interfaces:

GPTool

public class RasterTin
extends AbstractGPTool

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

Usage tips:

• Converting a raster to a TIN will not, in and of itself, produce a better surface. You need ancillary data that's compatible with, and improves, the surface definition. Typically, these data would be added to the TIN in a subsequent process.
• The default maximum allowable difference between the height of the input raster and the height of the output TIN is 1/10 of the z range of the input raster.
• While the maximum size of a TIN that can be used under Win32 is between 15 to 20 million nodes it's recommended to cap the size at a few million. Large input rasters, and small z-tolerance settings, may exceed this. If size is an issue consider processing subsets.

Field Summary

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

vals

Constructor Summary

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

RasterTin(Object inRaster, Object outTin)
Creates the Raster to TIN tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input Raster parameter of this tool .
int	getMaxPoints() Returns the Maximum Number of Points parameter of this tool .
Object	getOutTin() Returns the Output TIN 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 .
double	getZTolerance() Returns the Z Tolerance parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setMaxPoints(int maxPoints) Sets the Maximum Number of Points parameter of this tool .
void	setOutTin(Object outTin) Sets the Output TIN parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor parameter of this tool .
void	setZTolerance(double zTolerance) Sets the Z Tolerance 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

RasterTin

public RasterTin()

Creates the Raster to TIN tool with defaults.

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

RasterTin

public RasterTin(Object inRaster,
                 Object outTin)

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

inRaster - the input raster.

outTin - the output TIN.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the input raster. This is a required parameter.

Parameters:

inRaster - the input raster.

getOutTin

public Object getOutTin()

Returns the Output TIN parameter of this tool . This parameter is the output TIN. This is a required parameter.

Returns:

the Output TIN

setOutTin

public void setOutTin(Object outTin)

Sets the Output TIN parameter of this tool . This parameter is the output TIN. This is a required parameter.

Parameters:

outTin - the output TIN.

getZTolerance

public double getZTolerance()

Returns the Z Tolerance parameter of this tool . This parameter is the maximum allowable difference in (z units) between the height of the input raster and the height of the output TIN. By default, the z tolerance is 1/10 of the z range of the input raster. This is an optional parameter.

Returns:

the Z Tolerance

setZTolerance

public void setZTolerance(double zTolerance)

Sets the Z Tolerance parameter of this tool . This parameter is the maximum allowable difference in (z units) between the height of the input raster and the height of the output TIN. By default, the z tolerance is 1/10 of the z range of the input raster. This is an optional parameter.

Parameters:

zTolerance - the maximum allowable difference in (z units) between the height of the input raster and the height of the output TIN. By default, the z tolerance is 1/10 of the z range of the input raster.

getMaxPoints

public int getMaxPoints()

Returns the Maximum Number of Points parameter of this tool . This parameter is the maximum number of points that will be added to the TIN before the process is terminated. By default, the process will continue until all the points are added. This is an optional parameter.

Returns:

the Maximum Number of Points

setMaxPoints

public void setMaxPoints(int maxPoints)

Sets the Maximum Number of Points parameter of this tool . This parameter is the maximum number of points that will be added to the TIN before the process is terminated. By default, the process will continue until all the points are added. This is an optional parameter.

Parameters:

maxPoints - the maximum number of points that will be added to the TIN before the process is terminated. By default, the process will continue until all the points are added.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor that the heights of the resultant TIN will be multiplied from those of the input raster. 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 that the heights of the resultant TIN will be multiplied from those of the input raster. Used to convert z units to x and y units. This is an optional parameter.

Parameters:

zFactor - the factor that the heights of the resultant TIN will be multiplied from those of the input raster. 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