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

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

All Implemented Interfaces:

GPTool

public class TopoToRasterByFile
extends AbstractGPTool

Interpolates a hydrologically correct raster surface from point, line, and polygon data using parameters specified in a file. The Topo to Raster by File tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The parameter file is structured with the input datasets listed first, followed by the various parameter settings, then the output options.The input data identifies the input datasets and, where applicable, fields. There are six types of input: Contours, Points, Sinks, Streams, Lakes, and Boundaries. You can use as many inputs as you want, within reason. The order in which the inputs are entered does not have any bearing on the outcome. indicates a path to a dataset, indicates a field name, and <#> indicates a value to be entered.The following table lists all of the parameters, the definition of each, and their syntax.ParameterDefinitionSyntaxContoursContour line dataset with item containing height values.PointsPoint dataset with item containing height values.SinksPoint dataset containing sink locations. If the dataset has elevation values for the sinks, specify that field name as the . If only the locations of the sinks are to be used, use NONE for .StreamsStream line dataset. Height values are not necessary.LakesLake polygon dataset. Height values are not necessary.BoundaryBoundary polygon dataset. Height values are not necessary.EnforceControls whether drainage enforcement is applied.DatatypePrimary type of input data.IterationsThe maximum number of iterations the algorithm performs.Roughness PenaltyThe measure of surface roughness.Discretization Error FactorThe amount to adjust the data smoothing of the input data into a raster.Vertical Standard ErrorThe amount of random error in the z-values of the input data.TolerancesThe first reflects the accuracy of elevation data in relation to surface drainage, and the other prevents drainage clearance through unrealistically high barriers.Z-LimitsLower and upper height limits.ExtentMinimum x, minimum y, maximum x, and maximum y coordinate limits.Cell SizeThe resolution of the final output raster.MarginDistance in cells to interpolate beyond the specified output extent and boundary.Output Stream FeaturesOnly use if Output stream polyline features is set in the Topo to Raster by File dialog box.Output Sink FeaturesOnly use if Output remaining sink point features is set in the Topo to Raster by File dialog box.Output Diagnostics FileThe location and name of the diagnostics file.
• Do not specify pathnames for the opional output feature datasets in the parameter file. Use the Output stream polyline features and Output remaining sink point features in the tool dialog box to identify these outputs.
• The contents of an example parameter file are: Contour D:\data\contours2\arc HEIGHT Point D:\data\points2\point SPOTS Sink D:\data\sinks_200.shp Stream D:\data\streams\arc Lake D:\data\lakes\polygon Boundary D:\data\clipcov\polygon ENFORCE ON DATATYPE CONTOUR ITERATIONS 40 ROUGHNESS_PENALTY 0.00000000000 DISCRETE_ERROR_FACTOR 1.00000000000 VERTICAL_STANDARD_ERROR 0.00000000000 TOLERANCES 2.50000000000 100.00000000000 ZLIMITS -2000.00000000000 13000.00000000000 EXTENT -810480.62500000000 8321785.00000000000 810480.62500000000 10140379.00000000000 CELL_SIZE 1800.00000000000 MARGIN 20 OUT_STREAM OUT_SINK OUT_DIAGNOSTICS D:\data\ttr_diag.txt

Field Summary

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

vals

Constructor Summary

TopoToRasterByFile()
Creates the Topo to Raster by File tool with defaults.

TopoToRasterByFile(Object inParameterFile, Object outSurfaceRaster)
Creates the Topo to Raster by File tool with the required parameters.

Method Summary

Object	getInParameterFile() Returns the Input parameter file parameter of this tool .
Object	getOutSinkFeatures() Returns the Output remaining sink point features parameter of this tool .
Object	getOutStreamFeatures() Returns the Output stream polyline features parameter of this tool .
Object	getOutSurfaceRaster() Returns the Output surface raster 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	setInParameterFile(Object inParameterFile) Sets the Input parameter file parameter of this tool .
void	setOutSinkFeatures(Object outSinkFeatures) Sets the Output remaining sink point features parameter of this tool .
void	setOutStreamFeatures(Object outStreamFeatures) Sets the Output stream polyline features parameter of this tool .
void	setOutSurfaceRaster(Object outSurfaceRaster) Sets the Output surface raster 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

TopoToRasterByFile

public TopoToRasterByFile()

Creates the Topo to Raster by File tool with defaults.

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

TopoToRasterByFile

public TopoToRasterByFile(Object inParameterFile,
                          Object outSurfaceRaster)

Creates the Topo to Raster by File 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:

inParameterFile - the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time.

outSurfaceRaster - the output interpolated surface raster.

Method Detail

getInParameterFile

public Object getInParameterFile()

Returns the Input parameter file parameter of this tool . This parameter is the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time. This is a required parameter.

Returns:

the Input parameter file

setInParameterFile

public void setInParameterFile(Object inParameterFile)

Sets the Input parameter file parameter of this tool . This parameter is the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time. This is a required parameter.

Parameters:

inParameterFile - the input ASCII text file containing the inputs and parameters to use for the interpolation. the file is typically created from a previous run of Topo to Raster with the optional output parameter file specified. in order to test the outcome of changing the parameters, it is easier to make edits to this file and rerun the interpolation than to correctly issue the Topo to Raster tool each time.

getOutSurfaceRaster

public Object getOutSurfaceRaster()

Returns the Output surface raster parameter of this tool . This parameter is the output interpolated surface raster. This is a required parameter.

Returns:

the Output surface raster

setOutSurfaceRaster

public void setOutSurfaceRaster(Object outSurfaceRaster)

Sets the Output surface raster parameter of this tool . This parameter is the output interpolated surface raster. This is a required parameter.

Parameters:

outSurfaceRaster - the output interpolated surface raster.

getOutStreamFeatures

public Object getOutStreamFeatures()

Returns the Output stream polyline features parameter of this tool . This parameter is output feature class of stream polyline features. This is an optional parameter.

Returns:

the Output stream polyline features

setOutStreamFeatures

public void setOutStreamFeatures(Object outStreamFeatures)

Sets the Output stream polyline features parameter of this tool . This parameter is output feature class of stream polyline features. This is an optional parameter.

Parameters:

outStreamFeatures - output feature class of stream polyline features.

getOutSinkFeatures

public Object getOutSinkFeatures()

Returns the Output remaining sink point features parameter of this tool . This parameter is output feature class of remaining sink point features. This is an optional parameter.

Returns:

the Output remaining sink point features

setOutSinkFeatures

public void setOutSinkFeatures(Object outSinkFeatures)

Sets the Output remaining sink point features parameter of this tool . This parameter is output feature class of remaining sink point features. This is an optional parameter.

Parameters:

outSinkFeatures - output feature class of remaining sink point features.

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