Isis 3 Programmer Reference
Isis::RadarGroundMap Class Reference

Convert between undistorted focal plane coordinate (slant range) and ground coordinates. More...

#include <RadarGroundMap.h>

Inheritance diagram for Isis::RadarGroundMap:
Inheritance graph
Collaboration diagram for Isis::RadarGroundMap:
Collaboration graph

Public Types

enum  PartialType {
  WRT_Latitude, WRT_Longitude, WRT_Radius, WRT_MajorAxis,
  WRT_MinorAxis, WRT_PolarAxis
}
 Radius axes types to use when computing partials. More...
 

Public Member Functions

 RadarGroundMap (Camera *parent, Radar::LookDirection ldir, double waveLength)
 
virtual ~RadarGroundMap ()
 Destructor. More...
 
virtual bool SetFocalPlane (const double ux, const double uy, const double uz)
 Compute ground position from slant range. More...
 
virtual bool SetGround (const Latitude &lat, const Longitude &lon)
 Compute undistorted focal plane coordinate from ground position. More...
 
virtual bool SetGround (const SurfacePoint &surfacePoint)
 Compute undistorted focal plane coordinate from ground position that includes a local radius. More...
 
virtual bool GetXY (const SurfacePoint &spoint, double *cudx, double *cudy, bool test=false)
 Compute undistorted focal plane coordinate from ground position using current Spice from SetImage call. More...
 
virtual bool GetdXYdPosition (const SpicePosition::PartialType varType, int coefIndex, double *cudx, double *cudy)
 Compute derivative w/r to position of focal plane coordinate from ground position using current Spice from SetImage call. More...
 
virtual bool GetdXYdPoint (std::vector< double > d_lookB, double *dx, double *dy)
 Compute derivative of focal plane coordinate w/r to ground point from ground position using current Spice from SetImage call. More...
 
void SetRangeSigma (double rangeSigma)
 Set the range sigma. More...
 
double RangeSigma ()
 Return the range sigma. More...
 
void SetDopplerSigma (double dopplerSigma)
 Set the doppler sigma. More...
 
double YScale ()
 Return the doppler sigma. More...
 
double WaveLength ()
 Return the wavelength. More...
 
virtual bool GetXY (const double lat, const double lon, const double radius, double *cudx, double *cudy)
 Compute undistorted focal plane coordinate from ground position using current Spice from SetImage call. More...
 
virtual bool GetdXYdOrientation (const SpiceRotation::PartialType varType, int coefIndex, double *cudx, double *cudy)
 Compute derivative of focal plane coordinate w/r to instrument using current state from SetImage call. More...
 
virtual bool GetdXYdTOrientation (const SpiceRotation::PartialType varType, int coefIndex, double *cudx, double *cudy)
 Compute derivative of focal plane coordinate w/r to target body using current state. More...
 
std::vector< double > PointPartial (SurfacePoint spoint, PartialType wrt)
 Compute derivative with respect to indicated variable of conversion function from lat/lon/rad to rectangular coord. More...
 
std::vector< double > EllipsoidPartial (SurfacePoint spoint, PartialType raxis)
 Compute derivative of focal plane coordinate w/r to one of the ellipsoidal radii (a, b, or c) More...
 
std::vector< double > MeanRadiusPartial (SurfacePoint spoint, Distance meanRadius)
 Compute derivative of focal plane coordinate w/r to mean of the ellipsoidal radii (a, b, c) More...
 
double DQuotient (std::vector< double > &look, std::vector< double > &dlook, int index)
 Convenience method for quotient rule applied to look vector. More...
 
double FocalPlaneX () const
 
double FocalPlaneY () const
 

Protected Attributes

double p_focalPlaneX
 Camera's x focal plane coordinate. More...
 
double p_focalPlaneY
 Camera's y focal plane coordinate. More...
 

Private Member Functions

double ComputeXv (SpiceDouble X[3])
 
double GetRadius (const Latitude &lat, const Longitude &lon)
 
