|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.analyst3dtools.TopoToRaster
public class TopoToRaster
Interpolates a hydrologically correct raster raster surface from point, line, and polygon data. The Topo to Raster tool is contained in the 3D Analyst Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
TopoToRaster()
Creates the Topo to Raster tool with defaults. |
|
TopoToRaster(Object inTopoFeatures,
Object outSurfaceRaster)
Creates the Topo to Raster tool with the required parameters. |
Method Summary | |
---|---|
Object |
getCellSize()
Returns the Output cell size parameter of this tool . |
String |
getDataType()
Returns the Primary type of input data parameter of this tool . |
double |
getDiscreteErrorFactor()
Returns the Discretisation error factor parameter of this tool . |
String |
getEnforce()
Returns the Drainage enforcement parameter of this tool . |
Object |
getExtent()
Returns the Output extent parameter of this tool . |
Object |
getInTopoFeatures()
Returns the Input feature data parameter of this tool . |
int |
getMargin()
Returns the Margin in cells parameter of this tool . |
int |
getMaximumIterations()
Returns the Maximum number of iterations parameter of this tool . |
double |
getMaximumZValue()
Returns the Largest z value to be used in interpolation parameter of this tool . |
double |
getMinimumZValue()
Returns the Smallest z value to be used in interpolation parameter of this tool . |
Object |
getOutDiagnosticFile()
Returns the Output diagnostic file parameter of this tool . |
Object |
getOutParameterFile()
Returns the Output 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 . |
double |
getRoughnessPenalty()
Returns the Roughness penalty parameter of this tool . |
double |
getTolerance1()
Returns the Tolerance 1 parameter of this tool . |
double |
getTolerance2()
Returns the Tolerance 2 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 |
getVerticalStandardError()
Returns the Vertical standard error parameter of this tool . |
void |
setCellSize(Object cellSize)
Sets the Output cell size parameter of this tool . |
void |
setDataType(String dataType)
Sets the Primary type of input data parameter of this tool . |
void |
setDiscreteErrorFactor(double discreteErrorFactor)
Sets the Discretisation error factor parameter of this tool . |
void |
setEnforce(String enforce)
Sets the Drainage enforcement parameter of this tool . |
void |
setExtent(Object extent)
Sets the Output extent parameter of this tool . |
void |
setInTopoFeatures(Object inTopoFeatures)
Sets the Input feature data parameter of this tool . |
void |
setMargin(int margin)
Sets the Margin in cells parameter of this tool . |
void |
setMaximumIterations(int maximumIterations)
Sets the Maximum number of iterations parameter of this tool . |
void |
setMaximumZValue(double maximumZValue)
Sets the Largest z value to be used in interpolation parameter of this tool . |
void |
setMinimumZValue(double minimumZValue)
Sets the Smallest z value to be used in interpolation parameter of this tool . |
void |
setOutDiagnosticFile(Object outDiagnosticFile)
Sets the Output diagnostic file parameter of this tool . |
void |
setOutParameterFile(Object outParameterFile)
Sets the Output 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 . |
void |
setRoughnessPenalty(double roughnessPenalty)
Sets the Roughness penalty parameter of this tool . |
void |
setTolerance1(double tolerance1)
Sets the Tolerance 1 parameter of this tool . |
void |
setTolerance2(double tolerance2)
Sets the Tolerance 2 parameter of this tool . |
void |
setVerticalStandardError(double verticalStandardError)
Sets the Vertical standard error 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 |
---|
public TopoToRaster()
Initializes the array of tool parameters with the default values specified when the tool was created.
public TopoToRaster(Object inTopoFeatures, Object outSurfaceRaster)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inTopoFeatures
- the input features containing the z-values to be interpolated into a surface raster. each feature input can have a field specified that contains the z-values, and one of six types specified. there are six types of accepted inputs:outSurfaceRaster
- nullMethod Detail |
---|
public Object getInTopoFeatures()
public void setInTopoFeatures(Object inTopoFeatures)
inTopoFeatures
- the input features containing the z-values to be interpolated into a surface raster. each feature input can have a field specified that contains the z-values, and one of six types specified. there are six types of accepted inputs:public Object getOutSurfaceRaster()
public void setOutSurfaceRaster(Object outSurfaceRaster)
outSurfaceRaster
- nullpublic Object getCellSize()
public void setCellSize(Object cellSize)
cellSize
- the cell size at which the output raster will be created. this will be the value in the environment if it is explicitly set. Otherwise, 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.public Object getExtent()
public void setExtent(Object extent)
extent
- nullpublic int getMargin()
public void setMargin(int margin)
margin
- distance in cells to interpolate beyond the specified output extent and boundary. the value must be greater than or equal to 0 (zero). The default value is 20. if the {extent} and Boundary feature dataset are the same as the limit of the input data (the default), values interpolated along the edge of the DEM will not match well with adjacent DEM data. This is because they have been interpolated using one-half as much data as the points inside the raster, which are surrounded on all sides by input data. The {margin} option allows input data beyond these limits to be used in the interpolation.public double getMinimumZValue()
public void setMinimumZValue(double minimumZValue)
minimumZValue
- the minimum z-value to be used in the interpolation. the default is 20 percent below the smallest of all the input values. This setting should seldom be less than zero (sea level).public double getMaximumZValue()
public void setMaximumZValue(double maximumZValue)
maximumZValue
- the maximum z-value to be used in the interpolation. the default is 20 percent above the largest of all input values.public String getEnforce()
public void setEnforce(String enforce)
enforce
- the type of drainage enforcement to apply. the drainage enforcement option can be set to attempt to remove all sinks or depressions so a hydrologically correct DEM can be created. If sink points have been explicitly identified in the input feature data, these depressions will not be filled.public String getDataType()
public void setDataType(String dataType)
dataType
- the dominant elevation data type of the input feature data. specifying the relevant selection optimizes the search method used during the generation of streams and ridges.public int getMaximumIterations()
public void setMaximumIterations(int maximumIterations)
maximumIterations
- the maximum number of interpolation iterations. the number of iterations must be greater than zero. A default of 40 is normally adequate for both contour and line data. a value of 30 will clear fewer sinks. Rarely, higher values (45-50) may be useful to clear more sinks or to set more ridges and streams. Iteration ceases for each grid resolution when the maximum number of iterations has been reached.public double getRoughnessPenalty()
public void setRoughnessPenalty(double roughnessPenalty)
roughnessPenalty
- the integrated squared second derivative as a measure of roughness. the roughness penalty must be zero or greater. If the primary input data type is CONTOUR, the default is zero. If the primary data type is SPOT, the default is 0.5. Larger values are not normally recommended.public double getDiscreteErrorFactor()
public void setDiscreteErrorFactor(double discreteErrorFactor)
discreteErrorFactor
- the discrete error factor is used to adjust the amount of smoothing when converting the input data to a raster. the value must be greater than zero. The normal range of adjustment is 0.5 to 2, and the default is 1. A smaller value results in less data smoothing; a larger value causes greater smoothing.public double getVerticalStandardError()
public void setVerticalStandardError(double verticalStandardError)
verticalStandardError
- the amount of random error in the z-values of the input data. the value must be zero or greater. The default is zero. the vertical standard error may be set to a small positive value if the data has significant random (nonsystematic) vertical errors with uniform variance. In this case, set the vertical standard error to the standard deviation of these errors. For most elevation datasets, the vertical error should be set to zero, but it may be set to a small positive value to stabilize convergence when gridding point data with stream line data.public double getTolerance1()
public void setTolerance1(double tolerance1)
tolerance1
- this tolerance reflects the accuracy and density of the elevation points in relation to surface drainage. for point datasets, set the tolerance to the standard error of the data heights. For contour datasets, use one-half the average contour interval. the value must be zero or greater. The default is 2.5 if the data type is CONTOUR; zero if the data type is SPOT.public double getTolerance2()
public void setTolerance2(double tolerance2)
tolerance2
- this tolerance prevents drainage clearance through unrealistically high barriers. the value must be greater than zero. The default is 100 if the data type is CONTOUR and 200 if the data type is SPOT.public Object getOutStreamFeatures()
public void setOutStreamFeatures(Object outStreamFeatures)
outStreamFeatures
- the output line feature class of stream polyline features and ridge line features. the line features are created at the beginning of the interpolation process. It provides the general morphology of the surface for interpolation. It can be used to verify correct drainage and morphology by comparing known stream and ridge data.public Object getOutSinkFeatures()
public void setOutSinkFeatures(Object outSinkFeatures)
outSinkFeatures
- the output point feature class of the remaining sink point features. these are the sinks that were not specified in the sink input feature data and were not cleared during drainage enforcement. Adjusting the values of the tolerances, tolerance_1 and tolerance_2, can reduce the number of remaining sinks. Remaining sinks often indicate errors in the input data that the drainage enforcement algorithm could not resolve. This can be an efficient way of detecting subtle elevation errors.public Object getOutDiagnosticFile()
public void setOutDiagnosticFile(Object outDiagnosticFile)
outDiagnosticFile
- the output diagnostic file listing all inputs and parameters used and the number of sinks cleared at each resolution and iteration.public Object getOutParameterFile()
public void setOutParameterFile(Object outParameterFile)
outParameterFile
- the output parameter file listing all inputs and parameters used, which can be used with Topo to Raster by File to run the interpolation again.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |