USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::LroWideAngleCameraDistortionMap Class Reference
[Spice, Instruments, and Cameras]

Distort/undistort focal plane coordinates. More...

#include <LroWideAngleCameraDistortionMap.h>

Inherits Isis::CameraDistortionMap.

List of all members.

Public Member Functions

 LroWideAngleCameraDistortionMap (Camera *parent, int naifIkCode)
 Camera distortion map constructor.
virtual ~LroWideAngleCameraDistortionMap ()
 Destroys the LroWideAngleCameraDistortionMap object.
virtual bool SetFocalPlane (const double dx, const double dy)
 Compute undistorted focal plane x/y.
virtual bool SetUndistortedFocalPlane (const double ux, const double uy)
 Compute distorted focal plane x/y.
void SetFilter (int filter)
void SetDistortion (int naifIkCode)
 Load distortion coefficients.
std::vector< double > OpticalDistortionCoefficients () const
 Return optical distortion polynomial coefficients.
double ZDirection () const
 Return the direction of the focal plane Z-axis.
double FocalPlaneX () const
 Return distorted focal plane x.
double FocalPlaneY () const
 Return distorted focal plane y.
double UndistortedFocalPlaneX () const
 Return undistorted focal plane x.
double UndistortedFocalPlaneY () const
 Return undistorted focal plane y.
double UndistortedFocalPlaneZ () const
 Return undistorted focal plane z.

Protected Attributes

Camera * p_camera
double p_focalPlaneX
double p_focalPlaneY
double p_undistortedFocalPlaneX
double p_undistortedFocalPlaneY
double p_zDirection
std::vector< double > p_odk

Detailed Description

Distort/undistort focal plane coordinates.

Creates a map for adding/removing optical distortions from the focal plane of a camera.

See also:
LroWideAngleCamera
Author:
2008-08-22 Steven Lambright

Constructor & Destructor Documentation

Isis::LroWideAngleCameraDistortionMap::LroWideAngleCameraDistortionMap ( Camera *  parent,
int  naifIkCode 
)

Camera distortion map constructor.

Create a camera distortion map. This class maps between distorted and undistorted focal plane x/y's. The default mapping is the identity, that is, the focal plane x/y and undistorted focal plane x/y will be identical.

Parameters:
parent the parent camera that will use this distortion map
zDirection the direction of the focal plane Z-axis (either 1 or -1)

References Isis::Spice::getDouble(), Isis::CameraDistortionMap::p_camera, Isis::CameraDistortionMap::p_odk, and Isis::toString().

virtual Isis::LroWideAngleCameraDistortionMap::~LroWideAngleCameraDistortionMap (  )  [inline, virtual]

Destroys the LroWideAngleCameraDistortionMap object.

Member Function Documentation

double Isis::CameraDistortionMap::FocalPlaneX (  )  const [inline, inherited]

Return distorted focal plane x.

References Isis::CameraDistortionMap::p_focalPlaneX.

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::Camera::SetRightAscensionDeclination(), and Isis::LineScanCameraSkyMap::SetSky().

double Isis::CameraDistortionMap::FocalPlaneY (  )  const [inline, inherited]

Return distorted focal plane y.

References Isis::CameraDistortionMap::p_focalPlaneY.

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::Camera::SetRightAscensionDeclination(), and Isis::LineScanCameraSkyMap::SetSky().

std::vector< double > Isis::CameraDistortionMap::OpticalDistortionCoefficients (  )  const [inherited]

Return optical distortion polynomial coefficients.

References Isis::CameraDistortionMap::p_odk.

void Isis::CameraDistortionMap::SetDistortion ( int  naifIkCode  )  [inherited]

Load distortion coefficients.

This method loads the distortion coefficients from the instrument kernel. The coefficients in the NAIF instrument kernel are expected to be in the form of:

 INSxxxxx_OD_K = ( coef1, coef2, ..., coefN)

 where xxxxx is the instrument code (always a negative number)

These coefficient will be used to convert from focal plane x,y to undistorted x,y as follows (add equation here)

Parameters:
naifIkCode Code to search for in instrument kernel

Reimplemented in Isis::LoHighDistortionMap, Isis::LoMediumDistortionMap, Isis::LroNarrowAngleDistortionMap, and Isis::TaylorCameraDistortionMap.

References Isis::CameraDistortionMap::p_camera, Isis::CameraDistortionMap::p_odk, and Isis::toString().

Referenced by Isis::CTXCamera::CTXCamera(), and Isis::HiriseCamera::HiriseCamera().

