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

#include <RadarPulseMap.h>

Inheritance diagram for Isis::RadarPulseMap:

Collaboration diagram for Isis::RadarPulseMap:

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

Private Attributes
bool	p_xAxisTimeDependent
bool	p_yAxisTimeDependent
double	p_etStart
	Starting time at the top of the 1st alpha line.
double	p_lineRate
	iTime between lines in parent cube

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

History:: 2009-07-01 Janet Barrett - Corrected the calculations used to convert from line to time and back

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

Definition at line 51 of file RadarPulseMap.h.

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

Definition at line 61 of file RadarPulseMap.h.

References p_etStart, and p_lineRate.

virtual Isis::RadarPulseMap::~RadarPulseMap ( )

inlinevirtual

Destructor.

Definition at line 70 of file RadarPulseMap.h.

Member Function Documentation

double Isis::CameraDetectorMap::AdjustedStartingLine ( ) const

inherited

Return the starting detector line adjusted for summation.

Definition at line 93 of file CameraDetectorMap.cpp.

double Isis::CameraDetectorMap::AdjustedStartingSample ( ) const

inherited

Return the starting detector sample adjusted for summation.

Definition at line 88 of file CameraDetectorMap.cpp.

double Isis::CameraDetectorMap::DetectorLine ( ) const

inlineinherited

Return detector line.

Definition at line 89 of file CameraDetectorMap.h.

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

double Isis::CameraDetectorMap::DetectorSample ( ) const

inlineinherited

Return detector sample.

Definition at line 84 of file CameraDetectorMap.h.

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

double Isis::RadarPulseMap::LineRate ( ) const

inlinevirtual

Return the time in seconds between scan lines.

Reimplemented from Isis::CameraDetectorMap.

Definition at line 99 of file RadarPulseMap.h.

References p_lineRate.

virtual double Isis::CameraDetectorMap::LineScaleFactor ( ) const

inlinevirtualinherited

Return scaling factor for computing line resolution.

Definition at line 153 of file CameraDetectorMap.h.

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

double Isis::CameraDetectorMap::ParentLine ( ) const

inlineinherited

Return parent line.

Definition at line 79 of file CameraDetectorMap.h.

Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().

double Isis::CameraDetectorMap::ParentSample ( ) const

inlineinherited

Return parent sample.

Definition at line 74 of file CameraDetectorMap.h.

Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().

virtual double Isis::CameraDetectorMap::SampleScaleFactor ( ) const

inlinevirtualinherited

Return scaling factor for computing sample resolution.

Definition at line 148 of file CameraDetectorMap.h.

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.

Definition at line 40 of file RadarPulseMap.cpp.

References Isis::iTime::Et(), p_etStart, p_lineRate, Isis::CameraDetectorMap::SetDetector(), and Isis::Spice::time().

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

References Isis::CameraDetectorMap::Compute().

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 )

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

References Isis::CameraDetectorMap::Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), 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().

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

Definition at line 94 of file RadarPulseMap.h.

References p_lineRate.

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.

Definition at line 59 of file RadarPulseMap.cpp.

References p_etStart, p_lineRate, Isis::CameraDetectorMap::SetParent(), and Isis::Sensor::setTime().

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

References Isis::CameraDetectorMap::Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), and Isis::MdisCamera::MdisCamera().

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

References Isis::CameraDetectorMap::Compute().

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CTXCamera::CTXCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), 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

Definition at line 82 of file RadarPulseMap.h.

References p_etStart.

void Isis::RadarPulseMap::SetXAxisTimeDependent ( bool on )

inline

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

Definition at line 111 of file RadarPulseMap.h.

Member Data Documentation

double Isis::RadarPulseMap::p_etStart

private

Starting time at the top of the 1st alpha line.

Definition at line 119 of file RadarPulseMap.h.

Referenced by RadarPulseMap(), SetDetector(), SetParent(), and SetStartTime().

double Isis::RadarPulseMap::p_lineRate

private

iTime between lines in parent cube

Definition at line 120 of file RadarPulseMap.h.

Referenced by LineRate(), RadarPulseMap(), SetDetector(), SetLineRate(), and SetParent().

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

src/base/objs/RadarPulseMap/RadarPulseMap.h
src/base/objs/RadarPulseMap/RadarPulseMap.cpp

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation