USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::RadarGroundRangeMap Class Reference

Construct a mapping between image sample and Radar ground range. More...

#include <RadarGroundRangeMap.h>

Inherits Isis::CameraFocalPlaneMap.

Public Types

enum  FocalPlaneXDependencyType { Sample = 1, Line = 2 }
 Focal plane x dependency indicates whether the x value of the focal plane coordinate maps to a sample or a line. More...

Public Member Functions

 RadarGroundRangeMap (Camera *parent, const int naifIkCode)
 Construct mapping between detectors and focal plane x/y.
virtual bool SetDetector (const double sample, const double line)
 Compute distorted focal plane coordinate from detector position (sampel,line)
virtual bool SetFocalPlane (const double dx, const double dy)
 Compute detector position (sample,line) from focal plane coordinates.
double FocalPlaneX () const
 Return distorted focal plane x.
double FocalPlaneY () const
 Return distorted focal plane y.
double DetectorSample () const
 Return detector sample.
double DetectorLine () const
 Return detector line.
double CenteredDetectorSample () const
 Return centered detector sample.
double CenteredDetectorLine () const
 Return centered detector line.
void SetDetectorOrigin (const double sample, const double line)
 Set the detector origin.
double DetectorLineOrigin () const
 Return detector line origin.
double DetectorSampleOrigin () const
 Return detector sample origin.
void SetDetectorOffset (const double sampleOffset, const double lineOffset)
 Set the detector offset.
double DetectorLineOffset () const
 Return detector line offset.
double DetectorSampleOffset () const
 Return detector sample offset.
void SetTransL (const QVector< double > transL)
 Set the affine coefficients for converting destorted (x,y) to a detector Line.
void SetTransS (const QVector< double > transS)
 Set the affine coefficients for converting destorted (x,y) to a detector Sample.
void SetTransX (const QVector< double > transX)
 Set the affine coefficients for converting detector (sample,line) to a distorted X.
void SetTransY (const QVector< double > transY)
 Set the affine coefficients for converting detector (sample,line) to a distorted Y.
const double * TransL () const
 Return the affine coefficients for converting distorted (x,y) to a detector Line.
const double * TransS () const
 Return the affine coefficients for converting distorted (x,y) to a detector Sample.
const double * TransX () const
 Return the affine coefficients for converting detector (sample,line) to a distorted X.
const double * TransY () const
 Return the affine coefficients for converting detector (sample,line) to distorted Y.
int FocalPlaneXDependency ()
 Return the focal plane x dependency variable.
double SignMostSigX ()
 Return the sign of the p_transx coefficient with the greatest magnitude.
double SignMostSigY ()
 Return the sign of the p_transy coefficient with the greatest magnitude.

Static Public Member Functions

static void setTransform (int naifIkCode, double groundRangeResolution, int samples, Radar::LookDirection ldir)

Protected Member Functions

void ComputeCentered ()
 Convenience method to center detector origin (use when inheriting)
void ComputeUncentered ()
 Convenience method to center detector origin (use when inheriting)

Protected Attributes

Camerap_camera
double p_detectorLineOrigin
double p_detectorSampleOrigin
double p_focalPlaneX
 x value of focal plane coordinate
double p_focalPlaneY
 y value of focal plane coordinate
double p_detectorLine
 line value of the detector
double p_detectorSample
 sample value of the detector
double p_centeredDetectorSample
double p_centeredDetectorLine
double p_detectorLineOffset
double p_detectorSampleOffset
double p_transx [3]
double p_transy [3]
double p_itranss [3]
double p_itransl [3]

Detailed Description

Construct a mapping between image sample and Radar ground range.

See Also
Camera
Author
2008-06-17 Jeff Anderson Original version

Member Enumeration Documentation

Focal plane x dependency indicates whether the x value of the focal plane coordinate maps to a sample or a line.

Enumerator:
Sample 

The x value of the focal plane maps to a sample.

Line 

The x value of the focal plane maps to a line.

Constructor & Destructor Documentation

Isis::RadarGroundRangeMap::RadarGroundRangeMap ( Camera parent,
const int  naifIkCode 
)

Construct mapping between detectors and focal plane x/y.

Parameters
parentparent camera that will use this map
naifIkCodecode of the naif instrument for reading coefficients

Member Function Documentation

double Isis::CameraFocalPlaneMap::CenteredDetectorLine ( ) const
inherited