void Isis::LroWideAngleCameraDistortionMap::SetFilter ( int  filter  )  [inline]
bool Isis::LroWideAngleCameraDistortionMap::SetFocalPlane ( const double  dx,
const double  dy 
) [virtual]

Compute undistorted focal plane x/y.

Compute undistorted focal plane x/y given a distorted focal plane x/y.

Parameters:
dx distorted focal plane x in millimeters
dy distorted focal plane y in millimeters
Returns:
if the conversion was successful
See also:
SetDistortion

Reimplemented from Isis::CameraDistortionMap.

References Isis::CameraDistortionMap::p_focalPlaneX, Isis::CameraDistortionMap::p_focalPlaneY, Isis::CameraDistortionMap::p_odk, Isis::CameraDistortionMap::p_undistortedFocalPlaneX, and Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

bool Isis::LroWideAngleCameraDistortionMap::SetUndistortedFocalPlane ( const double  ux,
const double  uy 
) [virtual]

Compute distorted focal plane x/y.

Compute distorted focal plane x/y given an undistorted focal plane x/y.

Parameters:
ux undistorted focal plane x in millimeters
uy undistorted focal plane y in millimeters
Returns:
if the conversion was successful
See also:
SetDistortion

Reimplemented from Isis::CameraDistortionMap.

References Isis::CameraDistortionMap::p_focalPlaneX, Isis::CameraDistortionMap::p_focalPlaneY, Isis::CameraDistortionMap::p_odk, Isis::CameraDistortionMap::p_undistortedFocalPlaneX, Isis::CameraDistortionMap::p_undistortedFocalPlaneY, and tolerance.

double Isis::CameraDistortionMap::UndistortedFocalPlaneX (  )  const [inline, inherited]

Return undistorted focal plane x.

References Isis::CameraDistortionMap::p_undistortedFocalPlaneX.

Referenced by Isis::ControlPoint::ComputeApriori(), and Isis::Camera::SetImage().

double Isis::CameraDistortionMap::UndistortedFocalPlaneY (  )  const [inline, inherited]

Return undistorted focal plane y.

References Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

Referenced by Isis::ControlPoint::ComputeApriori(), and Isis::Camera::SetImage().

double Isis::CameraDistortionMap::UndistortedFocalPlaneZ (  )  const [inline, inherited]

Return undistorted focal plane z.

References Isis::Camera::FocalLength(), Isis::CameraDistortionMap::p_camera, and Isis::CameraDistortionMap::p_zDirection.

Referenced by Isis::CameraGroundMap::GetdXYdOrientation(), Isis::CameraGroundMap::GetdXYdPoint(), Isis::CameraGroundMap::GetdXYdPosition(), Isis::CameraGroundMap::GetXY(), and Isis::Camera::SetImage().

double Isis::CameraDistortionMap::ZDirection (  )  const [inherited]

Return the direction of the focal plane Z-axis.

References Isis::CameraDistortionMap::p_zDirection.

Member Data Documentation

Camera* Isis::CameraDistortionMap::p_camera [protected, inherited]

Referenced by Isis::CameraDistortionMap::CameraDistortionMap(), LroWideAngleCameraDistortionMap(), Isis::MarciDistortionMap::MarciDistortionMap(), Isis::TaylorCameraDistortionMap::SetDistortion(), Isis::LroNarrowAngleDistortionMap::SetDistortion(), Isis::LoMediumDistortionMap::SetDistortion(), Isis::LoHighDistortionMap::SetDistortion(), Isis::CameraDistortionMap::SetDistortion(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), and Isis::CameraDistortionMap::UndistortedFocalPlaneZ().

double Isis::CameraDistortionMap::p_focalPlaneX [protected, inherited]

Referenced by Isis::CameraDistortionMap::FocalPlaneX(), Isis::ThemisVisDistortionMap::SetFocalPlane(), Isis::ThemisIrDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::TaylorCameraDistortionMap::SetFocalPlane(), SetFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::LoHighDistortionMap::SetFocalPlane(), Isis::DawnFcDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::RadialDistortionMap::SetFocalPlane(), Isis::RadarSlantRangeMap::SetFocalPlane(), Isis::CameraDistortionMap::SetFocalPlane(), Isis::ApolloMetricDistortionMap::SetFocalPlane(), Isis::ThemisVisDistortionMap::SetUndistortedFocalPlane(), Isis::ThemisIrDistortionMap::SetUndistortedFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::TaylorCameraDistortionMap::SetUndistortedFocalPlane(), SetUndistortedFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), Isis::DawnFcDistortionMap::SetUndistortedFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::RadialDistortionMap::SetUndistortedFocalPlane(), Isis::RadarSlantRangeMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), and Isis::ApolloMetricDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraDistortionMap::p_focalPlaneY [protected, inherited]

