com.esri.arcgis.datasourcesraster
Interface ISensorXform

All Superinterfaces:

Serializable

All Known Implementing Classes:

ApproximationXform, CompositeXform, CSMXform, Formosat2Xform, FrameXform, RPCXform, SPOT5Xform

public interface ISensorXform
extends Serializable

Provides access to members that control sensor specific geodata transform.

Remarks

The ISensorXform interface is used to set the elevation information for RPCXform object to create orthorectified image.

You can specify the elevation using a DEM or a constant value that represent an average elevation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

double	getConstantZ() The constant Z value in meters.
IRaster	getDEM() The Digital Elevation Model (DEM).
double	getZFactor() The conversion factor from DEM Z unit to meters.
double	getZOffset() The Z offset in meters applied to DEM.
boolean	isCorrectGeoid() Indicates if Geoid correction is needed.
boolean	isRequireDEM() Indicates if DEM is required for applying this transform.
void	setConstantZ(double z) The constant Z value in meters.
void	setCorrectGeoid(boolean pCorrection) Indicates if Geoid correction is needed.
void	setDEMByRef(IRaster ppDEM) The Digital Elevation Model (DEM).
void	setRequireDEM(boolean pRequireDEM) Indicates if DEM is required for applying this transform.
void	setZFactor(double zFactor) The conversion factor from DEM Z unit to meters.
void	setZOffset(double zOffset) The Z offset in meters applied to DEM.

Method Detail

getConstantZ

double getConstantZ()
                    throws IOException,
                           AutomationException

The constant Z value in meters.

Remarks

This property can be used to set a constant elevation across the image when DEM method is not used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The z

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstantZ

void setConstantZ(double z)
                  throws IOException,
                         AutomationException

The constant Z value in meters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

z - The z (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFactor

double getZFactor()
                  throws IOException,
                         AutomationException

The conversion factor from DEM Z unit to meters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The zFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFactor

void setZFactor(double zFactor)
                throws IOException,
                       AutomationException

The conversion factor from DEM Z unit to meters.

Remarks

A factor that converts the unit of the DEM to meter

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

zFactor - The zFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZOffset

double getZOffset()
                  throws IOException,
                         AutomationException

The Z offset in meters applied to DEM.

Remarks

If the DEM data used is not based on sea level, this property can be used to do the adjustment.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The zOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZOffset

void setZOffset(double zOffset)
                throws IOException,
                       AutomationException

The Z offset in meters applied to DEM.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

zOffset - The zOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDEM

IRaster getDEM()
               throws IOException,
                      AutomationException

The Digital Elevation Model (DEM).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDEMByRef

void setDEMByRef(IRaster ppDEM)
                 throws IOException,
                        AutomationException

The Digital Elevation Model (DEM).

Remarks

Set the DEM to be used in orthorectification.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppDEM - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRequireDEM

boolean isRequireDEM()
                     throws IOException,
                            AutomationException

Indicates if DEM is required for applying this transform.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pRequireDEM

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRequireDEM

void setRequireDEM(boolean pRequireDEM)
                   throws IOException,
                          AutomationException

Indicates if DEM is required for applying this transform.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pRequireDEM - The pRequireDEM (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCorrectGeoid

boolean isCorrectGeoid()
                       throws IOException,
                              AutomationException

Indicates if Geoid correction is needed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pCorrection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCorrectGeoid

void setCorrectGeoid(boolean pCorrection)
                     throws IOException,
                            AutomationException

Indicates if Geoid correction is needed.

Remarks

If the property is set to true, the DEM used in orthorectification will be corrected to use the true elevation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pCorrection - The pCorrection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.