Convert between parent image coordinates and detector coordinates. More...

#include <CameraDetectorMap.h>

Inheritance diagram for Isis::CameraDetectorMap:

Collaboration diagram for Isis::CameraDetectorMap:

Public Member Functions
	CameraDetectorMap (Camera *parent=0)
	Default constructor assumes no summing and starting detector offsets.

virtual	~CameraDetectorMap ()
	Destructor.

virtual bool	SetParent (const double sample, const double line)
	Compute detector position from a parent image coordinate.

virtual bool	SetDetector (const double sample, const double line)
	Compute parent position from a detector coordinate.

double	AdjustedStartingSample () const
	Return the starting detector sample adjusted for summation.

double	AdjustedStartingLine () const
	Return the starting detector line adjusted for summation.

double	ParentSample () const
	Return parent sample.

double	ParentLine () const
	Return parent line.

double	DetectorSample () const
	Return detector sample.

double	DetectorLine () const
	Return detector line.

void	SetStartingDetectorSample (const double sample)
	Set the starting detector sample.

void	SetStartingDetectorLine (const double line)
	Set the starting detector line.

void	SetDetectorSampleSumming (const double summing)
	Set sample summing mode.

void	SetDetectorLineSumming (const double summing)
	Set line summing mode.

virtual double	SampleScaleFactor () const
	Return scaling factor for computing sample resolution.

virtual double	LineScaleFactor () const
	Return scaling factor for computing line resolution.

virtual double	LineRate () const
	Return the line collection rate (0 for framing cameras)

Protected Attributes
Camera *	p_camera

double	p_parentSample

double	p_parentLine

double	p_detectorLine

double	p_detectorSample

double	p_detectorSampleSumming

double	p_detectorLineSumming

double	p_startingDetectorSample

double	p_startingDetectorLine

double	p_ss

double	p_sl

Private Member Functions
void	Compute ()
	Compute new offsets whenenver summing or starting sample/lines change.

Detailed Description

Convert between parent image coordinates and detector coordinates.

This base class is used to convert between parent dector coordinates (sample/line) and detector coordinates for the camera.

See Also: Camera

Author: 2005-02-03 Jeff Anderson

History:

2009-04-02 Debbie A. Cook Removed obsolete methods IsXAxisTimeDependent, IsYAxisTimeDependent, XAxisDirection, YAxisDirection, SetXAxisDirection, and SetYAxisDirection

2012-07-25 Kris Becker - Corrected bug in SetStartingDetectorLine() method in that it applied this value to the sample starting detector rather than the line starting detector. It appeared to only affect the MESSENGER/MDIS camera model, however.

2013-02-11 E. Howington-Kraus - Added accessor methods: AdjustedStartingSample() and AdjustedStartingLine(). These are tested by application socetlinescankeywords since no unitTest exists. Fixed indentation of history entries. References #1490.

2014-04-17 Jeannie Backer - Added padding for ISIS coding standards compliance. References #1659.

Definition at line 58 of file CameraDetectorMap.h.

Constructor & Destructor Documentation

Isis::CameraDetectorMap::CameraDetectorMap ( Camera * parent = 0 )

Default constructor assumes no summing and starting detector offsets.

Parameters

parent Camera that will use this detector map

Definition at line 30 of file CameraDetectorMap.cpp.

References Compute(), and Isis::Camera::SetDetectorMap().

virtual Isis::CameraDetectorMap::~CameraDetectorMap ( )

inlinevirtual

Destructor.

Definition at line 63 of file CameraDetectorMap.h.

Member Function Documentation

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const

Return the starting detector line adjusted for summation.

Definition at line 93 of file CameraDetectorMap.cpp.

double Isis::CameraDetectorMap::AdjustedStartingSample ( ) const

Return the starting detector sample adjusted for summation.

Definition at line 88 of file CameraDetectorMap.cpp.

void Isis::CameraDetectorMap::Compute ( )

private

Compute new offsets whenenver summing or starting sample/lines change.

Definition at line 79 of file CameraDetectorMap.cpp.

Referenced by CameraDetectorMap(), SetDetectorLineSumming(), SetDetectorSampleSumming(), SetStartingDetectorLine(), and SetStartingDetectorSample().

double Isis::CameraDetectorMap::DetectorLine ( ) const

inline

Return detector line.

Definition at line 89 of file CameraDetectorMap.h.

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

double Isis::CameraDetectorMap::DetectorSample ( ) const

inline

Return detector sample.

Definition at line 84 of file CameraDetectorMap.h.

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

virtual double Isis::CameraDetectorMap::LineRate ( ) const

inlinevirtual

Return the line collection rate (0 for framing cameras)

Reimplemented in Isis::LineScanCameraDetectorMap, Isis::RadarPulseMap, and Isis::ApolloPanoramicDetectorMap.

Definition at line 158 of file CameraDetectorMap.h.

virtual double Isis::CameraDetectorMap::LineScaleFactor ( ) const

inlinevirtual

Return scaling factor for computing line resolution.

Definition at line 153 of file CameraDetectorMap.h.

Referenced by Isis::PushFrameCameraGroundMap::FindDistance(), Isis::Camera::LineResolution(), Isis::ThemisIrCamera::SetBand(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::PushFrameCameraDetectorMap::TotalFramelets().

double Isis::CameraDetectorMap::ParentLine ( ) const

inline

Return parent line.

Definition at line 79 of file CameraDetectorMap.h.

Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().

double Isis::CameraDetectorMap::ParentSample ( ) const

inline

Return parent sample.

Definition at line 74 of file CameraDetectorMap.h.

Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().

virtual double Isis::CameraDetectorMap::SampleScaleFactor ( ) const

inlinevirtual

Return scaling factor for computing sample resolution.

Definition at line 148 of file CameraDetectorMap.h.

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

bool Isis::CameraDetectorMap::SetDetector	(	const double	sample,
		const double	line
	)

virtual

Compute parent position from a detector coordinate.

This method will compute a parent sample/line given a detector coordinate

Parameters

sample	Sample number in the detector
line	Line number in the detector

Returns: conversion successful

Reimplemented in Isis::LineScanCameraDetectorMap, Isis::RadarPulseMap, Isis::ApolloPanoramicDetectorMap, Isis::VariableLineScanCameraDetectorMap, Isis::MocWideAngleDetectorMap, and Isis::PushFrameCameraDetectorMap.

Definition at line 52 of file CameraDetectorMap.cpp.

Referenced by Isis::Camera::RawFocalPlanetoImage(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), and Isis::Camera::SetRightAscensionDeclination().

void Isis::CameraDetectorMap::SetDetectorLineSumming ( const double summing )

inline

Set line summing mode.

Use this method to specify if detector lines are summed/averaged. That is, one image lines represents the average of N detectors. If not set the default is 1.

Parameters

summing Line summing mode

Definition at line 142 of file CameraDetectorMap.h.

References Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::CrismCamera::CrismCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

void Isis::CameraDetectorMap::SetDetectorSampleSumming ( const double summing )

inline

Set sample summing mode.

Use this method to specify if detector samples are summed/averaged. That is, one image sample represents the average of N detectors. If not set the default is 1.

Parameters

summing Sample summing mode

Definition at line 128 of file CameraDetectorMap.h.

References Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

bool Isis::CameraDetectorMap::SetParent	(	const double	sample,
		const double	line
	)

virtual

Compute detector position from a parent image coordinate.

This method will compute the detector position from the parent line/sample coordinate

Parameters

sample	Sample number in the parent image
line	Line number in the parent image

Returns: conversion successful

Reimplemented in Isis::LineScanCameraDetectorMap, Isis::RadarPulseMap, Isis::ApolloPanoramicDetectorMap, Isis::VariableLineScanCameraDetectorMap, Isis::MocWideAngleDetectorMap, and Isis::PushFrameCameraDetectorMap.

Definition at line 70 of file CameraDetectorMap.cpp.

Referenced by Isis::Camera::SetImage(), Isis::PushFrameCameraDetectorMap::SetParent(), Isis::VariableLineScanCameraDetectorMap::SetParent(), Isis::RadarPulseMap::SetParent(), and Isis::LineScanCameraDetectorMap::SetParent().

void Isis::CameraDetectorMap::SetStartingDetectorLine ( const double line )

inline

Set the starting detector line.

Use this method to specify the starting detector that represents the first image line in the cube. If not set the default is 1.

Parameters

line	Starting detector line

Definition at line 114 of file CameraDetectorMap.h.

References Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), and Isis::MdisCamera::MdisCamera().

void Isis::CameraDetectorMap::SetStartingDetectorSample ( const double sample )

inline

Set the starting detector sample.

Use this method to specify the starting detector that represents the first image sample in the cube. If not set the default is 1.

Parameters

sample Starting detector sample

Definition at line 101 of file CameraDetectorMap.h.

References Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CTXCamera::CTXCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), and Isis::MocWideAngleCamera::MocWideAngleCamera().

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

src/base/objs/CameraDetectorMap/CameraDetectorMap.h
src/base/objs/CameraDetectorMap/CameraDetectorMap.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation