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

#include <NirsDetectorMap.h>

Inheritance diagram for Isis::NirsDetectorMap:

Collaboration diagram for Isis::NirsDetectorMap:

Public Member Functions
	NirsDetectorMap (double exposureDuration, Camera *parent)
	Constructs a NirsDetectorMap object.

	~NirsDetectorMap ()
	Destroys a NirsDetectorMap object.

void	setExposureDuration (double exposureDuration)
	Sets the exposure duration.

virtual double	exposureDuration (const double sample, const double line, const int band) const
	Returns the exposure duration for a given 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	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
double	m_exposureDuration
	The total time for the observation.

Camera *	p_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

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 29 of file NirsDetectorMap.h.

Constructor & Destructor Documentation

◆ NirsDetectorMap()

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

Constructs a NirsDetectorMap object.

Parameters

exposureDuration	The time for the observations.
parent	The parent camera that uses the detector map.

Definition at line 19 of file NirsDetectorMap.cpp.

References exposureDuration(), and m_exposureDuration.

◆ ~NirsDetectorMap()

Isis::NirsDetectorMap::~NirsDetectorMap ( )

Destroys a NirsDetectorMap object.

Definition at line 28 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 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()

void Isis::CameraDetectorMap::Compute ( )

privateinherited

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

Definition at line 99 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorLineSumming, Isis::CameraDetectorMap::p_detectorSampleSumming, Isis::CameraDetectorMap::p_sl, Isis::CameraDetectorMap::p_ss, Isis::CameraDetectorMap::p_startingDetectorLine, and Isis::CameraDetectorMap::p_startingDetectorSample.

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

◆ 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::NirsDetectorMap::exposureDuration	(	const double	sample,
		const double	line,
		const int	band ) const

virtual

Returns the exposure duration for a given pixel.

Parameters

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

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

Reimplemented from Isis::CameraDetectorMap.

Definition at line 52 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::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

virtualinherited

Return scaling factor for computing line resolution.

Returns: (double) The scaling factor for line resolution

Definition at line 183 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorLineSumming.

Referenced by 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

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::CameraDetectorMap::SetDetector	(	const double	sample,
		const double	line )

virtualinherited

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

Definition at line 43 of file CameraDetectorMap.cpp.

References 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, and Isis::CameraDetectorMap::p_ss.

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

◆ 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

summing Line 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

summing Sample 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().

◆ setExposureDuration()

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

Sets the exposure duration.

Parameters

exposureDuration The time for the observations.

Definition at line 38 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

sample	Sample number in the parent image
line	Line 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 Isis::CameraDetectorMap::SetParent().

Referenced by Isis::Camera::SetImage(), Isis::Camera::SetImage(), Isis::CameraDetectorMap::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 )

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

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

Definition at line 82 of file CameraDetectorMap.cpp.

References 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

line	Starting 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

sample Starting detector sample

Definition at line 79 of file CameraDetectorMap.h.

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

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

Member Data Documentation

◆ m_exposureDuration

double Isis::NirsDetectorMap::m_exposureDuration

protected

The total time for the observation.

Definition at line 41 of file NirsDetectorMap.h.

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

◆ p_camera

Camera* Isis::CameraDetectorMap::p_camera

protectedinherited

Pointer to the camera.

Definition at line 138 of file CameraDetectorMap.h.

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

◆ p_detectorLine

double Isis::CameraDetectorMap::p_detectorLine

protectedinherited

Detector coordinate line value.

Definition at line 142 of file CameraDetectorMap.h.

◆ p_detectorLineSumming

double Isis::CameraDetectorMap::p_detectorLineSumming

protectedinherited

The scaling factor for computing line resolution.

Definition at line 146 of file CameraDetectorMap.h.

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

◆ p_detectorSample

double Isis::CameraDetectorMap::p_detectorSample

protectedinherited

Detector coordinate sample value.

Definition at line 143 of file CameraDetectorMap.h.

Referenced by Isis::CameraDetectorMap::DetectorSample(), Isis::ApolloPanoramicDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::MocWideAngleDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().

◆ p_detectorSampleSumming

double Isis::CameraDetectorMap::p_detectorSampleSumming

protectedinherited

The scaling factor for computing sample resolution.

Definition at line 145 of file CameraDetectorMap.h.

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

◆ p_parentLine

double Isis::CameraDetectorMap::p_parentLine

protectedinherited

The parent line calculated from the detector.

Definition at line 141 of file CameraDetectorMap.h.

◆ p_parentSample

double Isis::CameraDetectorMap::p_parentSample

protectedinherited

The parent sample calculated from the detector.

Definition at line 140 of file CameraDetectorMap.h.

Referenced by Isis::CameraDetectorMap::ParentSample(), Isis::ApolloPanoramicDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::MocWideAngleDetectorMap::SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().

◆ p_sl

double Isis::CameraDetectorMap::p_sl

protectedinherited

Start line.

Definition at line 151 of file CameraDetectorMap.h.

Referenced by Isis::CameraDetectorMap::AdjustedStartingLine(), Isis::CameraDetectorMap::Compute(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().

◆ p_ss

double Isis::CameraDetectorMap::p_ss

protectedinherited

Start sample.

Definition at line 150 of file CameraDetectorMap.h.

Referenced by Isis::CameraDetectorMap::AdjustedStartingSample(), Isis::CameraDetectorMap::Compute(), Isis::CameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().

◆ p_startingDetectorLine

double Isis::CameraDetectorMap::p_startingDetectorLine

protectedinherited

Detector start coordinate line value.

Definition at line 148 of file CameraDetectorMap.h.

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

◆ p_startingDetectorSample

double Isis::CameraDetectorMap::p_startingDetectorSample

protectedinherited

Detector start coordinate sample value.

Definition at line 147 of file CameraDetectorMap.h.

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

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

src/hayabusa/objs/HayabusaNirsCamera/NirsDetectorMap.h
src/hayabusa/objs/HayabusaNirsCamera/NirsDetectorMap.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NirsDetectorMap()

◆ ~NirsDetectorMap()

Member Function Documentation

◆ AdjustedStartingLine()

◆ AdjustedStartingSample()

◆ Compute()

◆ DetectorLine()

◆ DetectorSample()

◆ exposureDuration()

◆ LineRate()

◆ LineScaleFactor()

◆ ParentLine()

◆ ParentSample()

◆ SampleScaleFactor()

◆ SetDetector()

◆ SetDetectorLineSumming()

◆ SetDetectorSampleSumming()

◆ setExposureDuration()

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetStartingDetectorLine()

◆ SetStartingDetectorSample()

Member Data Documentation

◆ m_exposureDuration

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

◆ p_detectorSample

◆ p_detectorSampleSumming

◆ p_parentLine

◆ p_parentSample

◆ p_sl

◆ p_ss

◆ p_startingDetectorLine

◆ p_startingDetectorSample