bool Iterate (SpiceDouble &R, const double &slantRangeSqr, const SpiceDouble c[], const SpiceDouble r[], SpiceDouble X[], SpiceDouble &lat, SpiceDouble &lon, const std::vector< double > &Xsc, const bool &useSlopeEqn, const double &slope)
 Iteration loop for computing ground position from slant range. More...
 

Private Attributes

Radar::LookDirection p_lookDirection
 
double p_tolerance
 
double p_slantRange
 units are km More...
 
double p_dopplerFreq
 units are hertz More...
 
double p_timeTolerance
 
double p_rangeSigma
 Scaling factor to convert meters to focal plane coord. More...
 
double p_dopplerSigma
 Scaling factor to convert hertz to focal plane coord. More...
 
double p_waveLength
 
std::vector< double > p_lookB
 
std::vector< double > p_sB
 
double p_groundSlantRange
 units are km More...
 
double p_groundDopplerFreq
 units are hertz More...
 
Camerap_camera
 

Detailed Description

Convert between undistorted focal plane coordinate (slant range) and ground coordinates.

This class is used to convert between undistorted focal plane coordinate (the slant range) and ground coordinates lat/lon. This class handles the case of Radar instruments.

See also
Camera
Author
2008-06-16 Jeff Anderson
History:

2009-07-01 Janet Barrett - Fixed intrack, crosstrack, and radial coordinate calculations; changed boundary check to use radius instead of lat,lon; updated calculation of Doppler shift

2009-10-30 Debbie A. Cook - Fixed rotation of velocity vector in SetFocalPlane, SetGround, and ComputeXv

2009-11-10 Janet Barrett - Added iteration check to SetFocalPlane to take care of situation where DEM radius does not converge

2009-11-20 Janet Barrett - Added a check to the SetGround method to determine what side of the spacecraft the focal plane coordinate falls. This fixed the mirror image problem that occurred when projecting the image.

2009-12-14 Debbie A. Cook - Added ComputeXY method

2010-03-19 Debbe A. Cook - added class members p_wavelength, p_lookB, p_sB, p_slantRange, and p_dopplerFreq; and methods SlantRangeSigma, WaveLength, DopplerSigma, SetSlantRangeSigma, GetXY, GetXYdPosition, and GetXYdPoint. Removed method SetWeightFactors.

2010-08-05 Debbie A. Cook - changed to use Surface point class

2010-11-22 Debbie A. Cook - moved PointPartial call out of GetdXYdPoint to allow BundleAdjust to avoid multiple calls for every measure. The application must call PointPartial to get the body-fixed look vector derivative prior to calling this method.

2010-12-17 Debbie A. Cook - Corrected units to kilometers in GetXY

2012-01-03 Janet Barrett - Got rid of call to SetLookDirection in the SetFocalPlane method. The call to SetLookDirection was duplicating the functionality of the SetFocalPlane method.

2012-01-04 Janet Barrett - Added check for valid radius in the SetGround method.

2012-01-27 Janet Barrett - The iterative algorithm in the SetFocalPlane method was failing on some points when using the DEM shape model. To fix this problem, I decreased the tolerance from 1E-8 to 1E-6 and increased the number of iterations from 30 to 100.

2012-04-03 Janet Barrett - The iteration code was moved to its own method so that it can be run multiple times if necessary. The first iteration should suffice for those pixels that have shallow slopes. For those pixels that lie on steep slopes (up to 2x the incidence angle), then an additional iteration call is needed. In the future, we may need to add more calls to the iteration method if the slope is greater than 2x the incidence angle. The slope variable will need to be halved each time the iteration method is called until a solution is found. So, for example, if we needed to call the iteration method a third time, the slope variable would be set to .25.

2012-04-11 Janet Barrett - Removed call to SetLookDirection from the SetGround method.

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

2013-02-11 Debbie A. Cook, Fixed SetGround method by adding call to set the surface point in the ShapeModel so that photometric angles can be calculated. References #775

2016-07-19 Kristin Berry, Updated SetGround to call p_camera->Sensor::SetGround so that RA, DEC values will be set on level 2 images. References #2400.