Return centered detector line.

References Isis::CameraFocalPlaneMap::p_centeredDetectorLine.

double Isis::CameraFocalPlaneMap::CenteredDetectorSample ( ) const
inherited

Return centered detector sample.

References Isis::CameraFocalPlaneMap::p_centeredDetectorSample.

double Isis::CameraFocalPlaneMap::DetectorLineOffset ( ) const
inherited
double Isis::CameraFocalPlaneMap::DetectorLineOrigin ( ) const
inherited
double Isis::CameraFocalPlaneMap::DetectorSampleOffset ( ) const
inherited

Return detector sample offset.

References Isis::CameraFocalPlaneMap::p_detectorSampleOffset.

double Isis::CameraFocalPlaneMap::DetectorSampleOrigin ( ) const
inherited
double Isis::CameraFocalPlaneMap::FocalPlaneX ( ) const
inherited
int Isis::CameraFocalPlaneMap::FocalPlaneXDependency ( )
inherited

Return the focal plane x dependency variable.

This method returns the image variable (sample or line) on which the focal plane x depends.

Returns
dependency variable

References Isis::CameraFocalPlaneMap::Line, Isis::CameraFocalPlaneMap::p_transx, and Isis::CameraFocalPlaneMap::Sample.

double Isis::CameraFocalPlaneMap::FocalPlaneY ( ) const
inherited
bool Isis::CameraFocalPlaneMap::SetDetector ( const double  sample,
const double  line 
)
virtualinherited

Compute distorted focal plane coordinate from detector position (sampel,line)

This method will compute both the distorted focal plane x/y and centered detector position given a detector position

Parameters
sampleundistorted focal plane x in millimeters
lineundistorted focal plane y in millimeters
Returns
conversion was successful

References Isis::CameraFocalPlaneMap::ComputeCentered(), Isis::CameraFocalPlaneMap::p_centeredDetectorLine, Isis::CameraFocalPlaneMap::p_centeredDetectorSample, Isis::CameraFocalPlaneMap::p_detectorLine, Isis::CameraFocalPlaneMap::p_detectorSample, Isis::CameraFocalPlaneMap::p_focalPlaneX, Isis::CameraFocalPlaneMap::p_focalPlaneY, Isis::CameraFocalPlaneMap::p_transx, and Isis::CameraFocalPlaneMap::p_transy.

