Distort/undistort focal plane coordinates. More...

#include <MarciDistortionMap.h>

Inheritance diagram for Isis::MarciDistortionMap:

Collaboration diagram for Isis::MarciDistortionMap:

Public Member Functions
	MarciDistortionMap (Camera *parent, int naifIkCode)
	Camera distortion map constructor.

virtual	~MarciDistortionMap ()
	Destructor.

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

Private Member Functions
double	GuessDx (double uX)

Private Attributes
int	p_filter

Detailed Description

Distort/undistort focal plane coordinates.

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

See Also: MarciCamera

Author: 2008-08-22 Steven Lambright

History:

2011-05-03 Jeannie Walldren - Updated documentation.

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

Definition at line 48 of file MarciDistortionMap.h.

Constructor & Destructor Documentation

Isis::MarciDistortionMap::MarciDistortionMap	(	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)

Definition at line 41 of file MarciDistortionMap.cpp.

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

virtual Isis::MarciDistortionMap::~MarciDistortionMap ( )

inlinevirtual

Destructor.

Definition at line 53 of file MarciDistortionMap.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::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

Todo:

Generalize to read variable number of coefficients

Add latex equation to the documentation

Definition at line 65 of file CameraDistortionMap.cpp.

References Isis::toString().

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::CTXCamera::CTXCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::LroWideAngleCameraDistortionMap::LroWideAngleCameraDistortionMap(), Isis::LoHighDistortionMap::SetDistortion(), and Isis::LoMediumDistortionMap::SetDistortion().

bool Isis::MarciDistortionMap::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

Todo:: Generalize polynomial equation

Reimplemented from Isis::CameraDistortionMap.

Definition at line 60 of file MarciDistortionMap.cpp.

References Isis::E(), and Isis::Camera::PixelPitch().

bool Isis::MarciDistortionMap::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

Todo:

Generalize polynomial equation

Figure out a better solution for divergence condition

Reimplemented from Isis::CameraDistortionMap.

Definition at line 108 of file MarciDistortionMap.cpp.

References Isis::E(), and Isis::Camera::PixelPitch().

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:

src/mro/objs/MarciCamera/MarciDistortionMap.h
src/mro/objs/MarciCamera/MarciDistortionMap.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation