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

#include <RollingShutterCameraDetectorMap.h>

Inheritance diagram for Isis::RollingShutterCameraDetectorMap:

Collaboration diagram for Isis::RollingShutterCameraDetectorMap:

Public Member Functions
	RollingShutterCameraDetectorMap (Camera *parent, std::vector< double > times, std::vector< double > sampleCoeffs, std::vector< double > lineCoeffs)
	Constructs a RollingShutterCameraDetectorMap.

virtual	~RollingShutterCameraDetectorMap ()
	Destructor.

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.

std::pair< double, double >	applyJitter (const double sample, const double line)
	Iteratively finds a solution to "apply" jitter to an image coordinate.

std::pair< double, double >	removeJitter (const double sample, const double line)
	Remove the distortion from the image (parent) coordinates.

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)

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.

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 rolling shutter camera.

See also: Camera

Author: 2018-04-02 Makayla Shepherd and Ian Humphrey

Constructor & Destructor Documentation

◆ RollingShutterCameraDetectorMap()

Isis::RollingShutterCameraDetectorMap::RollingShutterCameraDetectorMap	(	Camera *	parent,
		std::vector< double >	times,
		std::vector< double >	sampleCoeffs,
		std::vector< double >	lineCoeffs )

Constructs a RollingShutterCameraDetectorMap.

Parameters

times	A std::vector of normalized readout times
coeffs	A std::vector of the coefficients of the polynomial that fit the jitter. The coefficients are from highest degree to lowest degree.
parent	The parent camera that uses the detector map.

◆ ~RollingShutterCameraDetectorMap()

Isis::RollingShutterCameraDetectorMap::~RollingShutterCameraDetectorMap ( )

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.

◆ applyJitter()

std::pair< double, double > Isis::RollingShutterCameraDetectorMap::applyJitter	(	const double	sample,
		const double	line )

Iteratively finds a solution to "apply" jitter to an image coordinate.

Each iteration adds jitter to the original image coordinate until it finds an image coordinate that maps back to to the original image coordinate when jitter is removed. This is similar to how we handle applying radial distortion.

Note: If the jitter varies significantly (>1 pixel difference) then it is possible for there to be multiple solutions to the inverse problem and it is impossible to know which one to choose.

Parameters

sample	Image sample to apply jitter to.
line	Image line to apply jitter to.

Returns: std::pair<double,double> Returns the image coordinate with jitter applied to it.

References _FILEINFO_, removeJitter(), and Isis::IException::Unknown.

Referenced by SetDetector().

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

virtualinherited

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

For framing cameras, exposure duration is not available so it throws an error.

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.

Exceptions

IException::Programmer "Exposure duration is only available for LineScan, VariableLineScan, and PushFrame Cameras."

Reimplemented in Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::VariableLineScanCameraDetectorMap, and Isis::NirsDetectorMap.

References _FILEINFO_, and Isis::IException::Programmer.

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

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

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

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

◆ removeJitter()

std::pair< double, double > Isis::RollingShutterCameraDetectorMap::removeJitter	(	const double	sample,
		const double	line )

Remove the distortion from the image (parent) coordinates.

This is a helper function for the SetParent method.

Parameters

sample	Input (parent) image sample coordinate.
line	Input (parent) image line coordinate.

Returns: std::pair<double,double> Returns a pair of doubles corresponding to the de-jittered sample and line. This is in image coordinates.

References round.

Referenced by applyJitter(), and SetParent().

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

virtual

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 from Isis::CameraDetectorMap.

References applyJitter(), 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.

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

◆ SetParent() [1/2]

bool Isis::RollingShutterCameraDetectorMap::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

Parameters

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

Returns: conversion successful

Reimplemented from Isis::CameraDetectorMap.

References SetParent().

Referenced by SetParent().

◆ SetParent() [2/2]

bool Isis::RollingShutterCameraDetectorMap::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 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 from Isis::CameraDetectorMap.

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, removeJitter(), 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

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

Member Data Documentation

◆ p_camera

Camera* Isis::CameraDetectorMap::p_camera

protectedinherited

Pointer to the camera.

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(), 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(), SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::RadarPulseMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), 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(), SetDetector(), Isis::CameraDetectorMap::SetDetectorLineSumming(), Isis::CameraDetectorMap::SetParent(), and 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(), SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::MocWideAngleDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), and 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(), SetDetector(), Isis::CameraDetectorMap::SetDetectorSampleSumming(), Isis::CameraDetectorMap::SetParent(), and 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(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and 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(), SetDetector(), Isis::MocWideAngleDetectorMap::SetDetector(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and SetParent().

◆ p_sl

double Isis::CameraDetectorMap::p_sl

protectedinherited

Start line.

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

◆ p_ss

double Isis::CameraDetectorMap::p_ss

protectedinherited

Start sample.

Referenced by Isis::CameraDetectorMap::AdjustedStartingSample(), Isis::CameraDetectorMap::SetDetector(), SetDetector(), Isis::CameraDetectorMap::SetParent(), and 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/chkim/repos/ISIS3/isis/src/base/objs/RollingShutterCameraDetectorMap/RollingShutterCameraDetectorMap.h
/Users/chkim/repos/ISIS3/isis/src/base/objs/RollingShutterCameraDetectorMap/RollingShutterCameraDetectorMap.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RollingShutterCameraDetectorMap()

◆ ~RollingShutterCameraDetectorMap()

Member Function Documentation

◆ AdjustedStartingLine()

◆ AdjustedStartingSample()

◆ applyJitter()

◆ DetectorLine()

◆ DetectorSample()

◆ exposureDuration()

◆ LineRate()

◆ LineScaleFactor()

◆ ParentLine()

◆ ParentSample()

◆ removeJitter()

◆ SampleScaleFactor()

◆ SetDetector()

◆ SetDetectorLineSumming()

◆ SetDetectorSampleSumming()

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetStartingDetectorLine()

◆ SetStartingDetectorSample()

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