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

#include <LineScanCameraDetectorMap.h>

Inheritance diagram for Isis::LineScanCameraDetectorMap:

Collaboration diagram for Isis::LineScanCameraDetectorMap:

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
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.

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

Constructor & Destructor Documentation

◆ LineScanCameraDetectorMap()

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

Construct a detector map for line scan cameras.

Parameters

parent	The parent camera model for the detector map
etStart	starting ephemeris time in seconds at the top of the first line
lineRate	the time in seconds between lines

◆ ~LineScanCameraDetectorMap()

Isis::LineScanCameraDetectorMap::~LineScanCameraDetectorMap ( )

virtual

Destructor.

Member Function Documentation

◆ AdjustedStartingLine()

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const

inherited

Return the starting detector line adjusted for summation.

Returns: (double) The starting line

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

References Isis::CameraDetectorMap::p_ss.

◆ DetectorLine()

double Isis::CameraDetectorMap::DetectorLine ( ) const

inherited

Return detector line.

Returns: (double) The detector line

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

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

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.

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.

References LineRate().

◆ LineRate()

double Isis::LineScanCameraDetectorMap::LineRate ( ) const

virtual

Access the time, in seconds, between scan lines.

Returns: Line rate.

Reimplemented from Isis::CameraDetectorMap.

Referenced by exposureDuration().

◆ LineScaleFactor()

double Isis::CameraDetectorMap::LineScaleFactor ( ) const

virtualinherited

Return scaling factor for computing line resolution.

Returns: (double) The scaling factor for line resolution

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

References Isis::CameraDetectorMap::p_parentLine.

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

◆ ParentSample()

double Isis::CameraDetectorMap::ParentSample ( ) const

inherited

Return parent sample.

Returns: (double) The parent sample

References Isis::CameraDetectorMap::p_parentSample.

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

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

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

Returns: conversion successful

Reimplemented from Isis::CameraDetectorMap.

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

References Isis::CameraDetectorMap::p_camera, 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

summing Line summing mode

References 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

References 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

lineRate the time in seconds between lines

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

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

Returns: bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

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

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

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

Returns: bool conversion successful

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap.

References Isis::CameraFocalPlaneMap::DetectorLineOffset(), Isis::Camera::FocalPlaneMap(), Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, 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

line	Starting detector line

References 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

References 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

etStart starting ephemeris time in seconds

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.

Member Data Documentation

◆ p_camera

Camera* Isis::CameraDetectorMap::p_camera

protectedinherited

Pointer to the camera.

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

◆ p_detectorLine

double Isis::CameraDetectorMap::p_detectorLine

protectedinherited

Detector coordinate line value.

Referenced by Isis::CameraDetectorMap::DetectorLine(), Isis::ApolloPanoramicDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::RadarPulseMap::SetParent(), Isis::CameraDetectorMap::SetParent(), SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), Isis::RollingShutterCameraDetectorMap::SetParent(), and Isis::VariableLineScanCameraDetectorMap::SetParent().

◆ p_detectorLineSumming

double Isis::CameraDetectorMap::p_detectorLineSumming

protectedinherited

The scaling factor for computing line resolution.

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

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.

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

Referenced by Isis::CameraDetectorMap::ParentLine(), Isis::ApolloPanoramicDetectorMap::SetDetector(), Isis::CameraDetectorMap::SetDetector(), SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::RollingShutterCameraDetectorMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().

◆ p_parentSample

double Isis::CameraDetectorMap::p_parentSample

protectedinherited

The parent sample calculated from the detector.

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.

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

◆ p_ss

double Isis::CameraDetectorMap::p_ss

protectedinherited

Start sample.

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

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

◆ p_startingDetectorSample

double Isis::CameraDetectorMap::p_startingDetectorSample

protectedinherited

Detector start coordinate sample value.

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

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

/Users/astamile/ISIS3/isis/src/base/objs/LineScanCameraDetectorMap/LineScanCameraDetectorMap.h
/Users/astamile/ISIS3/isis/src/base/objs/LineScanCameraDetectorMap/LineScanCameraDetectorMap.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LineScanCameraDetectorMap()

◆ ~LineScanCameraDetectorMap()

Member Function Documentation

◆ AdjustedStartingLine()

◆ AdjustedStartingSample()

◆ DetectorLine()

◆ DetectorSample()

◆ exposureDuration()

◆ LineRate()

◆ LineScaleFactor()

◆ ParentLine()

◆ ParentSample()

◆ SampleScaleFactor()

◆ SetDetector()

◆ SetDetectorLineSumming()

◆ SetDetectorSampleSumming()

◆ SetLineRate()

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetStartingDetectorLine()

◆ SetStartingDetectorSample()

◆ SetStartTime()

◆ StartTime()

Member Data Documentation

◆ p_camera

◆ p_detectorLine

◆ p_detectorLineSumming

◆ p_detectorSample

◆ p_detectorSampleSumming

◆ p_parentLine

◆ p_parentSample

◆ p_sl

◆ p_ss

◆ p_startingDetectorLine

◆ p_startingDetectorSample