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. More...

virtual	~CameraDetectorMap ()
	Destructor. More...

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

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

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

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

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

double	ParentSample () const
	Return parent sample. More...

double	ParentLine () const
	Return parent line. More...

double	DetectorSample () const
	Return detector sample. More...

double	DetectorLine () const
	Return detector line. More...

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

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

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

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

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

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

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

virtual double	exposureDuration (const double sample, const double line, const int band) const
	This virtual method is for returning the exposure duration of a given pixel. More...

Protected Attributes
Camera *	p_camera
	Pointer to the camera. More...

double	p_parentSample
	The parent sample calculated from the detector. More...

double	p_parentLine
	The parent line calculated from the detector. More...

double	p_detectorLine
	Detector coordinate line value. More...

double	p_detectorSample
	Detector coordinate sample value. More...

double	p_detectorSampleSumming
	The scaling factor for computing sample resolution. More...

double	p_detectorLineSumming
	The scaling factor for computing line resolution. More...

double	p_startingDetectorSample
	Detector start coordinate sample value. More...

double	p_startingDetectorLine
	Detector start coordinate line value. More...

double	p_ss
	Start sample. More...

double	p_sl
	Start line. More...

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

Detailed Description

Convert between parent image coordinates and detector coordinates.

This base class is used to convert between parent detector 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.

2016-10-18 Kristin Berry - Added additional SetParent with a time offset and added unitTest coverage. References #4476.

2016-10-19 Jesse Mapel - Added exposureDuration method for accessing a pixel's exposure duration. Updated test. References #4476.

2016-10-27 Jeannie Backer - Moved method implementation to cpp file. Added some variable documentation. References #4476.

2017-08-30 Summer Stapleton - Updated documentation. References #4807.

Definition at line 64 of file CameraDetectorMap.h.

Constructor & Destructor Documentation

◆ CameraDetectorMap()

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 31 of file CameraDetectorMap.cpp.

References Compute(), p_camera, p_detectorLineSumming, p_detectorSampleSumming, p_startingDetectorLine, p_startingDetectorSample, and Isis::Camera::SetDetectorMap().

◆ ~CameraDetectorMap()

Isis::CameraDetectorMap::~CameraDetectorMap ( )

virtual

Destructor.

Definition at line 45 of file CameraDetectorMap.cpp.

Member Function Documentation

◆ AdjustedStartingLine()

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const

Return the starting detector line adjusted for summation.

Returns: (double) The starting line

Definition at line 139 of file CameraDetectorMap.cpp.

References p_sl.

◆ AdjustedStartingSample()

double Isis::CameraDetectorMap::AdjustedStartingSample ( ) const

Return the starting detector sample adjusted for summation.

Returns: (double) The starting sample

Definition at line 129 of file CameraDetectorMap.cpp.

References p_ss.

◆ Compute()

void Isis::CameraDetectorMap::Compute ( )

private

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

Definition at line 115 of file CameraDetectorMap.cpp.

References p_detectorLineSumming, p_detectorSampleSumming, p_sl, p_ss, p_startingDetectorLine, and p_startingDetectorSample.

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

◆ DetectorLine()

double Isis::CameraDetectorMap::DetectorLine ( ) const

Return detector line.

Returns: (double) The detector line

Definition at line 179 of file CameraDetectorMap.cpp.

References p_detectorLine.

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

◆ DetectorSample()

double Isis::CameraDetectorMap::DetectorSample ( ) const

Return detector sample.

Returns: (double) The detector sample

Definition at line 169 of file CameraDetectorMap.cpp.

References p_detectorSample.

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

◆ exposureDuration()

double Isis::CameraDetectorMap::exposureDuration	(	const double	sample,
		const double	line,
		const int	band
	)		const

virtual

This virtual method is for returning the exposure duration of a given pixel.

For framing cameras, exposure duration is not available so it throws an error.

Parameters

sample	The sample of the desired pixel.
line	The line of the desired pixel.
band	The band of the desired pixel.

Returns: double The exposure duration for the desired pixel in seconds.

Exceptions

IException::Programmer "Exposure duration is only available for LineScan, VariableLineScan, and PushFrame Cameras."

Reimplemented in Isis::PushFrameCameraDetectorMap, Isis::VariableLineScanCameraDetectorMap, Isis::LineScanCameraDetectorMap, and Isis::NirsDetectorMap.