2019-05-15 Debbie A. Cook - Added optional bool argument to match parent GetXY method to allow the bundle adjustment to skip the back of planet test during iterations. References #2591.

Definition at line 111 of file RadarGroundMap.h.

Member Enumeration Documentation

◆ PartialType

Radius axes types to use when computing partials.

When computing partials, this enum represents the "with respect to" variable in the computation.

Definition at line 104 of file CameraGroundMap.h.

Constructor & Destructor Documentation

◆ ~RadarGroundMap()

virtual Isis::RadarGroundMap::~RadarGroundMap ( )
inlinevirtual

Destructor.

Definition at line 116 of file RadarGroundMap.h.

Member Function Documentation

◆ DQuotient()

double Isis::CameraGroundMap::DQuotient ( std::vector< double > &  look,
std::vector< double > &  dlook,
int  index 
)
inherited

Convenience method for quotient rule applied to look vector.

This method will compute the derivative of the following function (coordinate x or y) / (coordinate z)

Parameters
looklook vector in camera frame
dlookderivative of look vector in camera frame
indexvector value to differentiate
Returns
double derivative Computed derivative

Definition at line 566 of file CameraGroundMap.cpp.

◆ EllipsoidPartial()

vector< double > Isis::CameraGroundMap::EllipsoidPartial ( SurfacePoint  spoint,
PartialType  raxis 
)
inherited

Compute derivative of focal plane coordinate w/r to one of the ellipsoidal radii (a, b, or c)

This method will compute the derivative of the undistorted focal plane coordinate for a ground position with respect to the a (major axis), b (minor axis), or c (polar axis) radius, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters
spointSurface point whose derivative is to be evalutated
raxisRadius axis enumerated partial type (definitions in this header)
Exceptions
IException::Programmer"Invalid partial type for this method"
Returns
vector<double> partialDerivative of body-fixed point with respect to selected ellipsoid axis

Definition at line 452 of file CameraGroundMap.cpp.

References _FILEINFO_, Isis::SurfacePoint::GetLatitude(), Isis::SurfacePoint::GetLongitude(), and Isis::Angle::radians().

Referenced by Isis::BundleAdjust::computePartials().

◆ FocalPlaneX()

double Isis::CameraGroundMap::FocalPlaneX ( ) const
inlineinherited
Returns
The undistorted focal plane x

Definition at line 139 of file CameraGroundMap.h.

References Isis::CameraGroundMap::p_focalPlaneX.

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

◆ FocalPlaneY()

double Isis::CameraGroundMap::FocalPlaneY ( ) const
inlineinherited
Returns
The undistorted focal plane y

Definition at line 146 of file CameraGroundMap.h.

References Isis::CameraGroundMap::p_focalPlaneY.

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

◆ GetdXYdOrientation()

bool Isis::CameraGroundMap::GetdXYdOrientation ( const SpiceRotation::PartialType  varType,
int  coefIndex,
double *  dx,
double *  dy 
)
virtualinherited

Compute derivative of focal plane coordinate w/r to instrument using current state from SetImage call.

This method will compute the derivative of the undistorted focal plane coordinate for a ground position with respect to the instrument orientation, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters
varTypeenumerated partial type (definitions in SpicePosition)
coefIndexcoefficient index of fit polynomial
*dxout] pointer to partial derivative of undistorted focal plane x
*dy[out] pointer to partial derivative of undistorted focal plane y
Returns
bool If conversion was successful

Definition at line 334 of file CameraGroundMap.cpp.

References Isis::SpiceRotation::ReferenceVector(), and Isis::SpiceRotation::ToReferencePartial().

Referenced by Isis::BundleAdjust::computePartials().

◆ GetdXYdPoint()

bool Isis::RadarGroundMap::GetdXYdPoint ( std::vector< double >  d_lookB,
double *  dx,
double *  dy 
)
virtual

Compute derivative of focal plane coordinate w/r to ground point from ground position using current Spice from SetImage call.

