USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::DawnFcDistortionMap Class Reference

#include <DawnFcDistortionMap.h>

Inherits Isis::CameraDistortionMap.

List of all members.

Public Member Functions

 DawnFcDistortionMap (Camera *parent, double k1, double zDirection=1.0)
 ~DawnFcDistortionMap ()
bool SetFocalPlane (const double ux, const double uy)
 Compute undistorted focal plane x/y.
bool SetUndistortedFocalPlane (const double dx, const double dy)
 Compute distorted focal plane x/y.
void SetDistortion (const int naifIkCode)
 Load distortion coefficients.
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

Camerap_camera
double p_focalPlaneX
double p_focalPlaneY
double p_undistortedFocalPlaneX
double p_undistortedFocalPlaneY
double p_zDirection
std::vector< double > p_odk

Detailed Description

Author:
????-??-?? Unknown

Constructor & Destructor Documentation

Isis::DawnFcDistortionMap::DawnFcDistortionMap ( Camera parent,
double  k1,
double  zDirection = 1.0 
)
Isis::DawnFcDistortionMap::~DawnFcDistortionMap (  )  [inline]

Member Function Documentation

double Isis::CameraDistortionMap::FocalPlaneX (  )  const [inline, inherited]
double Isis::CameraDistortionMap::FocalPlaneY (  )  const [inline, inherited]
void Isis::CameraDistortionMap::SetDistortion ( const 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.

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

bool Isis::DawnFcDistortionMap::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. This virtual method can be used to apply various techniques for removing optical distortion in the focal plane of a camera. The default implementation uses a polynomial distortion if the SetDistortion method is invoked. After calling this method, you can obtain the undistorted x/y via the UndistortedFocalPlaneX and UndistortedFocalPlaneY methods

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 delta, Isis::CameraDistortionMap::p_focalPlaneX, Isis::CameraDistortionMap::p_focalPlaneY, Isis::CameraDistortionMap::p_undistortedFocalPlaneX, and Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

bool Isis::DawnFcDistortionMap::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. This virtual method is used to apply various techniques for adding optical distortion in the focal plane of a camera. The default implementation of this virtual method uses a polynomial distortion if the SetDistortion method was invoked. After calling this method, you can obtain the distorted x/y via the FocalPlaneX and FocalPlaneY methods

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_undistortedFocalPlaneX, and Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

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

Member Data Documentation

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

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