Definition at line 228 of file CameraDetectorMap.cpp.

References _FILEINFO_, and Isis::IException::Programmer.

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

◆ LineRate()

double Isis::CameraDetectorMap::LineRate ( ) const

virtual

Return the line collection rate (0 for framing cameras)

Returns: (double) The line collection rate

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

Definition at line 209 of file CameraDetectorMap.cpp.

◆ LineScaleFactor()

double Isis::CameraDetectorMap::LineScaleFactor ( ) const

virtual

Return scaling factor for computing line resolution.

Returns: (double) The scaling factor for line resolution

Definition at line 199 of file CameraDetectorMap.cpp.

References p_detectorLineSumming.

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

◆ ParentLine()

double Isis::CameraDetectorMap::ParentLine ( ) const

Return parent line.

Returns: (double) The parent line

Definition at line 159 of file CameraDetectorMap.cpp.

References p_parentLine.

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

◆ ParentSample()

double Isis::CameraDetectorMap::ParentSample ( ) const

Return parent sample.

Returns: (double) The parent sample

Definition at line 149 of file CameraDetectorMap.cpp.

References p_parentSample.

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

◆ SampleScaleFactor()

double Isis::CameraDetectorMap::SampleScaleFactor ( ) const

virtual

Return scaling factor for computing sample resolution.

Returns: (double) The scaling factor for sample resolution

Definition at line 189 of file CameraDetectorMap.cpp.

References p_detectorSampleSumming.

Referenced by Isis::Camera::ObliqueSampleResolution(), and Isis::Camera::SampleResolution().

◆ SetDetector()

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::RadarPulseMap, Isis::VariableLineScanCameraDetectorMap, Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::ApolloPanoramicDetectorMap, and Isis::MocWideAngleDetectorMap.

Definition at line 59 of file CameraDetectorMap.cpp.

References p_detectorLine, p_detectorLineSumming, p_detectorSample, p_detectorSampleSumming, p_parentLine, p_parentSample, p_sl, and p_ss.

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

◆ SetDetectorLineSumming()

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 140 of file CameraDetectorMap.h.

References Compute(), and p_detectorLineSumming.

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

◆ SetDetectorSampleSumming()

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 125 of file CameraDetectorMap.h.

References Compute(), and p_detectorSampleSumming.

Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::Hyb2OncCamera::Hyb2OncCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::JunoCamera::JunoCamera(), 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::RosettaOsirisCamera::RosettaOsirisCamera(), Isis::RosettaVirtisCamera::RosettaVirtisCamera(), Isis::SsiCamera::SsiCamera(), Isis::TgoCassisCamera::TgoCassisCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

◆ SetParent() [1/2]

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::RadarPulseMap, Isis::VariableLineScanCameraDetectorMap, Isis::ApolloPanoramicDetectorMap, Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, and Isis::MocWideAngleDetectorMap.

Definition at line 79 of file CameraDetectorMap.cpp.

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

◆ SetParent() [2/2]

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

virtual

Compute detector position from a parent image coordinate.

This method will compute the detector position from the parent line/sample coordinate and an offset from the currently set time in seconds. If the time has not already been set, the input offset is not applied.

Parameters

sample	Sample number in the parent image
line	Line number in the parent image
deltaT	option time offset from center of exposure in seconds

Returns: conversion successful

Reimplemented in Isis::VariableLineScanCameraDetectorMap, Isis::LineScanCameraDetectorMap, and Isis::PushFrameCameraDetectorMap.

Definition at line 98 of file CameraDetectorMap.cpp.

References Isis::iTime::Et(), Isis::Spice::isTimeSet(), p_camera, p_detectorLine, p_detectorLineSumming, p_detectorSample, p_detectorSampleSumming, p_parentLine, p_parentSample, p_sl, p_ss, Isis::Sensor::setTime(), and Isis::Spice::time().

◆ SetStartingDetectorLine()

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 110 of file CameraDetectorMap.h.

References Compute(), and p_startingDetectorLine.

Referenced by Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::JunoCamera::JunoCamera(), Isis::MdisCamera::MdisCamera(), and Isis::RosettaOsirisCamera::RosettaOsirisCamera().

◆ SetStartingDetectorSample()

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 96 of file CameraDetectorMap.h.

