com.esri.arcgis.geoprocessing.tools.conversiontools
Class DEMToRaster

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.DEMToRaster

All Implemented Interfaces:

GPTool

public class DEMToRaster
extends AbstractGPTool

Converts a digital elevation model (DEM) in a United States Geological Survey (USGS) format to a raster dataset. The DEM to Raster tool is contained in the Conversion Tools tool box.

Usage tips:

• The majority of DEM files are integer. If a floating-point type DEM is converted with the output data type set to INTEGER, the values will be truncated; however, it is not easy to identify if a particular DEM file happens to be floating point. To prevent inadvertent loss of floating-point data when it exists, the default output data type of the raster will be floating point. The only cost is for integer DEMs, where the resulting raster will occupy more disk space than it needs. This can be rectified by subsequently running the Int tool on the raster. If the input dataset is known to be an integer type, then the INTEGER option can be selected instead of the default.
• DEM to Raster applies the spatial resolution value stored in the DEM. In USGS DEMs, this information is stored in Data Element 14 in Logical Record Type A. The spatial resolution value is used to scale all input DEM elevation values.
• The output raster will have square cells if the specified format is ESRI GRID. If the input DEM has a different sample point spacing in the x and y directions, it will be resampled by bilinear interpolation during the conversion process to a cell size equal to the smaller of the point spacings of the DEM in the x or y.
• For output to a GRID raster, the projection and units information contained in the DEM header record is transferred to a map projection file in the output grid directory. If the output raster is a different format, the projection information will be transferred to the .aux file.

Field Summary

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

vals

Constructor Summary

DEMToRaster()
Creates the DEM to Raster tool with defaults.

DEMToRaster(Object inDemFile, Object outRaster)
Creates the DEM to Raster tool with the required parameters.

Method Summary

String	getDataType() Returns the Output data type parameter of this tool .
Object	getInDemFile() Returns the Input USGS DEM file parameter of this tool .
Object	getOutRaster() Returns the Output 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.
double	getZFactor() Returns the Z factor parameter of this tool .
void	setDataType(String dataType) Sets the Output data type parameter of this tool .
void	setInDemFile(Object inDemFile) Sets the Input USGS DEM file parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster 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

DEMToRaster

public DEMToRaster()

Creates the DEM to Raster tool with defaults.

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

DEMToRaster

public DEMToRaster(Object inDemFile,
                   Object outRaster)

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

inDemFile - the input USGS DEM file. The DEM must be standard USGS 7.5 minute, 1 degree, or any other file in the USGS DEM format. The DEM may be in either fixed or variable record-length format.

outRaster - the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format.

Method Detail

getInDemFile

public Object getInDemFile()

Returns the Input USGS DEM file parameter of this tool . This parameter is the input USGS DEM file. The DEM must be standard USGS 7.5 minute, 1 degree, or any other file in the USGS DEM format. The DEM may be in either fixed or variable record-length format. This is a required parameter.

Returns:

the Input USGS DEM file

setInDemFile

public void setInDemFile(Object inDemFile)

Sets the Input USGS DEM file parameter of this tool . This parameter is the input USGS DEM file. The DEM must be standard USGS 7.5 minute, 1 degree, or any other file in the USGS DEM format. The DEM may be in either fixed or variable record-length format. This is a required parameter.

Parameters:

inDemFile - the input USGS DEM file. The DEM must be standard USGS 7.5 minute, 1 degree, or any other file in the USGS DEM format. The DEM may be in either fixed or variable record-length format.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format. 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 dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format. This is a required parameter.

Parameters:

outRaster - the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format.

getDataType

public String getDataType()

Returns the Output data type parameter of this tool . This parameter is data type of the output raster dataset. 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 data type of the output raster dataset. This is an optional parameter.

Parameters:

dataType - data type of the output raster dataset.

getZFactor

public double getZFactor()

Returns the Z factor parameter of this tool . This parameter is the number of ground x,y units in one surface Z-unit. the Z-factor adjusts the units of measure for the Z-units when they are different from the x,y units of the input surface. The Z-values of the input surface are multiplied by the Z-factor when calculating the final output surface. If the x,y units and Z-units are in the same units of measure, the Z-factor is 1. This is the default. If the x,y units and Z-units are in different units of measure, the Z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your Z-units are feet, and your x,y units are meters, you would use a Z-factor of 0.3048 to convert your Z-units from feet to meters (1 foot = 0.3048 meters). 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 number of ground x,y units in one surface Z-unit. the Z-factor adjusts the units of measure for the Z-units when they are different from the x,y units of the input surface. The Z-values of the input surface are multiplied by the Z-factor when calculating the final output surface. If the x,y units and Z-units are in the same units of measure, the Z-factor is 1. This is the default. If the x,y units and Z-units are in different units of measure, the Z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your Z-units are feet, and your x,y units are meters, you would use a Z-factor of 0.3048 to convert your Z-units from feet to meters (1 foot = 0.3048 meters). This is an optional parameter.

Parameters:

zFactor - the number of ground x,y units in one surface Z-unit. the Z-factor adjusts the units of measure for the Z-units when they are different from the x,y units of the input surface. The Z-values of the input surface are multiplied by the Z-factor when calculating the final output surface. If the x,y units and Z-units are in the same units of measure, the Z-factor is 1. This is the default. If the x,y units and Z-units are in different units of measure, the Z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your Z-units are feet, and your x,y units are meters, you would use a Z-factor of 0.3048 to convert your Z-units from feet to meters (1 foot = 0.3048 meters).

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