Distort/undistort focal plane coordinates. More...

#include <ReseauDistortionMap.h>

Inheritance diagram for Isis::ReseauDistortionMap:

Collaboration diagram for Isis::ReseauDistortionMap:

Public Member Functions
	ReseauDistortionMap (Camera *parent, Pvl &labels, const QString &fname)
	Creates a ReseauDistortionMap object.

virtual bool	SetFocalPlane (const double dx, const double dy)
	Finds the undistorted x/y position of the given distorted point.

virtual bool	SetUndistortedFocalPlane (const double ux, const double uy)
	Finds the distorted x/y position of the given undistorted point.

virtual void	SetDistortion (int naifIkCode)
	Load distortion coefficients.

std::vector< double >	OpticalDistortionCoefficients () const
	Retrieve the distortion coefficients used for this model.

double	ZDirection () const
	Gets the z-direction for this camera.

double	FocalPlaneX () const
	Gets the x-value in the focal plane coordinate system.

double	FocalPlaneY () const
	Gets the y-value in the focal plane coordinate system.

double	UndistortedFocalPlaneX () const
	Gets the x-value in the undistorted focal plane coordinate system.

double	UndistortedFocalPlaneY () const
	Gets the y-value in the undistorted focal plane coordinate system.

double	UndistortedFocalPlaneZ () const
	Gets the z-value in the undistorted focal plane coordinate system.

Protected Attributes
Camera *	p_camera
	The camera to distort/undistort.

double	p_focalPlaneX
	Distorted focal plane x.

double	p_focalPlaneY
	Distorted focal plane y.

double	p_undistortedFocalPlaneX
	Undistorted focal plane x.

double	p_undistortedFocalPlaneY
	Undistorted focal plane y.

double	p_zDirection
	Undistorted focal plane z.

std::vector< double >	p_odk = {}
	Vector of distortion coefficients.

Detailed Description

Distort/undistort focal plane coordinates.

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

Author: 2005-06-08 Elizabeth Ribelin

Constructor & Destructor Documentation

◆ ReseauDistortionMap()

Isis::ReseauDistortionMap::ReseauDistortionMap	(	Camera *	parent,
		Pvl &	labels,
		const QString &	fname )

Creates a ReseauDistortionMap object.

Parameters

parent	The parent camera model
labels	The pvl labels to get the Reference Reseau location from
fname	The filename containing master reseau location for the particular camera

Exceptions

Isis::IException::User - There are not the same amount of master and refined reseaus

References _FILEINFO_, Isis::Camera::PixelPitch(), Isis::toDouble(), Isis::PvlObject::Traverse, and Isis::IException::User.

Member Function Documentation

◆ FocalPlaneX()

double Isis::CameraDistortionMap::FocalPlaneX ( ) const

inherited

Gets the x-value in the focal plane coordinate system.

This is represented in millimeters from the origin.

Returns: The distorted focal plane x.

References Isis::CameraDistortionMap::p_focalPlaneX.

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

◆ FocalPlaneY()

double Isis::CameraDistortionMap::FocalPlaneY ( ) const

inherited

Gets the y-value in the focal plane coordinate system.

This is represented in millimeters from the origin.

Returns: The distorted focal plane y.

References Isis::CameraDistortionMap::p_focalPlaneY.

Referenced by Isis::Camera::SetRightAscensionDeclination().

◆ OpticalDistortionCoefficients()

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

inherited

Retrieve the distortion coefficients used for this model.

Returns: The optical distortion of polynomial coefficients.

References Isis::CameraDistortionMap::p_odk.

◆ SetDistortion()

void Isis::CameraDistortionMap::SetDistortion ( int naifIkCode )

virtualinherited

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::KaguyaMiCameraDistortionMap, Isis::LoHighDistortionMap, Isis::LoMediumDistortionMap, Isis::LroNarrowAngleDistortionMap, Isis::TaylorCameraDistortionMap, Isis::JunoDistortionMap, and Isis::OsirisRexOcamsDistortionMap.

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

