com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CreateOrthoCorrectedRasterDataset

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.CreateOrthoCorrectedRasterDataset
All Implemented Interfaces:
GPTool

public class CreateOrthoCorrectedRasterDataset
extends AbstractGPTool

Creates an ortho-corrected raster dataset using the rational polynomial coefficients (RPC) associated with a raster dataset. The Create Ortho Corrected Raster Dataset tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateOrthoCorrectedRasterDataset()
          Creates the Create Ortho Corrected Raster Dataset tool with defaults.
CreateOrthoCorrectedRasterDataset(Object inRaster, Object outRasterDataset, String orthoType, double constantElevation, Object inDEMRaster)
          Creates the Create Ortho Corrected Raster Dataset tool with the required parameters.
 
Method Summary
 double getConstantElevation()
          Returns the Constant Elevation (Meters) parameter of this tool .
 String getGeoid()
          Returns the Geoid parameter of this tool .
 Object getInDEMRaster()
          Returns the DEM Raster parameter of this tool .
 Object getInRaster()
          Returns the Input Raster parameter of this tool .
 String getOrthoType()
          Returns the Orthorectification Type parameter of this tool .
 Object getOutRasterDataset()
          Returns the Output Raster Dataset 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 getZOffset()
          Returns the Z Offset parameter of this tool .
 void setConstantElevation(double constantElevation)
          Sets the Constant Elevation (Meters) parameter of this tool .
 void setGeoid(String geoid)
          Sets the Geoid parameter of this tool .
 void setInDEMRaster(Object inDEMRaster)
          Sets the DEM Raster parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input Raster parameter of this tool .
 void setOrthoType(String orthoType)
          Sets the Orthorectification Type parameter of this tool .
 void setOutRasterDataset(Object outRasterDataset)
          Sets the Output Raster Dataset parameter of this tool .
 void setZFactor(double zFactor)
          Sets the Z Factor parameter of this tool .
 void setZOffset(double zOffset)
          Sets the Z Offset 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

CreateOrthoCorrectedRasterDataset

public CreateOrthoCorrectedRasterDataset()
Creates the Create Ortho Corrected Raster Dataset tool with defaults.

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


CreateOrthoCorrectedRasterDataset

public CreateOrthoCorrectedRasterDataset(Object inRaster,
                                         Object outRasterDataset,
                                         String orthoType,
                                         double constantElevation,
                                         Object inDEMRaster)
Creates the Create Ortho Corrected Raster Dataset 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 - Raster layer, the input raster dataset that you want to ortho-correct.
outRasterDataset - Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality.
orthoType - String, the type of elevation to use in the orthorectification process.
constantElevation - Double, the constant elevation value to be used. If a DEM is used in the ortho-correction process, this constant elevation is not used.
inDEMRaster - Raster layer, the digital elevation model raster dataset to be used for orthorectification.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input Raster parameter of this tool . This parameter is Raster layer, the input raster dataset that you want to ortho-correct. 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 Raster layer, the input raster dataset that you want to ortho-correct. This is a required parameter.

Parameters:
inRaster - Raster layer, the input raster dataset that you want to ortho-correct.

getOutRasterDataset

public Object getOutRasterDataset()
Returns the Output Raster Dataset parameter of this tool . This parameter is Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality. This is a required parameter.

Returns:
the Output Raster Dataset

setOutRasterDataset

public void setOutRasterDataset(Object outRasterDataset)
Sets the Output Raster Dataset parameter of this tool . This parameter is Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality. This is a required parameter.

Parameters:
outRasterDataset - Raster dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality.

getOrthoType

public String getOrthoType()
Returns the Orthorectification Type parameter of this tool . This parameter is String, the type of elevation to use in the orthorectification process. This is a required parameter.

Returns:
the Orthorectification Type

setOrthoType

public void setOrthoType(String orthoType)
Sets the Orthorectification Type parameter of this tool . This parameter is String, the type of elevation to use in the orthorectification process. This is a required parameter.

Parameters:
orthoType - String, the type of elevation to use in the orthorectification process.

getConstantElevation

public double getConstantElevation()
Returns the Constant Elevation (Meters) parameter of this tool . This parameter is Double, the constant elevation value to be used. If a DEM is used in the ortho-correction process, this constant elevation is not used. This is a required parameter.

Returns:
the Constant Elevation (Meters)

setConstantElevation

public void setConstantElevation(double constantElevation)
Sets the Constant Elevation (Meters) parameter of this tool . This parameter is Double, the constant elevation value to be used. If a DEM is used in the ortho-correction process, this constant elevation is not used. This is a required parameter.

Parameters:
constantElevation - Double, the constant elevation value to be used. If a DEM is used in the ortho-correction process, this constant elevation is not used.

getInDEMRaster

public Object getInDEMRaster()
Returns the DEM Raster parameter of this tool . This parameter is Raster layer, the digital elevation model raster dataset to be used for orthorectification. This is a required parameter.

Returns:
the DEM Raster

setInDEMRaster

public void setInDEMRaster(Object inDEMRaster)
Sets the DEM Raster parameter of this tool . This parameter is Raster layer, the digital elevation model raster dataset to be used for orthorectification. This is a required parameter.

Parameters:
inDEMRaster - Raster layer, the digital elevation model raster dataset to be used for orthorectification.

getZFactor

public double getZFactor()
Returns the Z Factor parameter of this tool . This parameter is Double, the scaling factor used to convert the elevation values. This is often used to convert from feet to meters or vice versa. 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 scaling factor used to convert the elevation values. This is often used to convert from feet to meters or vice versa. This is an optional parameter.

Parameters:
zFactor - Double, the scaling factor used to convert the elevation values. This is often used to convert from feet to meters or vice versa.

getZOffset

public double getZOffset()
Returns the Z Offset parameter of this tool . This parameter is Double, the base value to be added to the elevation value in the DEM. This is an optional parameter.

Returns:
the Z Offset

setZOffset

public void setZOffset(double zOffset)
Sets the Z Offset parameter of this tool . This parameter is Double, the base value to be added to the elevation value in the DEM. This is an optional parameter.

Parameters:
zOffset - Double, the base value to be added to the elevation value in the DEM.

getGeoid

public String getGeoid()
Returns the Geoid parameter of this tool . This parameter is String, indicates whether a geoid correction is needed. This is an optional parameter.

Returns:
the Geoid

setGeoid

public void setGeoid(String geoid)
Sets the Geoid parameter of this tool . This parameter is String, indicates whether a geoid correction is needed. This is an optional parameter.

Parameters:
geoid - String, indicates whether a geoid correction is needed.

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