Isis::RadarPulseMap Class Reference

Convert between alpha image coordinates and radar sample, time coordinates. More...

#include <RadarPulseMap.h>

Public Member Functions
	RadarPulseMap (Camera *parent, const double etStart, const double lineRate)
	Construct a detector map for line scan cameras.
virtual	~RadarPulseMap ()
	Destructor.
void	SetStartTime (const double etStart)
	Reset the starting ephemeris time.
void	SetLineRate (const double lineRate)
	Reset the line rate.
double	LineRate () const
	Return the time in seconds between scan lines.
virtual bool	SetParent (const double sample, const double line)
	Compute radar (sample/time)from a alpha image coordinate.
virtual bool	SetDetector (const double sample, const double line)
	Compute alpha position from a detector coordinate.
void	SetXAxisTimeDependent (bool on)
	Set the time dependent axis, if never called y is the time dependent axis.
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
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 alpha image coordinates and radar sample, time coordinates.

This class is used to convert between alpha coordinates (sample/line) and radar pulse coordinates (sample,time) for a radar instrument.

See also:: Camera

Author:: 2008-06-16 Jeff Anderson

Constructor & Destructor Documentation

Isis::RadarPulseMap::RadarPulseMap	(	Camera *	parent,
		const double	etStart,
		const double	lineRate
	)			`[inline]`

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

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

Destructor.

Member Function Documentation

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const [inherited]

Return the starting detector line adjusted for summation.

References Isis::CameraDetectorMap::p_sl.

double Isis::CameraDetectorMap::AdjustedStartingSample ( ) const [inherited]

Return the starting detector sample adjusted for summation.

References Isis::CameraDetectorMap::p_ss.

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

Return detector line.

References Isis::CameraDetectorMap::p_detectorLine.

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

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

Return detector sample.

References Isis::CameraDetectorMap::p_detectorSample.

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

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

Return the time in seconds between scan lines.

Reimplemented from Isis::CameraDetectorMap.

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

Return scaling factor for computing line resolution.

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

Return parent line.

References Isis::CameraDetectorMap::p_parentLine.

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

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

Return parent sample.

References Isis::CameraDetectorMap::p_parentSample.

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

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

Return scaling factor for computing sample resolution.

References Isis::CameraDetectorMap::p_detectorSampleSumming.

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

bool Isis::RadarPulseMap::SetDetector	(	const double	sample,
		const double	line
	)			`[virtual]`

Compute alpha position from a detector coordinate.

This method will compute a alpha sample given a detector coordinate. The alpha 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 (ignored)

Returns:: conversion successful

Reimplemented from Isis::CameraDetectorMap.

References Isis::iTime::Et(), Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_parentLine, Isis::CameraDetectorMap::SetDetector(), and Isis::Spice::time().

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

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(), 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::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

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

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::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().

void Isis::RadarPulseMap::SetLineRate ( const double lineRate ) [inline]

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

bool Isis::RadarPulseMap::SetParent	(	const double	sample,
		const double	line
	)			`[virtual]`

Compute radar (sample/time)from a alpha image coordinate.

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

Parameters:

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

Returns:: conversion successful

Reimplemented from Isis::CameraDetectorMap.

References Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, Isis::CameraDetectorMap::SetParent(), and Isis::Sensor::setTime().

void Isis::CameraDetectorMap::SetStartingDetectorLine ( const double line ) [inline, inherited]

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.

Referenced by Isis::MdisCamera::MdisCamera().

void Isis::CameraDetectorMap::SetStartingDetectorSample ( const double sample ) [inline, inherited]

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(), Isis::CTXCamera::CTXCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), and Isis::MocWideAngleCamera::MocWideAngleCamera().

void Isis::RadarPulseMap::SetStartTime ( const double etStart ) [inline]

Reset the starting ephemeris time.

Use this method to reset the starting time of the top edge of the first line in the alpha 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

void Isis::RadarPulseMap::SetXAxisTimeDependent ( bool on ) [inline]

Set the time dependent axis, if never called y is the time dependent axis.