This method will compute the derivative of the undistorted focal plane coordinate for a ground position with respect to lat, lon, or radius, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters
varTypeenumerated partial type (definitions in SpicePosition)
coefIndexcoefficient index of fit polynomial
*dxpointer to partial derivative of undistorted focal plane x
*dypointer to partial derivative of undistorted focal plane y
Returns
conversion was successful

Reimplemented from Isis::CameraGroundMap.

Definition at line 512 of file RadarGroundMap.cpp.

References p_dopplerSigma, p_groundDopplerFreq, p_groundSlantRange, and p_rangeSigma.

◆ GetdXYdPosition()

bool Isis::RadarGroundMap::GetdXYdPosition ( const SpicePosition::PartialType  varType,
int  coefIndex,
double *  dx,
double *  dy 
)
virtual

Compute derivative w/r to position of focal plane coordinate from ground position using current Spice from SetImage call.

This method will compute the derivative of the undistorted focal plane coordinate for a ground position with respect to a spacecraft position coordinate, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters
varTypeenumerated partial type (definitions in SpicePosition)
coefIndexcoefficient index of fit polynomial
*dxpointer to partial derivative of undistorted focal plane x
*dypointer to partial derivative of undistorted focal plane y
Returns
conversion was successful

Reimplemented from Isis::CameraGroundMap.

Definition at line 477 of file RadarGroundMap.cpp.

References Isis::Spice::bodyRotation(), Isis::SpicePosition::CoordinatePartial(), Isis::Spice::instrumentPosition(), p_dopplerSigma, p_groundDopplerFreq, p_groundSlantRange, p_rangeSigma, Isis::SpiceRotation::ReferenceVector(), and Isis::SpicePosition::VelocityPartial().

◆ GetdXYdTOrientation()

bool Isis::CameraGroundMap::GetdXYdTOrientation ( const SpiceRotation::PartialType  varType,
int  coefIndex,
double *  dx,
double *  dy 
)
virtualinherited

Compute derivative of focal plane coordinate w/r to target body using current state.

This method will compute the derivative of the undistorted focal plane coordinate for a ground position with respect to the target body orientation, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters
varTypeenumerated partial type (definitions in SpicePosition)
coefIndexcoefficient index of fit polynomial
*dx[out] pointer to partial derivative of undistorted focal plane x
*dy[out] pointer to partial derivative of undistorted focal plane y
Returns
bool If conversion was successful

Definition at line 370 of file CameraGroundMap.cpp.

References Isis::SpiceRotation::ReferenceVector(), and Isis::SpiceRotation::toJ2000Partial().

Referenced by Isis::BundleAdjust::computePartials().

◆ GetXY() [1/2]

bool Isis::CameraGroundMap::GetXY ( const double  lat,
const double  lon,
const double  radius,
double *  cudx,
double *  cudy 
)
virtualinherited

Compute undistorted focal plane coordinate from ground position using current Spice from SetImage call.

This method will compute the undistorted focal plane coordinate for a ground position, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/m_pB/x/y. The class value for m_lookJ is set by this method.

Parameters
latLatitude in degrees
lonLongitude in degrees
radiusRadius in meters
cudx[out] Pointer to computed undistored x focal plane coordinate
cudy[out] Pointer to computed undistored y focal plane coordinate
Returns
bool If conversion was successful
See also
the application socetlinescankeywords

Definition at line 270 of file CameraGroundMap.cpp.

◆ GetXY() [2/2]

bool Isis::RadarGroundMap::GetXY ( const SurfacePoint spoint,
double *  cudx,
double *  cudy,
bool  test = false 
)
virtual

Compute undistorted focal plane coordinate from ground position using current Spice from SetImage call.

This method will compute the undistorted focal plane coordinate for a ground position, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y and related radar parameter p_slantRange.

History:
2019-05-15 Debbie A. Cook - Added optional bool argument to match parent GetXY method to allow the bundle adjustment to skip the back of planet test during iterations. References #2591.
Parameters
spoint
Returns
conversion was successful

Reimplemented from Isis::CameraGroundMap.

Definition at line 377 of file RadarGroundMap.cpp.