Referenced by Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetImage(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

void Isis::CameraFocalPlaneMap::SetDetectorOffset ( const double  sampleOffset,
const double  lineOffset 
)
inherited
void Isis::CameraFocalPlaneMap::SetDetectorOrigin ( const double  sample,
const double  line 
)
inherited

Set the detector origin.

This is used to set the origin of the detector. Typically the middle of the detector. For example, a 512x512 dectector would have the origin at (256.5,256.5). If not set both are 0.

Parameters
sampledetector sample at the origin
linedetector line at the origin

References Isis::CameraFocalPlaneMap::p_detectorLineOrigin, and Isis::CameraFocalPlaneMap::p_detectorSampleOrigin.

Referenced by Isis::AmicaCamera::AmicaCamera(), Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IdealCamera::IdealCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::Mariner10Camera::Mariner10Camera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::NirCamera::NirCamera(), Isis::ThemisIrCamera::SetBand(), Isis::LroWideAngleCamera::SetBand(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::UvvisCamera::UvvisCamera(), Isis::VikingCamera::VikingCamera(), and Isis::VoyagerCamera::VoyagerCamera().

bool Isis::CameraFocalPlaneMap::SetFocalPlane ( const double  dx,
const double  dy 
)
virtualinherited

Compute detector position (sample,line) from focal plane coordinates.

NOTE: This is detector (sample, line) not necessarily image (sample, line). If the image was reformatted from what was collected the two differ. See the New Horizons LEISA camera for an example (LEISA is a frame camera being treated as a line scan camera).

This method will compute both the centered and normal detector position given a distorted focal plane coordinate.

Parameters
dxdistorted focal plane x in millimeters
dydistorted focal plane y in millimeters
Returns
conversion was successful

References Isis::CameraFocalPlaneMap::ComputeUncentered(), Isis::CameraFocalPlaneMap::p_centeredDetectorLine, Isis::CameraFocalPlaneMap::p_centeredDetectorSample, Isis::CameraFocalPlaneMap::p_focalPlaneX, Isis::CameraFocalPlaneMap::p_focalPlaneY, Isis::CameraFocalPlaneMap::p_itransl, and Isis::CameraFocalPlaneMap::p_itranss.

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::LoMediumDistortionMap::SetDistortion(), Isis::LoMediumDistortionMap::SetFocalPlane(), Isis::Camera::SetRightAscensionDeclination(), Isis::LineScanCameraSkyMap::SetSky(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

void Isis::RadarGroundRangeMap::setTransform ( int  naifIkCode,
double  groundRangeResolution,
int  samples,
Radar::LookDirection  ldir 
)
static

Referenced by Isis::MiniRF::MiniRF().

void Isis::CameraFocalPlaneMap::SetTransL ( const QVector< double >  transL)
inherited

Set the affine coefficients for converting destorted (x,y) to a detector Line.

References Isis::CameraFocalPlaneMap::p_itransl.

Referenced by Isis::NewHorizonsLeisaCamera::SetBand().

void Isis::CameraFocalPlaneMap::SetTransS ( const QVector< double >  transS)
inherited

Set the affine coefficients for converting destorted (x,y) to a detector Sample.

References Isis::CameraFocalPlaneMap::p_itranss.

Referenced by Isis::NewHorizonsLeisaCamera::SetBand().

void Isis::CameraFocalPlaneMap::SetTransX ( const QVector< double >  transX)
inherited

Set the affine coefficients for converting detector (sample,line) to a distorted X.

References Isis::CameraFocalPlaneMap::p_transx.

Referenced by Isis::NewHorizonsLeisaCamera::SetBand().

void Isis::CameraFocalPlaneMap::SetTransY ( const QVector< double >  transY)
inherited

Set the affine coefficients for converting detector (sample,line) to a distorted Y.

References Isis::CameraFocalPlaneMap::p_transy.

Referenced by Isis::NewHorizonsLeisaCamera::SetBand().

double Isis::CameraFocalPlaneMap::SignMostSigX ( )
inherited

Return the sign of the p_transx coefficient with the greatest magnitude.

This method returns a +1. or -1. based on the sign of the p_transx coefficient with the greatest magnitude. Only p_transx[1] and p_transx[2] are compared since p_transx[0] is used as a constant in the affine transformation.

Returns
sign of most significant coefficient

References Isis::CameraFocalPlaneMap::p_transx.

double Isis::CameraFocalPlaneMap::SignMostSigY ( )
inherited

Return the sign of the p_transy coefficient with the greatest magnitude.

This method returns a +1 or -1 based on the sign of the p_transy coefficient with the greatest magnitude. Only p_transy[1] and p_transy[2] are compared since p_transy[0] is used as a constant in the affine transformation.

Returns
sign of most significant coefficient

References Isis::CameraFocalPlaneMap::p_transy.

const double * Isis::CameraFocalPlaneMap::TransL ( ) const
inherited

Return the affine coefficients for converting distorted (x,y) to a detector Line.

References Isis::CameraFocalPlaneMap::p_itransl.

Referenced by Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera().

const double * Isis::CameraFocalPlaneMap::TransS ( ) const
inherited

Return the affine coefficients for converting distorted (x,y) to a detector Sample.

References Isis::CameraFocalPlaneMap::p_itranss.

Referenced by Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera().

const double * Isis::CameraFocalPlaneMap::TransX ( ) const
inherited

Return the affine coefficients for converting detector (sample,line) to a distorted X.

References Isis::CameraFocalPlaneMap::p_transx.

Referenced by Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera().

const double * Isis::CameraFocalPlaneMap::TransY ( ) const
inherited

Return the affine coefficients for converting detector (sample,line) to distorted Y.

References Isis::CameraFocalPlaneMap::p_transy.

Referenced by Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera().

Member Data Documentation

Camera* Isis::CameraFocalPlaneMap::p_camera
protectedinherited
double Isis::CameraFocalPlaneMap::p_detectorLine
protectedinherited
double Isis::CameraFocalPlaneMap::p_detectorLineOffset
protectedinherited
double Isis::CameraFocalPlaneMap::p_detectorSample
protectedinherited
double Isis::CameraFocalPlaneMap::p_detectorSampleOffset
protectedinherited
double Isis::CameraFocalPlaneMap::p_focalPlaneX
protectedinherited
double Isis::CameraFocalPlaneMap::p_focalPlaneY
protectedinherited

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