Isis::CameraDetectorMap Class Reference

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

#include <CameraDetectorMap.h>

Inherited by Isis::ApolloPanoramicDetectorMap, Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, and Isis::RadarPulseMap.

List of all members.

Public Member Functions
	CameraDetectorMap (Camera *parent=0)
	Default constructor assumes no summing and starting detector offsets.
virtual	~CameraDetectorMap ()
	Destructor.
virtual bool	SetParent (const double sample, const double line)
	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
Camera *	p_camera
double	p_parentSample
double	p_parentLine
double	p_detectorLine
double	p_detectorSample
double	p_detectorSampleSumming
double	p_detectorLineSumming
double	p_startingDetectorSample
double	p_startingDetectorLine
double	p_ss
double	p_sl

Detailed Description

Convert between parent image coordinates and detector coordinates.

This base class is used to convert between parent dector coordinates (sample/line) and detector coordinates for the camera.

See also:: Camera

Author:: 2005-02-03 Jeff Anderson

Constructor & Destructor Documentation

Isis::CameraDetectorMap::CameraDetectorMap ( Camera * parent = 0 )

Default constructor assumes no summing and starting detector offsets.

Parameters:

parent

Camera that will use this detector map

References p_camera, p_detectorLineSumming, p_detectorSampleSumming, p_startingDetectorLine, p_startingDetectorSample, and Isis::Camera::SetDetectorMap().

virtual Isis::CameraDetectorMap::~CameraDetectorMap ( ) [inline, virtual]

Destructor.

Member Function Documentation

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const

Return the starting detector line adjusted for summation.

References p_sl.

double Isis::CameraDetectorMap::AdjustedStartingSample ( ) const

Return the starting detector sample adjusted for summation.

References p_ss.

double Isis::CameraDetectorMap::DetectorLine ( ) const [inline]

Return detector line.

References p_detectorLine.

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

double Isis::CameraDetectorMap::DetectorSample ( ) const [inline]

Return detector sample.

References p_detectorSample.

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

virtual double Isis::CameraDetectorMap::LineRate ( ) const [inline, virtual]

Return the line collection rate (0 for framing cameras).

Reimplemented in Isis::ApolloPanoramicDetectorMap, Isis::LineScanCameraDetectorMap, and Isis::RadarPulseMap.

virtual double Isis::CameraDetectorMap::LineScaleFactor ( ) const [inline, virtual]

Return scaling factor for computing line resolution.

References p_detectorLineSumming.

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

double Isis::CameraDetectorMap::ParentLine ( ) const [inline]

Return parent line.

References p_parentLine.

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

double Isis::CameraDetectorMap::ParentSample ( ) const [inline]

Return parent sample.

References p_parentSample.

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

virtual double Isis::CameraDetectorMap::SampleScaleFactor ( ) const [inline, virtual]

Return scaling factor for computing sample resolution.

References p_detectorSampleSumming.

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

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

References p_detectorLine, p_detectorLineSumming, p_detectorSample, p_detectorSampleSumming, p_parentLine, p_parentSample, p_sl, and p_ss.

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

void Isis::CameraDetectorMap::SetDetectorLineSumming ( const double summing ) [inline]

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

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::CrismCamera::CrismCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

void Isis::CameraDetectorMap::SetDetectorSampleSumming ( const double summing ) [inline]

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

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), 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::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().