References _FILEINFO_, Isis::Spice::bodyRotation(), Isis::SpicePosition::Coordinate(), Isis::Spice::instrumentPosition(), Isis::Displacement::kilometers(), p_dopplerSigma, p_groundDopplerFreq, p_groundSlantRange, p_rangeSigma, Isis::IException::Programmer, Isis::SpiceRotation::ReferenceVector(), and Isis::SpicePosition::Velocity().

◆ Iterate()

bool Isis::RadarGroundMap::Iterate ( SpiceDouble &  R,
const double &  slantRangeSqr,
const SpiceDouble  c[],
const SpiceDouble  r[],
SpiceDouble  X[],
SpiceDouble &  lat,
SpiceDouble &  lon,
const std::vector< double > &  Xsc,
const bool &  useSlopeEqn,
const double &  slope 
)
private

Iteration loop for computing ground position from slant range.

Parameters
uxSlant range distance in meters scaled to focal plane
uyDoppler shift (always 0.0)
uzNot used
Returns
conversion was successful

Definition at line 159 of file RadarGroundMap.cpp.

Referenced by SetFocalPlane().

◆ MeanRadiusPartial()

vector< double > Isis::CameraGroundMap::MeanRadiusPartial ( SurfacePoint  spoint,
Distance  meanRadius 
)
inherited

Compute derivative of focal plane coordinate w/r to mean of the ellipsoidal radii (a, b, c)

This method will compute the derivative of the undistorted focal plane coordinate for a ground position with respect to the mean of the a (major axis), b (minor axis), and c (polar axis) radius, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters
spointSurface point whose derivative is to be evalutated
meanRadiusComputed mean of radii
Returns
vector<double> partialDerivative of body-fixed point with respect to mean radius TODO This method assumes the radii of all points in the adjustment have been set identically to the ???

Definition at line 502 of file CameraGroundMap.cpp.

References Isis::Displacement::kilometers(), and Isis::Distance::kilometers().

Referenced by Isis::BundleAdjust::computePartials().

◆ PointPartial()

vector< double > Isis::CameraGroundMap::PointPartial ( SurfacePoint  spoint,
PartialType  wrt 
)
inherited

Compute derivative with respect to indicated variable of conversion function from lat/lon/rad to rectangular coord.

Parameters
spointSurface point (ground position)
wrttake derivative with respect to this value
Returns
vector<double> partialDerivative Computed derivative

Definition at line 524 of file CameraGroundMap.cpp.

References Isis::SurfacePoint::GetLatitude(), Isis::SurfacePoint::GetLocalRadius(), Isis::SurfacePoint::GetLongitude(), Isis::Distance::kilometers(), and Isis::Angle::radians().

◆ RangeSigma()

double Isis::RadarGroundMap::RangeSigma ( )
inline

Return the range sigma.

Definition at line 135 of file RadarGroundMap.h.

References p_rangeSigma.

◆ SetDopplerSigma()

void Isis::RadarGroundMap::SetDopplerSigma ( double  dopplerSigma)
inline

Set the doppler sigma.

Definition at line 140 of file RadarGroundMap.h.

References p_dopplerSigma.

◆ SetFocalPlane()

bool Isis::RadarGroundMap::SetFocalPlane ( const double  ux,
const double  uy,
const double  uz 
)
virtual

Compute ground position from slant range.

Parameters
uxSlant range distance in meters scaled to focal plane
uyDoppler shift (always 0.0)
uzNot used
Returns
conversion was successful

Reimplemented from Isis::CameraGroundMap.

Definition at line 61 of file RadarGroundMap.cpp.

References Isis::Spice::bodyRotation(), Isis::SpicePosition::Coordinate(), Isis::Spice::instrumentPosition(), Isis::Spice::instrumentRotation(), Iterate(), Isis::SpiceRotation::J2000Vector(), Isis::Distance::kilometers(), p_rangeSigma, Isis::PI, Isis::Spice::radii(), Isis::SpiceRotation::ReferenceVector(), and Isis::SpicePosition::Velocity().

◆ SetGround() [1/2]

bool Isis::RadarGroundMap::SetGround ( const Latitude lat,
const Longitude lon 
)
virtual

Compute undistorted focal plane coordinate from ground position.

Parameters
latplanetocentric latitude in degrees
lonplanetocentric longitude in degrees
Returns
conversion was successful

Reimplemented from Isis::CameraGroundMap.

Definition at line 216 of file RadarGroundMap.cpp.

References Isis::Sensor::LocalRadius().

◆ SetGround() [2/2]

bool Isis::RadarGroundMap::SetGround ( const SurfacePoint surfacePoint)
virtual

Compute undistorted focal plane coordinate from ground position that includes a local radius.

Parameters
latplanetocentric latitude in degrees
lonplanetocentric longitude in degrees
radiuslocal radius in meters
Returns
conversion was successful

Reimplemented from Isis::CameraGroundMap.

Definition at line 234 of file RadarGroundMap.cpp.

References Isis::Spice::bodyRotation(), Isis::SpicePosition::Coordinate(), Isis::Spice::instrumentPosition(), Isis::SpiceRotation::ReferenceVector(), Isis::SurfacePoint::ToNaifArray(), and Isis::SpicePosition::Velocity().

◆ SetRangeSigma()

void Isis::RadarGroundMap::SetRangeSigma ( double  rangeSigma)
inline

Set the range sigma.

Definition at line 130 of file RadarGroundMap.h.

References p_rangeSigma.

◆ WaveLength()

double Isis::RadarGroundMap::WaveLength ( )
inline

Return the wavelength.

Definition at line 150 of file RadarGroundMap.h.

◆ YScale()

double Isis::RadarGroundMap::YScale ( )
inline

Return the doppler sigma.

Definition at line 145 of file RadarGroundMap.h.

References p_dopplerSigma.

Member Data Documentation

◆ p_dopplerFreq

double Isis::RadarGroundMap::p_dopplerFreq
private

units are hertz

Definition at line 166 of file RadarGroundMap.h.

◆ p_dopplerSigma

double Isis::RadarGroundMap::p_dopplerSigma
private

Scaling factor to convert hertz to focal plane coord.

Definition at line 169 of file RadarGroundMap.h.

Referenced by GetdXYdPoint(), GetdXYdPosition(), GetXY(), SetDopplerSigma(), and YScale().

◆ p_focalPlaneX

double Isis::CameraGroundMap::p_focalPlaneX
protectedinherited

Camera's x focal plane coordinate.

Definition at line 152 of file CameraGroundMap.h.

Referenced by Isis::CameraGroundMap::FocalPlaneX(), and Isis::VimsGroundMap::SetGround().

◆ p_focalPlaneY

double Isis::CameraGroundMap::p_focalPlaneY
protectedinherited

Camera's y focal plane coordinate.

Definition at line 153 of file CameraGroundMap.h.

Referenced by Isis::CameraGroundMap::FocalPlaneY(), and Isis::VimsGroundMap::SetGround().

◆ p_groundDopplerFreq

double Isis::RadarGroundMap::p_groundDopplerFreq
private

units are hertz

Definition at line 175 of file RadarGroundMap.h.

Referenced by GetdXYdPoint(), GetdXYdPosition(), and GetXY().

◆ p_groundSlantRange

double Isis::RadarGroundMap::p_groundSlantRange
private

units are km

Definition at line 174 of file RadarGroundMap.h.

Referenced by GetdXYdPoint(), GetdXYdPosition(), and GetXY().

◆ p_rangeSigma

double Isis::RadarGroundMap::p_rangeSigma
private

Scaling factor to convert meters to focal plane coord.

Definition at line 168 of file RadarGroundMap.h.

Referenced by GetdXYdPoint(), GetdXYdPosition(), GetXY(), RangeSigma(), SetFocalPlane(), and SetRangeSigma().

◆ p_slantRange

double Isis::RadarGroundMap::p_slantRange
private

units are km

Definition at line 165 of file RadarGroundMap.h.


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