Referenced by Isis::LoHighDistortionMap::SetDistortion(), and Isis::LoMediumDistortionMap::SetDistortion().

◆ SetFocalPlane()

bool Isis::ReseauDistortionMap::SetFocalPlane	(	const double	dx,
		const double	dy )

virtual

Finds the undistorted x/y position of the given distorted point.

Parameters

dx	The distorted x position of the point
dy	The distorted y position of the point

Returns: bool Returns true if the undistortion was completed successful, and false if it was not

Reimplemented from Isis::CameraDistortionMap.

References Isis::CameraFocalPlaneMap::DetectorLineOrigin(), Isis::CameraFocalPlaneMap::DetectorSampleOrigin(), Isis::Camera::FocalPlaneMap(), Isis::CameraDistortionMap::p_camera, Isis::CameraDistortionMap::p_focalPlaneX, Isis::CameraDistortionMap::p_focalPlaneY, Isis::CameraDistortionMap::p_undistortedFocalPlaneX, and Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

◆ SetUndistortedFocalPlane()

bool Isis::ReseauDistortionMap::SetUndistortedFocalPlane	(	const double	ux,
		const double	uy )

virtual

Finds the distorted x/y position of the given undistorted point.

Parameters

ux	The undistorted x position of the point
uy	The undistorted y position of the point

Returns: bool Returns true if the distortion was completed successful, and false if it was not

Reimplemented from Isis::CameraDistortionMap.

References Isis::CameraFocalPlaneMap::DetectorLineOrigin(), Isis::CameraFocalPlaneMap::DetectorSampleOrigin(), Isis::Camera::FocalPlaneMap(), Isis::CameraDistortionMap::p_camera, Isis::CameraDistortionMap::p_focalPlaneX, Isis::CameraDistortionMap::p_focalPlaneY, Isis::CameraDistortionMap::p_undistortedFocalPlaneX, and Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

◆ UndistortedFocalPlaneX()

double Isis::CameraDistortionMap::UndistortedFocalPlaneX ( ) const

inherited

Gets the x-value in the undistorted focal plane coordinate system.

This is represented in millimeters from the origin.

Returns: The undistorted focal plane x

References Isis::CameraDistortionMap::p_undistortedFocalPlaneX.

Referenced by Isis::LidarControlPoint::ComputeResiduals(), Isis::Camera::SetImage(), and Isis::Camera::SetImage().

◆ UndistortedFocalPlaneY()

double Isis::CameraDistortionMap::UndistortedFocalPlaneY ( ) const

inherited

Gets the y-value in the undistorted focal plane coordinate system.

This is represented in millimeters from the origin.

Returns: The undistorted focal plane y

References Isis::CameraDistortionMap::p_undistortedFocalPlaneY.

Referenced by Isis::LidarControlPoint::ComputeResiduals(), Isis::Camera::SetImage(), and Isis::Camera::SetImage().

◆ UndistortedFocalPlaneZ()

double Isis::CameraDistortionMap::UndistortedFocalPlaneZ ( ) const

inherited

Gets the z-value in the undistorted focal plane coordinate system.

This is represented as the focal length, in millimeters, with the sign indicating z-direction.

Returns: The 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::GetdXYdTOrientation(), Isis::CameraGroundMap::GetXY(), Isis::CameraGroundMap::LookCtoFocalPlaneXY(), Isis::Camera::SetImage(), and Isis::Camera::SetImage().

◆ ZDirection()

double Isis::CameraDistortionMap::ZDirection ( ) const

inherited

Gets the z-direction for this camera.

The direction is represented as +/- 1.

Returns: The direction of the focal plane Z-axis

References Isis::CameraDistortionMap::p_zDirection.

Member Data Documentation

◆ p_camera

Camera* Isis::CameraDistortionMap::p_camera

protectedinherited

The camera to distort/undistort.

