Isis 3 Programmer Reference
Isis::NirsDetectorMap Class Reference

The detector map class for the Hayabusa NIRS camera. More...

#include <NirsDetectorMap.h>

Inheritance diagram for Isis::NirsDetectorMap:
Inheritance graph
Collaboration diagram for Isis::NirsDetectorMap:
Collaboration graph

Public Member Functions

 NirsDetectorMap (double exposureDuration, Camera *parent)
 Constructs a NirsDetectorMap object. More...
 
 ~NirsDetectorMap ()
 Destroys a NirsDetectorMap object. More...
 
void setExposureDuration (double exposureDuration)
 Sets the exposure duration. More...
 
virtual double exposureDuration (const double sample, const double line, const int band) const
 Returns the exposure duration for a given pixel. 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...
 

Protected Attributes

double m_exposureDuration
 The total time for the observation. More...
 
Camerap_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...
 

Detailed Description

The detector map class for the Hayabusa NIRS camera.

The detector map class to allow for exposure duration storage and retrieval in the Hayabusa NIRS camera.

Author
2017-01-04 Jesse Mapel
History:
2017-01-04 Jesse Mapel - Original version. Fixes #4576.

Definition at line 40 of file NirsDetectorMap.h.

Constructor & Destructor Documentation

◆ NirsDetectorMap()

Isis::NirsDetectorMap::NirsDetectorMap ( double  exposureDuration,
Camera parent = 0 
)

Constructs a NirsDetectorMap object.

Parameters
exposureDurationThe time for the observations.
parentThe parent camera that uses the detector map.

Definition at line 33 of file NirsDetectorMap.cpp.

References exposureDuration(), and m_exposureDuration.

◆ ~NirsDetectorMap()

Isis::NirsDetectorMap::~NirsDetectorMap ( )

Destroys a NirsDetectorMap object.

Definition at line 42 of file NirsDetectorMap.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 139 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 129 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_ss.

◆ DetectorLine()

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

Return detector line.

Returns
(double) The detector line

Definition at line 179 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorLine.

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

◆ DetectorSample()

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

Return detector sample.

Returns
(double) The detector sample

Definition at line 169 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorSample.

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

◆ exposureDuration()

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

Returns the exposure duration for a given pixel.

Parameters
sampleThe sample location of the pixel.
lineThe line location of the pixel.
bandThe band location of the pixel.
Returns
double The exposure duration for the pixel in seconds.

Reimplemented from Isis::CameraDetectorMap.

Definition at line 66 of file NirsDetectorMap.cpp.

References m_exposureDuration.

Referenced by NirsDetectorMap(), and setExposureDuration().

◆ LineRate()

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

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
virtualinherited

◆ ParentLine()

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

Return parent line.

Returns
(double) The parent line

Definition at line 159 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 149 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 189 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorSampleSumming.

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

◆ SetDetector()

◆ SetDetectorLineSumming()

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

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

◆ setExposureDuration()

void Isis::NirsDetectorMap::setExposureDuration ( double  exposureDuration)

Sets the exposure duration.

Parameters
exposureDurationThe time for the observations.

Definition at line 52 of file NirsDetectorMap.cpp.

References exposureDuration(), and m_exposureDuration.

◆ SetParent() [1/2]

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

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::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 
)
virtualinherited

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

Definition at line 98 of file CameraDetectorMap.cpp.

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

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

References Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorLine.

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

◆ SetStartingDetectorSample()

Member Data Documentation

◆ m_exposureDuration

double Isis::NirsDetectorMap::m_exposureDuration
protected

The total time for the observation.

Definition at line 52 of file NirsDetectorMap.h.

Referenced by exposureDuration(), NirsDetectorMap(), and setExposureDuration().

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

double Isis::CameraDetectorMap::p_detectorLineSumming
protectedinherited

◆ p_detectorSample

double Isis::CameraDetectorMap::p_detectorSample
protectedinherited

◆ p_detectorSampleSumming

double Isis::CameraDetectorMap::p_detectorSampleSumming
protectedinherited

◆ p_parentLine

◆ p_parentSample

double Isis::CameraDetectorMap::p_parentSample
protectedinherited

◆ p_sl

double Isis::CameraDetectorMap::p_sl
protectedinherited

◆ p_ss

double Isis::CameraDetectorMap::p_ss
protectedinherited

◆ 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: