Isis::RadarGroundRangeMap Class Reference

Construct a mapping between image sample and Radar ground range. More...

#include <RadarGroundRangeMap.h>

Inheritance diagram for Isis::RadarGroundRangeMap:

[legend]

Collaboration diagram for Isis::RadarGroundRangeMap:

[legend]

List of all members.

Public Types
enum	FocalPlaneXDependencyType { Sample = 1, Line = 2 }
	Focal plane x dependency indicates whether the x value of the focal plane coordinate maps to a sample or a line. More...
Public Member Functions
	RadarGroundRangeMap (Camera *parent, const int naifIkCode)
	Construct mapping between detectors and focal plane x/y.
virtual bool	SetDetector (const double sample, const double line)
	Compute distorted focal plane coordinate from detector position.
virtual bool	SetFocalPlane (const double dx, const double dy)
	Compute detector position from focal plane coordinate.
double	FocalPlaneX () const
	Return distorted focal plane x.
double	FocalPlaneY () const
	Return distorted focal plane y.
double	DetectorSample () const
	Return detector sample.
double	DetectorLine () const
	Return detector line.
double	CenteredDetectorSample () const
	Return centered detector sample.
double	CenteredDetectorLine () const
	Return centered detector line.
void	SetDetectorOrigin (const double sample, const double line)
	Set the detector origin.
double	DetectorLineOrigin () const
	Return detector line origin.
double	DetectorSampleOrigin () const
	Return detector sample origin.
void	SetDetectorOffset (const double sampleOffset, const double lineOffset)
	Set the detector offset.
double	DetectorLineOffset () const
	Return detector line offset.
double	DetectorSampleOffset () const
	Return detector sample offset.
const double *	TransX () const
const double *	TransY () const
const double *	TransS () const
const double *	TransL () const
int	FocalPlaneXDependency ()
	Return the focal plane x dependency variable.
double	SignMostSigX ()
	Return the sign of the p_transx coefficient with the greatest magnitude.
double	SignMostSigY ()
	Return the sign of the p_transy coefficient with the greatest magnitude.
Static Public Member Functions
static void	setTransform (int naifIkCode, double groundRangeResolution, int samples, Radar::LookDirection ldir)
Protected Member Functions
void	ComputeCentered ()
	Convenience method to center detector origin (use when inheriting).
void	ComputeUncentered ()
	Convenience method to center detector origin (use when inheriting).
Protected Attributes
Camera *	p_camera
double	p_detectorLineOrigin
double	p_detectorSampleOrigin
double	p_focalPlaneX
	x value of focal plane coordinate
double	p_focalPlaneY
	y value of focal plane coordinate
double	p_detectorLine
	line value of the detector
double	p_detectorSample
	sample value of the detector
double	p_centeredDetectorSample
double	p_centeredDetectorLine
double	p_detectorLineOffset
double	p_detectorSampleOffset
double	p_transx [3]
double	p_transy [3]
double	p_itranss [3]
double	p_itransl [3]

Detailed Description

Construct a mapping between image sample and Radar ground range.

See also:: Camera

Author:: 2008-06-17 Jeff Anderson Original version

For internal use only.

History:: 2009-07-01 Janet Barrett - Corrected the transformation calculations

Definition at line 54 of file RadarGroundRangeMap.h.

Member Enumeration Documentation

enum Isis::CameraFocalPlaneMap::FocalPlaneXDependencyType [inherited]

Focal plane x dependency indicates whether the x value of the focal plane coordinate maps to a sample or a line.

Enumerator:

Sample	The x value of the focal plane maps to a sample.
Line	The x value of the focal plane maps to a line.

Definition at line 123 of file CameraFocalPlaneMap.h.

Constructor & Destructor Documentation

Isis::RadarGroundRangeMap::RadarGroundRangeMap	(	Camera *	parent,
		const int	naifIkCode
	)

Construct mapping between detectors and focal plane x/y.

Parameters:

	parent	parent camera that will use this map
	naifIkCode	code of the naif instrument for reading coefficients

Definition at line 32 of file RadarGroundRangeMap.cpp.

Member Function Documentation

double Isis::CameraFocalPlaneMap::CenteredDetectorLine ( ) const [inherited]

Return centered detector line.

Definition at line 220 of file CameraFocalPlaneMap.cpp.

double Isis::CameraFocalPlaneMap::CenteredDetectorSample ( ) const [inherited]

Return centered detector sample.

Definition at line 215 of file CameraFocalPlaneMap.cpp.

void Isis::CameraFocalPlaneMap::ComputeCentered ( ) [protected, inherited]

Convenience method to center detector origin (use when inheriting).

Definition at line 286 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::p_detectorLine, and Isis::CameraFocalPlaneMap::p_detectorSample.

Referenced by Isis::CameraFocalPlaneMap::SetDetector().

void Isis::CameraFocalPlaneMap::ComputeUncentered ( ) [protected, inherited]

Convenience method to center detector origin (use when inheriting).

Definition at line 292 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::p_detectorLine, and Isis::CameraFocalPlaneMap::p_detectorSample.

Referenced by Isis::CameraFocalPlaneMap::SetFocalPlane().

double Isis::CameraFocalPlaneMap::DetectorLine ( ) const [inherited]

Return detector line.