Referenced by Isis::LroWideAngleCameraDistortionMap::addFilter(), Isis::CameraDistortionMap::CameraDistortionMap(), Isis::OsirisRexTagcamsDistortionMap::distortion_to_pointing_frame(), Isis::KaguyaTcCameraDistortionMap::KaguyaTcCameraDistortionMap(), Isis::MarciDistortionMap::MarciDistortionMap(), Isis::NewHorizonsMvicFrameCameraDistortionMap::NewHorizonsMvicFrameCameraDistortionMap(), Isis::NewHorizonsMvicTdiCameraDistortionMap::NewHorizonsMvicTdiCameraDistortionMap(), Isis::OsirisRexDistortionMap::OsirisRexDistortionMap(), Isis::OsirisRexOcamsDistortionMap::OsirisRexOcamsDistortionMap(), Isis::OsirisRexTagcamsDistortionMap::pointing_to_distortion_frame(), Isis::KaguyaMiCameraDistortionMap::SetDistortion(), Isis::LoHighDistortionMap::SetDistortion(), Isis::LoMediumDistortionMap::SetDistortion(), Isis::LroNarrowAngleDistortionMap::SetDistortion(), Isis::TaylorCameraDistortionMap::SetDistortion(), Isis::CameraDistortionMap::SetDistortion(), Isis::JunoDistortionMap::SetDistortion(), Isis::OsirisRexOcamsDistortionMap::SetDistortion(), Isis::OsirisRexDistortionMap::SetDistortion(), SetFocalPlane(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::JunoDistortionMap::SetFocalPlane(), Isis::OsirisRexOcamsDistortionMap::SetFocalPlane(), SetUndistortedFocalPlane(), Isis::LoMediumDistortionMap::SetUndistortedFocalPlane(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), Isis::Hyb2OncDistortionMap::SetUndistortedFocalPlane(), Isis::OsirisRexOcamsDistortionMap::SetUndistortedFocalPlane(), Isis::TgoCassisDistortionMap::TgoCassisDistortionMap(), and Isis::CameraDistortionMap::UndistortedFocalPlaneZ().

◆ p_focalPlaneX

double Isis::CameraDistortionMap::p_focalPlaneX

protectedinherited

Distorted focal plane x.

◆ p_focalPlaneY

double Isis::CameraDistortionMap::p_focalPlaneY

protectedinherited

Distorted focal plane y.

◆ p_odk

std::vector<double> Isis::CameraDistortionMap::p_odk = {}

protectedinherited

Vector of distortion coefficients.

◆ p_undistortedFocalPlaneX

double Isis::CameraDistortionMap::p_undistortedFocalPlaneX

protectedinherited

Undistorted focal plane x.

◆ p_undistortedFocalPlaneY

double Isis::CameraDistortionMap::p_undistortedFocalPlaneY

protectedinherited

Undistorted focal plane y.

◆ p_zDirection

double Isis::CameraDistortionMap::p_zDirection

protectedinherited

Undistorted focal plane z.

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

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

/Users/acpaquette/repos/ISIS3/isis/src/base/objs/ReseauDistortionMap/ReseauDistortionMap.h
/Users/acpaquette/repos/ISIS3/isis/src/base/objs/ReseauDistortionMap/ReseauDistortionMap.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ReseauDistortionMap()

Member Function Documentation

◆ FocalPlaneX()

◆ FocalPlaneY()

◆ OpticalDistortionCoefficients()

◆ SetDistortion()

◆ SetFocalPlane()

◆ SetUndistortedFocalPlane()

◆ UndistortedFocalPlaneX()

◆ UndistortedFocalPlaneY()

◆ UndistortedFocalPlaneZ()

◆ ZDirection()

Member Data Documentation

◆ p_camera

◆ p_focalPlaneX

◆ p_focalPlaneY

◆ p_odk

◆ p_undistortedFocalPlaneX

◆ p_undistortedFocalPlaneY

◆ p_zDirection