USGS

Isis 3.0 Object Programmers' Reference

 Home
Public Member Functions | Protected Attributes | Private Attributes | List of all members
Isis::KaguyaMiCameraDistortionMap Class Reference
Spice, Instruments, and Cameras

Distort/undistort focal plane coordinates. More...

#include <KaguyaMiCameraDistortionMap.h>

Inheritance diagram for Isis::KaguyaMiCameraDistortionMap:
Inheritance graph
Collaboration diagram for Isis::KaguyaMiCameraDistortionMap:
Collaboration graph

Public Member Functions

 KaguyaMiCameraDistortionMap (Camera *parent)
 Camera distortion map constructor.
 
virtual ~KaguyaMiCameraDistortionMap ()
 Destroys the KaguyaMiCameraDistortionMap object.
 
void SetDistortion (const int naifIkCode)
 
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.
 
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
 

Private Attributes

double m_distCoefX [4]
 
double m_distCoefY [4]
 
double m_boreX
 
double m_boreY
 
int m_numDistCoef
 

Detailed Description

Distort/undistort focal plane coordinates.

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

See Also
KaguyaMiCamera
Author
2012-06-20 Orrin Thomas
History:

2020-06-20 Orrin Thomas - Original Version

2012-07-06 Debbie A. Cook, Updated Spice members to be more compliant with Isis coding standards. References #972.

Definition at line 45 of file KaguyaMiCameraDistortionMap.h.

Constructor & Destructor Documentation

Isis::KaguyaMiCameraDistortionMap::KaguyaMiCameraDistortionMap ( Camera *  parent)

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
parentthe parent camera that will use this distortion map
zDirectionthe direction of the focal plane Z-axis (either 1 or -1)

Definition at line 44 of file KaguyaMiCameraDistortionMap.cpp.

virtual Isis::KaguyaMiCameraDistortionMap::~KaguyaMiCameraDistortionMap ( )
inlinevirtual

Destroys the KaguyaMiCameraDistortionMap object.

Definition at line 50 of file KaguyaMiCameraDistortionMap.h.

Member Function Documentation

double Isis::CameraDistortionMap::FocalPlaneX ( ) const
inlineinherited

Return distorted focal plane x.

Definition at line 72 of file CameraDistortionMap.h.

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

double Isis::CameraDistortionMap::FocalPlaneY ( ) const
inlineinherited

Return distorted focal plane y.

Definition at line 77 of file CameraDistortionMap.h.

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

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

Return optical distortion polynomial coefficients.

Definition at line 195 of file CameraDistortionMap.cpp.

void Isis::KaguyaMiCameraDistortionMap::SetDistortion ( const int  naifIkCode)
Parameters
naifIkCode

Definition at line 50 of file KaguyaMiCameraDistortionMap.cpp.

References Isis::Spice::getDouble(), Isis::Camera::PixelPitch(), and Isis::toString().

Referenced by Isis::KaguyaMiCamera::KaguyaMiCamera().

bool Isis::KaguyaMiCameraDistortionMap::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
dxdistorted focal plane x in millimeters
dydistorted focal plane y in millimeters
Returns
if the conversion was successful
See Also
SetDistortion

Reimplemented from Isis::CameraDistortionMap.

Definition at line 79 of file KaguyaMiCameraDistortionMap.cpp.

bool Isis::KaguyaMiCameraDistortionMap::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
uxundistorted focal plane x in millimeters
uyundistorted focal plane y in millimeters
Returns
if the conversion was successful
See Also
SetDistortion

Reimplemented from Isis::CameraDistortionMap.

Definition at line 121 of file KaguyaMiCameraDistortionMap.cpp.

References Isis::FunctionTools::realCubicRoots(), and Isis::FunctionTools::realQuadraticRoots().

double Isis::CameraDistortionMap::UndistortedFocalPlaneX ( ) const
inlineinherited

Return undistorted focal plane x.

Definition at line 82 of file CameraDistortionMap.h.

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

double Isis::CameraDistortionMap::UndistortedFocalPlaneY ( ) const
inlineinherited

Return undistorted focal plane y.

Definition at line 87 of file CameraDistortionMap.h.

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

double Isis::CameraDistortionMap::UndistortedFocalPlaneZ ( ) const
inlineinherited

Return undistorted focal plane z.

Definition at line 92 of file CameraDistortionMap.h.

References Isis::Camera::FocalLength().

Referenced by Isis::BundleAdjust::ApproximatePoint_ClosestApproach(), and Isis::Camera::SetImage().

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

Return the direction of the focal plane Z-axis.

Definition at line 201 of file CameraDistortionMap.cpp.

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