Isis 3 Programmer Reference
Isis::CameraDetectorMap Class Reference

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

#include <CameraDetectorMap.h>

Inheritance diagram for Isis::CameraDetectorMap:
Inheritance graph
Collaboration diagram for Isis::CameraDetectorMap:
Collaboration graph

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 SetParent (const double sample, const double line, const double deltaT)
 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)
 
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.
 

Protected Attributes

Camerap_camera
 Pointer to the camera.
 
double p_parentSample
 The parent sample calculated from the detector.
 
double p_parentLine
 The parent line calculated from the detector.
 
double p_detectorLine
 Detector coordinate line value.
 
double p_detectorSample
 Detector coordinate sample value.
 
double p_detectorSampleSumming
 The scaling factor for computing sample resolution.
 
double p_detectorLineSumming
 The scaling factor for computing line resolution.
 
double p_startingDetectorSample
 Detector start coordinate sample value.
 
double p_startingDetectorLine
 Detector start coordinate line value.
 
double p_ss
 Start sample.
 
double p_sl
 Start line.
 

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

Constructor & Destructor Documentation

◆ CameraDetectorMap()

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

Default constructor assumes no summing and starting detector offsets.

Parameters
parentCamera that will use this detector map

Definition at line 15 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 29 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 123 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 113 of file CameraDetectorMap.cpp.

References p_ss.

◆ Compute()

void Isis::CameraDetectorMap::Compute ( )
private

◆ DetectorLine()

double Isis::CameraDetectorMap::DetectorLine ( ) const

Return detector line.

Returns
(double) The detector line

Definition at line 163 of file CameraDetectorMap.cpp.

References p_detectorLine.

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

◆ DetectorSample()

double Isis::CameraDetectorMap::DetectorSample ( ) const

Return detector sample.

Returns
(double) The detector sample

Definition at line 153 of file CameraDetectorMap.cpp.

References p_detectorSample.

Referenced by Isis::Camera::SetImage(), and 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
sampleThe sample of the desired pixel.
lineThe line of the desired pixel.
bandThe 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::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::VariableLineScanCameraDetectorMap, and Isis::NirsDetectorMap.

Definition at line 212 of file CameraDetectorMap.cpp.

References Isis::IException::Programmer.

Referenced by Isis::Camera::exposureDuration(), and 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::ApolloPanoramicDetectorMap, Isis::LineScanCameraDetectorMap, and Isis::RadarPulseMap.

Definition at line 193 of file CameraDetectorMap.cpp.

Referenced by Isis::LineScanCameraSkyMap::SetSky().

◆ LineScaleFactor()

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

◆ ParentLine()

double Isis::CameraDetectorMap::ParentLine ( ) const

Return parent line.

Returns
(double) The parent line

Definition at line 143 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 133 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 173 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

◆ 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
summingLine summing mode

Definition at line 123 of file CameraDetectorMap.h.

References Compute(), and p_detectorLineSumming.

Referenced by Isis::CrismCamera::CrismCamera().

◆ 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
summingSample summing mode

Definition at line 108 of file CameraDetectorMap.h.

References Compute(), and p_detectorSampleSumming.

Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CrismCamera::CrismCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HrscCamera::HrscCamera(), and Isis::RosettaVirtisCamera::RosettaVirtisCamera().

◆ 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
sampleSample number in the parent image
lineLine number in the parent image
Returns
conversion successful

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

Definition at line 63 of file CameraDetectorMap.cpp.

References SetParent().

Referenced by Isis::Camera::SetImage(), Isis::Camera::SetImage(), SetParent(), Isis::RadarPulseMap::SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::VariableLineScanCameraDetectorMap::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
sampleSample number in the parent image
lineLine number in the parent image
deltaToption time offset from center of exposure in seconds
Returns
conversion successful

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

Definition at line 82 of file CameraDetectorMap.cpp.

References 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
lineStarting detector line

Definition at line 93 of file CameraDetectorMap.h.

References Compute(), and p_startingDetectorLine.

◆ 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
sampleStarting detector sample

Definition at line 79 of file CameraDetectorMap.h.

References Compute(), and p_startingDetectorSample.

Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera().

Member Data Documentation

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

double Isis::CameraDetectorMap::p_detectorLineSumming
protected

◆ p_detectorSample

◆ p_detectorSampleSumming

double Isis::CameraDetectorMap::p_detectorSampleSumming
protected

◆ p_parentLine

◆ p_parentSample

◆ p_sl

double Isis::CameraDetectorMap::p_sl
protected

◆ p_ss

double Isis::CameraDetectorMap::p_ss
protected

◆ p_startingDetectorLine

double Isis::CameraDetectorMap::p_startingDetectorLine
protected

Detector start coordinate line value.

Definition at line 148 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 147 of file CameraDetectorMap.h.

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


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