Isis 3 Programmer Reference
Isis::LineScanCameraDetectorMap Class Reference

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

#include <LineScanCameraDetectorMap.h>

Inheritance diagram for Isis::LineScanCameraDetectorMap:
Inheritance graph
Collaboration diagram for Isis::LineScanCameraDetectorMap:
Collaboration graph

Public Member Functions

 LineScanCameraDetectorMap (Camera *parent, const double etStart, const double lineRate)
 Construct a detector map for line scan cameras.
 
virtual ~LineScanCameraDetectorMap ()
 Destructor.
 
void SetStartTime (const double etStart)
 Reset the starting ephemeris time.
 
void SetLineRate (const double lineRate)
 Reset the line rate.
 
double LineRate () const
 Access the time, in seconds, between scan lines.
 
virtual double exposureDuration (const double sample, const double line, const int band) const
 @breif This virtual method is for returning the exposure duration of a pixel.
 
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 StartTime () const
 Access the starting time at the top edge of the first line in the parent image.
 
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.
 

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.
 

Private Attributes

double p_etStart
 Starting time at the top of the first parent line.
 
double p_lineRate
 Time, in seconds, between lines in parent cube.
 

Detailed Description

Convert between parent image coordinates and detector coordinates.

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

See also
Camera
Author
2005-02-09 Jeff Anderson
History

2009-03-07 Debbie A. Cook Removed reference to obsolute CameraDetectorMap methods

2012-07-06 Debbie A. Cook, Updated Spice members to be more compliant with Isis coding standards. References #972.

2013-02-11 E. Howington-Kraus - Added accessor method StartTime(). This is tested by application socetlinescankeywords since no unitTest exists. References #1490.

2016-10-18 Kristin Berry - Added additional SetParent method with time offset deltaT. Updated unitTest. References #4476.

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

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

Definition at line 37 of file LineScanCameraDetectorMap.h.

Constructor & Destructor Documentation

◆ LineScanCameraDetectorMap()

Isis::LineScanCameraDetectorMap::LineScanCameraDetectorMap ( Camera * parent,
const double etStart,
const double lineRate )

Construct a detector map for line scan cameras.

Parameters
parentThe parent camera model for the detector map
etStartstarting ephemeris time in seconds at the top of the first line
lineRatethe time in seconds between lines

Definition at line 23 of file LineScanCameraDetectorMap.cpp.

References p_etStart, and p_lineRate.

◆ ~LineScanCameraDetectorMap()

Isis::LineScanCameraDetectorMap::~LineScanCameraDetectorMap ( )
virtual

Destructor.

Definition at line 33 of file LineScanCameraDetectorMap.cpp.

Member Function Documentation

◆ AdjustedStartingLine()

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const
inherited

Return the starting detector line adjusted for summation.

Returns
(double) The starting line

Definition at line 123 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_sl.

◆ AdjustedStartingSample()

double Isis::CameraDetectorMap::AdjustedStartingSample ( ) const
inherited

Return the starting detector sample adjusted for summation.

Returns
(double) The starting sample

Definition at line 113 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_ss.

◆ Compute()

◆ DetectorLine()

double Isis::CameraDetectorMap::DetectorLine ( ) const
inherited

Return detector line.

Returns
(double) The detector line

Definition at line 163 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorLine.

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

◆ DetectorSample()

double Isis::CameraDetectorMap::DetectorSample ( ) const
inherited

Return detector sample.

Returns
(double) The detector sample

Definition at line 153 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorSample.

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

◆ exposureDuration()

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

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

For a fixed rate line scan camera this will return the line scan rate. Note that this may not be the exact same thing as the exposure duration. If there is some amount of padding between exposures, then the line scan rate is actually the exposure duration plus that padding.

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.
See also
LineRate

@TODO Add a way to account for the padding described above. Push frame cameras handle this by having a separate exposure duration member that can be set by individual camera models. Then, if the exposure duration member is not it's default value (0) return it instead of the line rate.

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap.

Definition at line 175 of file LineScanCameraDetectorMap.cpp.

References LineRate().

◆ LineRate()

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

Access the time, in seconds, between scan lines.

Returns
Line rate.

Reimplemented from Isis::CameraDetectorMap.

Definition at line 70 of file LineScanCameraDetectorMap.cpp.

References p_lineRate.

Referenced by exposureDuration().

◆ LineScaleFactor()

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

◆ ParentLine()

double Isis::CameraDetectorMap::ParentLine ( ) const
inherited

Return parent line.

Returns
(double) The parent line

Definition at line 143 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_parentLine.

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

◆ ParentSample()

double Isis::CameraDetectorMap::ParentSample ( ) const
inherited

Return parent sample.

Returns
(double) The parent sample

Definition at line 133 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_parentSample.

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

◆ SampleScaleFactor()

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

Return scaling factor for computing sample resolution.

Returns
(double) The scaling factor for sample resolution

Definition at line 173 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorSampleSumming.

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

◆ SetDetector()

bool Isis::LineScanCameraDetectorMap::SetDetector ( const double sample,
const double line )
virtual

Compute parent position from a detector coordinate.

This method will compute a parent sample given a detector coordinate. The parent line will be computed using the the time in the parent camera

Parameters
sampleSample number in the detector
lineLine number in the detector
Returns
conversion successful

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap, and Isis::MocWideAngleDetectorMap.

Definition at line 86 of file LineScanCameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_camera, p_etStart, p_lineRate, Isis::CameraDetectorMap::p_parentLine, Isis::CameraDetectorMap::SetDetector(), and Isis::Spice::time().

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

◆ SetDetectorLineSumming()

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_detectorLineSumming.

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

◆ SetDetectorSampleSumming()

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_detectorSampleSumming.

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

◆ SetLineRate()

void Isis::LineScanCameraDetectorMap::SetLineRate ( const double lineRate)

Reset the line rate.

Use this method to reset the time between lines. Usually this will not need to be done unless the rate changes between bands.

Parameters
lineRatethe time in seconds between lines

Definition at line 60 of file LineScanCameraDetectorMap.cpp.

References p_lineRate.

Referenced by Isis::VariableLineScanCameraDetectorMap::SetDetector(), and Isis::VariableLineScanCameraDetectorMap::SetParent().

◆ SetParent() [1/2]

bool Isis::LineScanCameraDetectorMap::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. The parent line will be used to set the appropriate time in the parent camera.

Parameters
sampleSample number in the parent image
lineLine number in the parent image
Returns
bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap, and Isis::MocWideAngleDetectorMap.

Definition at line 110 of file LineScanCameraDetectorMap.cpp.

References SetParent().

Referenced by SetParent(), and Isis::MocWideAngleDetectorMap::SetParent().

◆ SetParent() [2/2]

bool Isis::LineScanCameraDetectorMap::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. The parent line and input deltaT offset will be used to set the appropriate time in the parent camera.

Parameters
sampleSample number in the parent image
lineLine number in the parent image
deltaToffset in seconds from current exposure time
Returns
bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap.

Definition at line 128 of file LineScanCameraDetectorMap.cpp.

References Isis::CameraFocalPlaneMap::DetectorLineOffset(), Isis::Camera::FocalPlaneMap(), Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, p_etStart, p_lineRate, Isis::CameraDetectorMap::SetParent(), and Isis::Sensor::setTime().

◆ SetStartingDetectorLine()

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorLine.

◆ SetStartingDetectorSample()

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorSample.

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

◆ SetStartTime()

void Isis::LineScanCameraDetectorMap::SetStartTime ( const double etStart)

Reset the starting ephemeris time.

Use this method to reset the starting time of the top edge of the first line in the parent image. That is the time, prior to cropping, scaling, or padding. Usually this will not need to be done unless the time changes between bands.

Parameters
etStartstarting ephemeris time in seconds

Definition at line 47 of file LineScanCameraDetectorMap.cpp.

References p_etStart.

Referenced by Isis::ThemisIrCamera::SetBand().

◆ StartTime()

double Isis::LineScanCameraDetectorMap::StartTime ( ) const

Access the starting time at the top edge of the first line in the parent image.

Returns
The start ephemeris time for the image.

Definition at line 149 of file LineScanCameraDetectorMap.cpp.

References p_etStart.

Member Data Documentation

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

◆ p_detectorSample

◆ p_detectorSampleSumming

◆ p_etStart

double Isis::LineScanCameraDetectorMap::p_etStart
private

Starting time at the top of the first parent line.

Definition at line 64 of file LineScanCameraDetectorMap.h.

Referenced by LineScanCameraDetectorMap(), SetDetector(), SetParent(), SetStartTime(), and StartTime().

◆ p_lineRate

double Isis::LineScanCameraDetectorMap::p_lineRate
private

Time, in seconds, between lines in parent cube.

Definition at line 65 of file LineScanCameraDetectorMap.h.

Referenced by LineRate(), LineScanCameraDetectorMap(), SetDetector(), SetLineRate(), and SetParent().

◆ p_parentLine

◆ p_parentSample

◆ p_sl

◆ p_ss

◆ p_startingDetectorLine

double Isis::CameraDetectorMap::p_startingDetectorLine
protectedinherited

◆ p_startingDetectorSample

double Isis::CameraDetectorMap::p_startingDetectorSample
protectedinherited

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