References Compute(), and p_startingDetectorSample.

Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CTXCamera::CTXCamera(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), and Isis::RosettaOsirisCamera::RosettaOsirisCamera().

Member Data Documentation

◆ p_camera

Camera* Isis::CameraDetectorMap::p_camera

protected

Pointer to the camera.

Definition at line 155 of file CameraDetectorMap.h.

Referenced by CameraDetectorMap(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetFramelet(), SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::VariableLineScanCameraDetectorMap::SetParent(), Isis::RadarPulseMap::SetParent(), and Isis::PushFrameCameraDetectorMap::TotalFramelets().

◆ p_detectorLine

double Isis::CameraDetectorMap::p_detectorLine

protected

Detector coordinate line value.

Definition at line 159 of file CameraDetectorMap.h.

Referenced by DetectorLine(), SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), Isis::VariableLineScanCameraDetectorMap::SetParent(), and Isis::RadarPulseMap::SetParent().

◆ p_detectorLineSumming

double Isis::CameraDetectorMap::p_detectorLineSumming

protected

The scaling factor for computing line resolution.

Definition at line 163 of file CameraDetectorMap.h.

Referenced by CameraDetectorMap(), Compute(), LineScaleFactor(), SetDetector(), SetDetectorLineSumming(), and SetParent().

◆ p_detectorSample

double Isis::CameraDetectorMap::p_detectorSample

protected

Detector coordinate sample value.

Definition at line 160 of file CameraDetectorMap.h.

Referenced by DetectorSample(), SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), and SetParent().

◆ p_detectorSampleSumming

double Isis::CameraDetectorMap::p_detectorSampleSumming

protected

The scaling factor for computing sample resolution.

Definition at line 162 of file CameraDetectorMap.h.

Referenced by CameraDetectorMap(), Compute(), SampleScaleFactor(), SetDetector(), SetDetectorSampleSumming(), and SetParent().

◆ p_parentLine

double Isis::CameraDetectorMap::p_parentLine

protected

The parent line calculated from the detector.

Definition at line 158 of file CameraDetectorMap.h.

Referenced by ParentLine(), SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), SetParent(), and Isis::PushFrameCameraDetectorMap::SetParent().

◆ p_parentSample

double Isis::CameraDetectorMap::p_parentSample

protected

The parent sample calculated from the detector.

Definition at line 157 of file CameraDetectorMap.h.

Referenced by ParentSample(), SetDetector(), SetParent(), and Isis::PushFrameCameraDetectorMap::SetParent().

◆ p_sl

double Isis::CameraDetectorMap::p_sl

protected

Start line.

Definition at line 168 of file CameraDetectorMap.h.

Referenced by AdjustedStartingLine(), Compute(), SetDetector(), and SetParent().

◆ p_ss

double Isis::CameraDetectorMap::p_ss

protected

Start sample.

Definition at line 167 of file CameraDetectorMap.h.

Referenced by AdjustedStartingSample(), Compute(), SetDetector(), and SetParent().

◆ p_startingDetectorLine

double Isis::CameraDetectorMap::p_startingDetectorLine

protected

Detector start coordinate line value.

Definition at line 165 of file CameraDetectorMap.h.

Referenced by CameraDetectorMap(), Compute(), and SetStartingDetectorLine().

◆ p_startingDetectorSample

double Isis::CameraDetectorMap::p_startingDetectorSample

protected

Detector start coordinate sample value.

Definition at line 164 of file CameraDetectorMap.h.

Referenced by CameraDetectorMap(), Compute(), and SetStartingDetectorSample().

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

◆ CameraDetectorMap()

◆ ~CameraDetectorMap()

Member Function Documentation

◆ AdjustedStartingLine()

◆ AdjustedStartingSample()

◆ Compute()

◆ DetectorLine()

◆ DetectorSample()

◆ exposureDuration()

◆ LineRate()

◆ LineScaleFactor()

◆ ParentLine()

◆ ParentSample()

◆ SampleScaleFactor()

◆ SetDetector()

◆ SetDetectorLineSumming()

◆ SetDetectorSampleSumming()

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetStartingDetectorLine()

◆ SetStartingDetectorSample()

Member Data Documentation

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

◆ p_detectorSample

◆ p_detectorSampleSumming

◆ p_parentLine

◆ p_parentSample

◆ p_sl

◆ p_ss

◆ p_startingDetectorLine

◆ p_startingDetectorSample