Referenced by Isis::CameraDistortionMap::FocalPlaneY(), Isis::ThemisVisDistortionMap::SetFocalPlane(), Isis::ThemisIrDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::TaylorCameraDistortionMap::SetFocalPlane(), SetFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::LoHighDistortionMap::SetFocalPlane(), Isis::DawnFcDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::RadialDistortionMap::SetFocalPlane(), Isis::RadarSlantRangeMap::SetFocalPlane(), Isis::CameraDistortionMap::SetFocalPlane(), Isis::ApolloMetricDistortionMap::SetFocalPlane(), Isis::ThemisVisDistortionMap::SetUndistortedFocalPlane(), Isis::ThemisIrDistortionMap::SetUndistortedFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::TaylorCameraDistortionMap::SetUndistortedFocalPlane(), SetUndistortedFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), Isis::DawnFcDistortionMap::SetUndistortedFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::RadialDistortionMap::SetUndistortedFocalPlane(), Isis::RadarSlantRangeMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), and Isis::ApolloMetricDistortionMap::SetUndistortedFocalPlane().

std::vector<double> Isis::CameraDistortionMap::p_odk [protected, inherited]

Referenced by LroWideAngleCameraDistortionMap(), Isis::MarciDistortionMap::MarciDistortionMap(), Isis::CameraDistortionMap::OpticalDistortionCoefficients(), Isis::LroNarrowAngleDistortionMap::SetDistortion(), Isis::CameraDistortionMap::SetDistortion(), Isis::MarciDistortionMap::SetFocalPlane(), SetFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::LoHighDistortionMap::SetFocalPlane(), Isis::CameraDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), SetUndistortedFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), and Isis::CameraDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraDistortionMap::p_undistortedFocalPlaneX [protected, inherited]

Referenced by Isis::ThemisVisDistortionMap::SetFocalPlane(), Isis::ThemisIrDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::TaylorCameraDistortionMap::SetFocalPlane(), SetFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::LoHighDistortionMap::SetFocalPlane(), Isis::DawnFcDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::RadialDistortionMap::SetFocalPlane(), Isis::RadarSlantRangeMap::SetFocalPlane(), Isis::CameraDistortionMap::SetFocalPlane(), Isis::ApolloMetricDistortionMap::SetFocalPlane(), Isis::ThemisVisDistortionMap::SetUndistortedFocalPlane(), Isis::ThemisIrDistortionMap::SetUndistortedFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::TaylorCameraDistortionMap::SetUndistortedFocalPlane(), SetUndistortedFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), Isis::DawnFcDistortionMap::SetUndistortedFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::RadialDistortionMap::SetUndistortedFocalPlane(), Isis::RadarSlantRangeMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), Isis::ApolloMetricDistortionMap::SetUndistortedFocalPlane(), and Isis::CameraDistortionMap::UndistortedFocalPlaneX().

double Isis::CameraDistortionMap::p_undistortedFocalPlaneY [protected, inherited]

Referenced by Isis::ThemisVisDistortionMap::SetFocalPlane(), Isis::ThemisIrDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::TaylorCameraDistortionMap::SetFocalPlane(), SetFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::LoHighDistortionMap::SetFocalPlane(), Isis::DawnFcDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::RadialDistortionMap::SetFocalPlane(), Isis::RadarSlantRangeMap::SetFocalPlane(), Isis::CameraDistortionMap::SetFocalPlane(), Isis::ApolloMetricDistortionMap::SetFocalPlane(), Isis::ThemisVisDistortionMap::SetUndistortedFocalPlane(), Isis::ThemisIrDistortionMap::SetUndistortedFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::TaylorCameraDistortionMap::SetUndistortedFocalPlane(), SetUndistortedFocalPlane(), Isis::LroNarrowAngleDistortionMap::SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), Isis::DawnFcDistortionMap::SetUndistortedFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::RadialDistortionMap::SetUndistortedFocalPlane(), Isis::RadarSlantRangeMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), Isis::ApolloMetricDistortionMap::SetUndistortedFocalPlane(), and Isis::CameraDistortionMap::UndistortedFocalPlaneY().

double Isis::CameraDistortionMap::p_zDirection [protected, inherited]

Referenced by Isis::CameraDistortionMap::CameraDistortionMap(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::UndistortedFocalPlaneZ(), and Isis::CameraDistortionMap::ZDirection().

The documentation for this class was generated from the following files: