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

#include <PushFrameCameraDetectorMap.h>

Inheritance diagram for Isis::PushFrameCameraDetectorMap:

Collaboration diagram for Isis::PushFrameCameraDetectorMap:

Public Member Functions
	PushFrameCameraDetectorMap (Camera *parent, const double etStart, const double frameletRate, int frameletHeight)
	Construct a detector map for push frame cameras. More...

virtual	~PushFrameCameraDetectorMap ()
	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	FrameletRate () const
	Return the time in seconds between framelets. More...

void	SetFrameletRate (const double frameletRate)
	Reset the frame rate. More...

int	FrameletOffset () const
	Return the frame offset. More...

void	SetFrameletOffset (int frameletOffset)
	Reset the frame offset. More...

void	SetFramelet (int framelet, const double deltaT=0)
	This method changes the current framelet. More...

int	Framelet ()
	This method returns the current framelet. More...

void	SetBandFirstDetectorLine (int firstLine)
	Change the starting line in the detector based on band. More...

int	GetBandFirstDetectorLine ()
	Return the starting line in the detector for the current band. More...

void	SetStartTime (const double etStart)
	Reset the starting ephemeris time. More...

double	StartEphemerisTime () const
	This returns the starting ET of this band. More...

void	SetExposureDuration (double exposureDuration)
	Change the exposure duration in seconds. 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...

void	SetFrameletOrderReversed (bool frameletOrderReversed, int nframelets)
	Changes the direction of the framelets. More...

void	SetFrameletsGeometricallyFlipped (bool frameletsFlipped)
	Mirrors the each framelet in the file. More...

int	TotalFramelets () const
	Return the total number of framelets including padding. More...

double	frameletSample () const
	This returns the calculated framelet sample. More...

double	frameletLine () const
	This returns the calculated framelet line. More...

int	frameletHeight () const
	This returns how many lines are considered a single framelet. More...

bool	timeAscendingFramelets ()
	Returns if the framelets are reversed from top-to-bottom. 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
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 Attributes
double	p_etStart
	Starting time at the top of the first parent line. More...

double	p_exposureDuration
	Exposure duration in secs. More...

double	p_frameletRate
	iTime between framelets in parent cube. More...

int	p_frameletHeight
	Height of a framelet in detector lines. More...

int	p_bandStartDetector
	The first detector line of current band. More...

int	p_frameletOffset
	The numner of framelets padding the top of the band. More...

int	p_framelet
	The current framelet. More...

int	p_nframelets
	If flipped framelets, the number of framelets in this band. More...

double	p_frameletSample
	The sample in the current framelet. More...

double	p_frameletLine
	The line in the current framelet. More...

bool	p_flippedFramelets
	Indicates whether the geometry in a framelet is flipped. More...

bool	p_timeAscendingFramelets
	Are framelets reversed from top-to-bottom in file. More...

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 push frame camera.

See also: Camera

Author: 2007-10-15 Steven Lambright

History:

2008-06-18 Steven Lambright Added documentation

2008-10-23 Steven Lambright Added optimizations, fixed misc. bugs

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

2009-06-02 Steven Lambright Fixed framelet detection in the forward direction and inside framelet check in the reverse direction

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

2014-04-17 Jeannie Backer - Renamed SetFlippedFramelets and SetGeometricallyFlippedFramelets to SetFrameletOrderReversed and SetFrameletsGeometricallyFlipped, respectively. Moved method implementations to cpp file. References #1659.

2016-10-18 Kristin Berry - Added additional SetParent method with time offset. Added detltaT variable to SetFramelet method. Updated unitTest. References #4476.

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

Definition at line 62 of file PushFrameCameraDetectorMap.h.

Constructor & Destructor Documentation

◆ PushFrameCameraDetectorMap()

Isis::PushFrameCameraDetectorMap::PushFrameCameraDetectorMap	(	Camera *	parent,
		const double	etStart,
		const double	frameletRate,
		int	frameletHeight
	)

Construct a detector map for push frame cameras.

Parameters

parent	The parent camera model for the detector map
etStart	starting ephemeris time in seconds at the first framelet (not including padded framelets).
frameletRate	the time in seconds between framelets
frameletHeight	Physical height of framelet in lines (don't account for summing)

Definition at line 44 of file PushFrameCameraDetectorMap.cpp.

References frameletHeight(), p_bandStartDetector, p_etStart, p_exposureDuration, p_flippedFramelets, p_frameletHeight, p_frameletOffset, p_frameletRate, p_nframelets, and p_timeAscendingFramelets.

◆ ~PushFrameCameraDetectorMap()

Isis::PushFrameCameraDetectorMap::~PushFrameCameraDetectorMap ( )

virtual

Destructor.

Definition at line 59 of file PushFrameCameraDetectorMap.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::PushFrameCameraDetectorMap::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.

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.

Reimplemented from Isis::CameraDetectorMap.

Definition at line 455 of file PushFrameCameraDetectorMap.cpp.

References p_exposureDuration, and p_frameletRate.

Referenced by SetExposureDuration().

◆ Framelet()

int Isis::PushFrameCameraDetectorMap::Framelet ( )

This method returns the current framelet.

This framelet is calculated when SetParent is called.

Returns: int The current framelet

Definition at line 308 of file PushFrameCameraDetectorMap.cpp.

References p_framelet.

◆ frameletHeight()

int Isis::PushFrameCameraDetectorMap::frameletHeight ( ) const

This returns how many lines are considered a single framelet.

Returns: int Number of lines in a framelet

Definition at line 430 of file PushFrameCameraDetectorMap.cpp.

References p_frameletHeight.

Referenced by Isis::PushFrameCameraGroundMap::FindDistance(), and PushFrameCameraDetectorMap().

◆ frameletLine()

double Isis::PushFrameCameraDetectorMap::frameletLine ( ) const

This returns the calculated framelet line.

Returns: double Current framelet line

Definition at line 419 of file PushFrameCameraDetectorMap.cpp.

References p_frameletLine.

Referenced by Isis::PushFrameCameraGroundMap::FindDistance().

◆ FrameletOffset()

int Isis::PushFrameCameraDetectorMap::FrameletOffset ( ) const

Return the frame offset.

Returns: int The number of framelets padding the top of the band.

Definition at line 297 of file PushFrameCameraDetectorMap.cpp.

References p_frameletOffset.

◆ FrameletRate()

double Isis::PushFrameCameraDetectorMap::FrameletRate ( ) const

Return the time in seconds between framelets.

Returns: double The time from the start of a framelet's exposure to the end of the framlet's exposure duration.

Definition at line 272 of file PushFrameCameraDetectorMap.cpp.

References p_frameletRate.

◆ frameletSample()

double Isis::PushFrameCameraDetectorMap::frameletSample ( ) const

This returns the calculated framelet sample.

Returns: double Current framelet sample

Definition at line 408 of file PushFrameCameraDetectorMap.cpp.

References p_frameletSample.

◆ GetBandFirstDetectorLine()

int Isis::PushFrameCameraDetectorMap::GetBandFirstDetectorLine ( )

Return the starting line in the detector for the current band.

Returns: int The starting line in the detector for the current band

Definition at line 335 of file PushFrameCameraDetectorMap.cpp.

References p_bandStartDetector.

◆ 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

Return scaling factor for computing line resolution.

Returns: (double) The scaling factor for line resolution

Definition at line 199 of file CameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_detectorLineSumming.

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

◆ 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().

◆ SetBandFirstDetectorLine()

void Isis::PushFrameCameraDetectorMap::SetBandFirstDetectorLine ( int firstLine )

Change the starting line in the detector based on band.

Use this method to change which line is read out of the CCD for any given band. That is, as the virtual SetBand method for the specfic camera is invoked this method should be called.

Parameters

firstLine 0-based offset to the first line (first line of detector = 0)

Definition at line 324 of file PushFrameCameraDetectorMap.cpp.

References p_bandStartDetector.

Referenced by Isis::ThemisVisCamera::BandEphemerisTimeOffset(), Isis::MarciCamera::SetBand(), and Isis::LroWideAngleCamera::SetBand().

◆ SetDetector()

bool Isis::PushFrameCameraDetectorMap::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 and framelet line will be computed.

Parameters

sample	Sample number in the detector
line	Line number in the detector

Returns: bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

Definition at line 75 of file PushFrameCameraDetectorMap.cpp.

References Isis::CameraDetectorMap::LineScaleFactor(), p_bandStartDetector, Isis::CameraDetectorMap::p_detectorLine, Isis::CameraDetectorMap::p_detectorSample, p_flippedFramelets, p_framelet, p_frameletHeight, p_frameletLine, p_frameletSample, Isis::CameraDetectorMap::p_parentLine, and Isis::CameraDetectorMap::SetDetector().

Referenced by Isis::PushFrameCameraGroundMap::FindDistance().

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

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

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 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::PushFrameCameraDetectorMap::SetExposureDuration ( double exposureDuration )

Change the exposure duration in seconds.

Use this method to change the exposure duration of each framelet which may be different than the framelet rate.

Parameters

exposureDuration The time from the start of a framelet's exposure to the end of the framlet's exposure duration.

Definition at line 245 of file PushFrameCameraDetectorMap.cpp.

References exposureDuration(), and p_exposureDuration.

◆ SetFramelet()

void Isis::PushFrameCameraDetectorMap::SetFramelet	(	int	framelet,
		const double	deltaT = `0`
	)

This method changes the current framelet.

The camera's ephemeris time will be updated to the center of the framelet.

Parameters

framelet	Current Framelet
deltaT	offset from center time in seconds

Definition at line 198 of file PushFrameCameraDetectorMap.cpp.

References Isis::CameraDetectorMap::p_camera, p_etStart, p_exposureDuration, p_framelet, p_frameletOffset, p_frameletRate, p_nframelets, p_timeAscendingFramelets, and Isis::Sensor::setTime().

Referenced by Isis::PushFrameCameraGroundMap::FindDistance(), Isis::PushFrameCameraGroundMap::FindSpacecraftDistance(), Isis::PushFrameCameraGroundMap::SetGround(), and SetParent().

◆ SetFrameletOffset()

void Isis::PushFrameCameraDetectorMap::SetFrameletOffset ( int frameletOffset )

Reset the frame offset.

Use this method to reset the frame offset. Usually this will not need to be done unless the offset changes between bands.

Parameters

frameletOffset Number of frames offset in cube

Definition at line 286 of file PushFrameCameraDetectorMap.cpp.

References p_frameletOffset.

Referenced by Isis::MarciCamera::SetBand(), and Isis::LroWideAngleCamera::SetBand().

◆ SetFrameletOrderReversed()

void Isis::PushFrameCameraDetectorMap::SetFrameletOrderReversed	(	bool	frameletOrderReversed,
		int	nframelets
	)

Changes the direction of the framelets.

Use this method to change which direction the framelets are ordered. In some cases, the top framelet from the raw instrument data has been moved to the bottom of the image and this compensates for that.

If not set, the default is to not flip the framelet order

Parameters

frameletOrderReversed	Indicates whether the order of the framelets is should be flipped
nframelets	Number of framelets in each band, ignored if frameletsReversed is set to false

Definition at line 356 of file PushFrameCameraDetectorMap.cpp.

References p_nframelets, and p_timeAscendingFramelets.

Referenced by Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

◆ SetFrameletRate()

void Isis::PushFrameCameraDetectorMap::SetFrameletRate ( const double frameletRate )

Reset the frame rate.

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

Parameters

frameletRate the time from the start of a framelet to the start of the next framlet.

Definition at line 260 of file PushFrameCameraDetectorMap.cpp.

References p_frameletRate.

◆ SetFrameletsGeometricallyFlipped()

void Isis::PushFrameCameraDetectorMap::SetFrameletsGeometricallyFlipped ( bool frameletsFlipped )

Mirrors the each framelet in the file.

Use this method to change which direction the framelets are geometrically placed. If the first line in the framelet has been changed to the last line in the framelet, then this should be true (DEFAULT).

If not set, the default is true.

Parameters

frameletsFlipped Indicates whether each framelet is flipped over a horizontal axis

Definition at line 375 of file PushFrameCameraDetectorMap.cpp.

References p_flippedFramelets.

Referenced by Isis::LroWideAngleCamera::LroWideAngleCamera(), and Isis::MarciCamera::MarciCamera().

◆ SetParent() [1/2]

bool Isis::PushFrameCameraDetectorMap::SetParent	(	const double	sample,
		const double	line
	)

virtual

Compute detector position from a parent image coordinate.

This method will compute the detector position and framelet position from the parent line/sample coordinate. The parent line will be used to set the appropriate time in the parent camera.

Parameters

sample	Sample number in the parent image
line	Line number in the parent image

Returns: bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

Definition at line 133 of file PushFrameCameraDetectorMap.cpp.

◆ SetParent() [2/2]

bool Isis::PushFrameCameraDetectorMap::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 and framelet position from the parent line/sample coordinate. The parent line will be used to set the appropriate time in the parent camera.

Parameters

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

Returns: bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

Definition at line 150 of file PushFrameCameraDetectorMap.cpp.

References Isis::CameraDetectorMap::LineScaleFactor(), p_bandStartDetector, Isis::CameraDetectorMap::p_detectorLine, p_flippedFramelets, p_frameletHeight, p_frameletLine, p_frameletSample, Isis::CameraDetectorMap::p_parentLine, Isis::CameraDetectorMap::p_parentSample, SetFramelet(), and Isis::CameraDetectorMap::SetParent().

◆ 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 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()

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

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

◆ SetStartTime()

void Isis::PushFrameCameraDetectorMap::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

etStart starting ephemeris time in seconds

Definition at line 231 of file PushFrameCameraDetectorMap.cpp.

References p_etStart.

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

◆ StartEphemerisTime()

double Isis::PushFrameCameraDetectorMap::StartEphemerisTime ( ) const

This returns the starting ET of this band.

Returns: double Starting time (often band-dependant)

Definition at line 386 of file PushFrameCameraDetectorMap.cpp.

References p_etStart.

◆ timeAscendingFramelets()

bool Isis::PushFrameCameraDetectorMap::timeAscendingFramelets ( )

Returns if the framelets are reversed from top-to-bottom.

Returns: bool if the framelets are reversed from top-to-bottom.

Definition at line 441 of file PushFrameCameraDetectorMap.cpp.

References p_timeAscendingFramelets.

Referenced by Isis::PushFrameCameraGroundMap::SetGround().

◆ TotalFramelets()

int Isis::PushFrameCameraDetectorMap::TotalFramelets ( ) const

Return the total number of framelets including padding.

Returns: int The total number of framelets including padding

Definition at line 397 of file PushFrameCameraDetectorMap.cpp.

References Isis::CameraDetectorMap::LineScaleFactor(), Isis::CameraDetectorMap::p_camera, p_frameletHeight, and Isis::Camera::ParentLines().

Referenced by Isis::PushFrameCameraGroundMap::SetGround().

Member Data Documentation

◆ p_bandStartDetector

int Isis::PushFrameCameraDetectorMap::p_bandStartDetector

private

The first detector line of current band.

Definition at line 114 of file PushFrameCameraDetectorMap.h.

Referenced by GetBandFirstDetectorLine(), PushFrameCameraDetectorMap(), SetBandFirstDetectorLine(), SetDetector(), and SetParent().

◆ p_camera

Camera* Isis::CameraDetectorMap::p_camera

protectedinherited

Pointer to the camera.

Definition at line 155 of file CameraDetectorMap.h.

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

◆ p_detectorLine

double Isis::CameraDetectorMap::p_detectorLine

protectedinherited

Detector coordinate line value.

Definition at line 159 of file CameraDetectorMap.h.

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

◆ p_detectorLineSumming

double Isis::CameraDetectorMap::p_detectorLineSumming

protectedinherited

The scaling factor for computing line resolution.

Definition at line 163 of file CameraDetectorMap.h.

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

◆ p_detectorSample

double Isis::CameraDetectorMap::p_detectorSample

protectedinherited

Detector coordinate sample value.

Definition at line 160 of file CameraDetectorMap.h.

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

◆ p_detectorSampleSumming

double Isis::CameraDetectorMap::p_detectorSampleSumming

protectedinherited

The scaling factor for computing sample resolution.

Definition at line 162 of file CameraDetectorMap.h.

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

◆ p_etStart

double Isis::PushFrameCameraDetectorMap::p_etStart

private

Starting time at the top of the first parent line.

Definition at line 110 of file PushFrameCameraDetectorMap.h.

Referenced by PushFrameCameraDetectorMap(), SetFramelet(), SetStartTime(), and StartEphemerisTime().

◆ p_exposureDuration

double Isis::PushFrameCameraDetectorMap::p_exposureDuration

private

Exposure duration in secs.

Definition at line 111 of file PushFrameCameraDetectorMap.h.

Referenced by exposureDuration(), PushFrameCameraDetectorMap(), SetExposureDuration(), and SetFramelet().

◆ p_flippedFramelets

bool Isis::PushFrameCameraDetectorMap::p_flippedFramelets

private

Indicates whether the geometry in a framelet is flipped.

Definition at line 122 of file PushFrameCameraDetectorMap.h.

Referenced by PushFrameCameraDetectorMap(), SetDetector(), SetFrameletsGeometricallyFlipped(), and SetParent().

◆ p_framelet

int Isis::PushFrameCameraDetectorMap::p_framelet

private

The current framelet.

Definition at line 116 of file PushFrameCameraDetectorMap.h.

Referenced by Framelet(), SetDetector(), and SetFramelet().

◆ p_frameletHeight

int Isis::PushFrameCameraDetectorMap::p_frameletHeight

private

Height of a framelet in detector lines.

Definition at line 113 of file PushFrameCameraDetectorMap.h.

Referenced by frameletHeight(), PushFrameCameraDetectorMap(), SetDetector(), SetParent(), and TotalFramelets().

◆ p_frameletLine

double Isis::PushFrameCameraDetectorMap::p_frameletLine

private

The line in the current framelet.

Definition at line 120 of file PushFrameCameraDetectorMap.h.

Referenced by frameletLine(), SetDetector(), and SetParent().

◆ p_frameletOffset

int Isis::PushFrameCameraDetectorMap::p_frameletOffset

private

The numner of framelets padding the top of the band.

Definition at line 115 of file PushFrameCameraDetectorMap.h.

Referenced by FrameletOffset(), PushFrameCameraDetectorMap(), SetFramelet(), and SetFrameletOffset().

◆ p_frameletRate

double Isis::PushFrameCameraDetectorMap::p_frameletRate

private

iTime between framelets in parent cube.

Definition at line 112 of file PushFrameCameraDetectorMap.h.

Referenced by exposureDuration(), FrameletRate(), PushFrameCameraDetectorMap(), SetFramelet(), and SetFrameletRate().

◆ p_frameletSample

double Isis::PushFrameCameraDetectorMap::p_frameletSample

private

The sample in the current framelet.

Definition at line 119 of file PushFrameCameraDetectorMap.h.

Referenced by frameletSample(), SetDetector(), and SetParent().

◆ p_nframelets

int Isis::PushFrameCameraDetectorMap::p_nframelets

private

If flipped framelets, the number of framelets in this band.

Definition at line 117 of file PushFrameCameraDetectorMap.h.

Referenced by PushFrameCameraDetectorMap(), SetFramelet(), and SetFrameletOrderReversed().

◆ p_parentLine

double Isis::CameraDetectorMap::p_parentLine

protectedinherited

The parent line calculated from the detector.

Definition at line 158 of file CameraDetectorMap.h.

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

◆ p_parentSample

double Isis::CameraDetectorMap::p_parentSample

protectedinherited

The parent sample calculated from the detector.

Definition at line 157 of file CameraDetectorMap.h.

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

◆ p_sl

double Isis::CameraDetectorMap::p_sl

protectedinherited

Start line.

Definition at line 168 of file CameraDetectorMap.h.

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

◆ p_ss

double Isis::CameraDetectorMap::p_ss

protectedinherited

Start sample.

Definition at line 167 of file CameraDetectorMap.h.

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

◆ p_startingDetectorLine

double Isis::CameraDetectorMap::p_startingDetectorLine

protectedinherited

Detector start coordinate line value.

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

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

◆ p_timeAscendingFramelets

bool Isis::PushFrameCameraDetectorMap::p_timeAscendingFramelets

private

Are framelets reversed from top-to-bottom in file.

Definition at line 123 of file PushFrameCameraDetectorMap.h.

Referenced by PushFrameCameraDetectorMap(), SetFramelet(), SetFrameletOrderReversed(), and timeAscendingFramelets().

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

src/base/objs/PushFrameCameraDetectorMap/PushFrameCameraDetectorMap.h
src/base/objs/PushFrameCameraDetectorMap/PushFrameCameraDetectorMap.cpp

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PushFrameCameraDetectorMap()

◆ ~PushFrameCameraDetectorMap()

Member Function Documentation

◆ AdjustedStartingLine()

◆ AdjustedStartingSample()

◆ DetectorLine()

◆ DetectorSample()

◆ exposureDuration()

◆ Framelet()

◆ frameletHeight()

◆ frameletLine()

◆ FrameletOffset()

◆ FrameletRate()

◆ frameletSample()

◆ GetBandFirstDetectorLine()

◆ LineRate()

◆ LineScaleFactor()

◆ ParentLine()

◆ ParentSample()

◆ SampleScaleFactor()

◆ SetBandFirstDetectorLine()

◆ SetDetector()

◆ SetDetectorLineSumming()

◆ SetDetectorSampleSumming()

◆ SetExposureDuration()

◆ SetFramelet()

◆ SetFrameletOffset()

◆ SetFrameletOrderReversed()

◆ SetFrameletRate()

◆ SetFrameletsGeometricallyFlipped()

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetStartingDetectorLine()

◆ SetStartingDetectorSample()

◆ SetStartTime()

◆ StartEphemerisTime()

◆ timeAscendingFramelets()

◆ TotalFramelets()

Member Data Documentation

◆ p_bandStartDetector

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

◆ p_detectorSample

◆ p_detectorSampleSumming

◆ p_etStart

◆ p_exposureDuration

◆ p_flippedFramelets

◆ p_framelet

◆ p_frameletHeight

◆ p_frameletLine

◆ p_frameletOffset

◆ p_frameletRate

◆ p_frameletSample

◆ p_nframelets

◆ p_parentLine

◆ p_parentSample

◆ p_sl

◆ p_ss

◆ p_startingDetectorLine

◆ p_startingDetectorSample

◆ p_timeAscendingFramelets