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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.
Learn more about how DEM To Raster tool works

Software restrictions: none

Usage tips:


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 - File, 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 - Raster Dataset, 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 file format.
Method Detail

getInDemFile

public Object getInDemFile()
Returns the Input USGS DEM file parameter of this tool . This parameter is File, 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 File, 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 - File, 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 Raster Dataset, 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 file 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 Raster Dataset, 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 file format. This is a required parameter.

Parameters:
outRaster - Raster Dataset, 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 file format.

getDataType

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

Parameters:
dataType - String, data type of the output raster dataset.

getZFactor

public double getZFactor()
Returns the Z factor parameter of this tool . This parameter is Double, 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 Double, 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 - Double, 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