Definition at line 210 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::p_detectorLine.

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::PushFrameCameraGroundMap::FindDistance(), LineOffsetFunctor::operator()(), Isis::Camera::RawFocalPlanetoImage(), Isis::LoMediumDistortionMap::SetDistortion(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetRightAscensionDeclination(), Isis::LineScanCameraSkyMap::SetSky(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraFocalPlaneMap::DetectorLineOffset ( ) const [inherited]

Return detector line offset.

Definition at line 264 of file CameraFocalPlaneMap.cpp.

Referenced by LineOffsetFunctor::operator()(), Isis::VariableLineScanCameraDetectorMap::SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), and Isis::LineScanCameraSkyMap::SetSky().

double Isis::CameraFocalPlaneMap::DetectorLineOrigin ( ) const [inherited]

Return detector line origin.

Definition at line 239 of file CameraFocalPlaneMap.cpp.

Referenced by Isis::ReseauDistortionMap::SetFocalPlane(), and Isis::ReseauDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraFocalPlaneMap::DetectorSample ( ) const [inherited]

Return detector sample.

Definition at line 205 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::p_detectorSample.

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::PushFrameCameraGroundMap::FindDistance(), Isis::Camera::RawFocalPlanetoImage(), Isis::LoMediumDistortionMap::SetDistortion(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetRightAscensionDeclination(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraFocalPlaneMap::DetectorSampleOffset ( ) const [inherited]

Return detector sample offset.

Definition at line 269 of file CameraFocalPlaneMap.cpp.

double Isis::CameraFocalPlaneMap::DetectorSampleOrigin ( ) const [inherited]

Return detector sample origin.

Definition at line 244 of file CameraFocalPlaneMap.cpp.

Referenced by Isis::ReseauDistortionMap::SetFocalPlane(), and Isis::ReseauDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraFocalPlaneMap::FocalPlaneX ( ) const [inherited]

Return distorted focal plane x.

Definition at line 195 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::p_focalPlaneX.

Referenced by Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetImage(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

int Isis::CameraFocalPlaneMap::FocalPlaneXDependency ( ) [inherited]

Return the focal plane x dependency variable.

This method returns the image variable (sample or line) on which the focal plane x depends.

Returns:: dependency variable

Definition at line 140 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::Line, and Isis::CameraFocalPlaneMap::Sample.

double Isis::CameraFocalPlaneMap::FocalPlaneY ( ) const [inherited]

Return distorted focal plane y.

Definition at line 200 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::p_focalPlaneY.

Referenced by Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetImage(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

bool Isis::CameraFocalPlaneMap::SetDetector	(	const double	sample,
		const double	line
	)			`[virtual, inherited]`

Compute distorted focal plane coordinate from detector position.

This method will compute both the distorted focal plane x/y and centered detector position given a detector position

Parameters:

	sample	undistorted focal plane x in millimeters
	line	undistorted focal plane y in millimeters

Returns:: conversion was successful

Definition at line 121 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::ComputeCentered(), Isis::CameraFocalPlaneMap::p_detectorLine, Isis::CameraFocalPlaneMap::p_detectorSample, Isis::CameraFocalPlaneMap::p_focalPlaneX, and Isis::CameraFocalPlaneMap::p_focalPlaneY.

Referenced by Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetImage(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

void Isis::CameraFocalPlaneMap::SetDetectorOffset	(	const double	sampleOffset,
		const double	lineOffset
	)			`[inherited]`

Set the detector offset.

This is used to set the offset between the detector origin and the average location in detector pixels where the image is being viewed. If not set the offset are both 0.0

Parameters:

	sampleOffset	sample offset in pixels
	lineOffset	sample offset in lines

Definition at line 257 of file CameraFocalPlaneMap.cpp.

Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::ThemisIrCamera::SetBand(), and Isis::ThemisIrCamera::ThemisIrCamera().

void Isis::CameraFocalPlaneMap::SetDetectorOrigin	(	const double	sample,
		const double	line
	)			`[inherited]`

Set the detector origin.

This is used to set the origin of the detector. Typically the middle of the detector. For example, a 512x512 dectector would have the origin at (256.5,256.5). If not set both are 0.

Parameters:

	sample	detector sample at the origin
	line	detector line at the origin

Definition at line 233 of file CameraFocalPlaneMap.cpp.

Referenced by Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IdealCamera::IdealCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::Mariner10Camera::Mariner10Camera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::NirCamera::NirCamera(), Isis::ThemisIrCamera::SetBand(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::UvvisCamera::UvvisCamera(), Isis::VikingCamera::VikingCamera(), and Isis::VoyagerCamera::VoyagerCamera().

bool Isis::CameraFocalPlaneMap::SetFocalPlane	(	const double	dx,
		const double	dy
	)			`[virtual, inherited]`

Compute detector position from focal plane coordinate.

This method will compute both the centered and normal detector position given a distorted focal plane coordinate.

Parameters:

	dx	distorted focal plane x in millimeters
	dy	distorted focal plane y in millimeters

Returns:: conversion was successful

Definition at line 99 of file CameraFocalPlaneMap.cpp.

References Isis::CameraFocalPlaneMap::ComputeUncentered(), Isis::CameraFocalPlaneMap::p_focalPlaneX, and Isis::CameraFocalPlaneMap::p_focalPlaneY.

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::PushFrameCameraGroundMap::FindDistance(), LineOffsetFunctor::operator()(), Isis::Camera::RawFocalPlanetoImage(), Isis::LoMediumDistortionMap::SetDistortion(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetRightAscensionDeclination(), Isis::LineScanCameraSkyMap::SetSky(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

double Isis::CameraFocalPlaneMap::SignMostSigX ( ) [inherited]

Return the sign of the p_transx coefficient with the greatest magnitude.

This method returns a +1. or -1. based on the sign of the p_transx coefficient with the greatest magnitude. Only p_transx[1] and p_transx[2] are compared since p_transx[0] is used as a constant in the affine transformation.

Returns:: sign of most significant coefficient

Definition at line 159 of file CameraFocalPlaneMap.cpp.

double Isis::CameraFocalPlaneMap::SignMostSigY ( ) [inherited]

Return the sign of the p_transy coefficient with the greatest magnitude.

This method returns a +1 or -1 based on the sign of the p_transy coefficient with the greatest magnitude. Only p_transy[1] and p_transy[2] are compared since p_transy[0] is used as a constant in the affine transformation.