USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::VimsGroundMap Class Reference
[Spice, Instruments, and Cameras, Cassini]

Convert between undistorted focal plane and ground coordinates. More...

#include <VimsGroundMap.h>

Inherits Isis::CameraGroundMap.

List of all members.

Public Types

enum  PartialType { WRT_Latitude, WRT_Longitude, WRT_Radius }

Public Member Functions

 VimsGroundMap (Camera *parent, Pvl &lab)
 Constructs the VimsGroundMap object.
virtual ~VimsGroundMap ()
 Destroys the VimsGroundMap object.
virtual bool SetFocalPlane (const double ux, const double uy, const double uz)
 Compute ground position from focal plane coordinate.
virtual bool SetGround (const Latitude &lat, const Longitude &lon)
 Compute undistorted focal plane coordinate from ground position.
virtual bool SetGround (const SurfacePoint &surfacePoint)
 Compute undistorted focal plane coordinate from ground position.
void Init (Pvl &lab)
 Initialize vims camera model.
virtual bool GetXY (const SurfacePoint &spoint, double *cudx, double *cudy)
 Compute undistorted focal plane coordinate from ground position using current Spice from SetImage call.
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.
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.
virtual bool GetdXYdOrientation (const SpiceRotation::PartialType varType, int coefIndex, double *cudx, double *cudy)
 Compute derivative of focal plane coordinate w/r to orientation from ground position using current Spice from SetImage call.
virtual bool GetdXYdPoint (std::vector< double > d_lookB, double *cudx, double *cudy)
 Compute derivative of focal plane coordinate w/r to ground point from ground position using current Spice from SetImage call.
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.
double DQuotient (std::vector< double > &look, std::vector< double > &dlook, int index)
 Convenience method for quotient rule applied to look vector.
double FocalPlaneX () const
 Return undistorted focal plane x.
double FocalPlaneY () const
 Return undistorted focal plane y.

Protected Attributes

Camera * p_camera
double p_focalPlaneX
double p_focalPlaneY

Detailed Description

Convert between undistorted focal plane and ground coordinates.

This base class is used to convert between undistorted focal plane coordinates (x/y) in millimeters and ground coordinates lat/lon. This class handles the case of framing cameras.

Member Enumeration Documentation

enum Isis::CameraGroundMap::PartialType [inherited]
Enumerator:
WRT_Latitude 
WRT_Longitude 
WRT_Radius 

Constructor & Destructor Documentation

Isis::VimsGroundMap::VimsGroundMap ( Camera *  parent,
Pvl &  lab 
)

Constructs the VimsGroundMap object.

Parameters:
parent A pointer to the parent Camera object
lab Pvl labels for the image

References _FILEINFO_, Isis::Camera::ParentLines(), Isis::Camera::ParentSamples(), and Isis::IException::Programmer.

Isis::VimsGroundMap::~VimsGroundMap (  )  [virtual]

Destroys the VimsGroundMap object.

Member Function Documentation

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:
look look vector in camera frame
dlook derivative of look vector in camera frame
index vector value to differentiate
Returns:
derivative

Referenced by Isis::CameraGroundMap::GetdXYdOrientation(), Isis::CameraGroundMap::GetdXYdPoint(), and Isis::CameraGroundMap::GetdXYdPosition().

double Isis::CameraGroundMap::FocalPlaneX (  )  const [inline, inherited]

Return undistorted focal plane x.

References Isis::CameraGroundMap::p_focalPlaneX.

double Isis::CameraGroundMap::FocalPlaneY (  )  const [inline, inherited]

Return undistorted focal plane y.

References Isis::CameraGroundMap::p_focalPlaneY.

bool Isis::CameraGroundMap::GetdXYdOrientation ( const SpiceRotation::PartialType  varType,
int  coefIndex,
double *  dx,
double *  dy 
) [virtual, inherited]

Compute derivative of focal plane coordinate w/r to orientation 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 the instrument orientation, using the current Spice settings (time and kernels) without resetting the current point values for lat/lon/radius/x/y.

Parameters:
varType enumerated partial type (definitions in SpicePosition)
coefIndex coefficient index of fit polynomial
*dx pointer to partial derivative of undistorted focal plane x
*dy pointer to partial derivative of undistorted focal plane y
Returns:
conversion was successful

References Isis::Camera::DistortionMap(), Isis::CameraGroundMap::DQuotient(), Isis::Spice::instrumentRotation(), Isis::CameraGroundMap::p_camera, and Isis::CameraDistortionMap::UndistortedFocalPlaneZ().

bool Isis::CameraGroundMap::GetdXYdPoint ( std::vector< double >  d_lookB,
double *  dx,
double *  dy 
) [virtual, inherited]

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:
varType enumerated partial type (definitions in SpicePosition)
coefIndex coefficient index of fit polynomial
*dx pointer to partial derivative of undistorted focal plane x
*dy pointer to partial derivative of undistorted focal plane y
Returns:
conversion was successful

Reimplemented in Isis::RadarGroundMap.

References Isis::Spice::bodyRotation(), Isis::Camera::DistortionMap(), Isis::CameraGroundMap::DQuotient(), Isis::Spice::instrumentRotation(), Isis::CameraGroundMap::p_camera, and Isis::CameraDistortionMap::UndistortedFocalPlaneZ().

bool Isis::CameraGroundMap::GetdXYdPosition ( const SpicePosition::PartialType  varType,
int  coefIndex,
double *  dx,
double *  dy 
) [virtual, inherited]

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:
varType enumerated partial type (definitions in SpicePosition)
coefIndex coefficient index of fit polynomial
*dx pointer to partial derivative of undistorted focal plane x
*dy pointer to partial derivative of undistorted focal plane y
Returns:
conversion was successful

Reimplemented in Isis::RadarGroundMap.

References Isis::SpicePosition::CoordinatePartial(), Isis::Camera::DistortionMap(), Isis::CameraGroundMap::DQuotient(), Isis::Spice::instrumentPosition(), Isis::Spice::instrumentRotation(), Isis::CameraGroundMap::p_camera, and Isis::CameraDistortionMap::UndistortedFocalPlaneZ().

bool Isis::CameraGroundMap::GetXY ( const double  lat,
const double  lon,
const double  radius,
double *  cudx,
double *  cudy 
) [virtual, inherited]

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/p_pB/x/y. The class value for p_look is set by this method.

Parameters:
lat Latitude in degrees
lon Longitude in degrees
radius 
Returns:
conversion was successful

References Isis::Angle::Degrees, Isis::CameraGroundMap::GetXY(), and Isis::Distance::Meters.

bool Isis::CameraGroundMap::GetXY ( const SurfacePoint &  point,
double *  cudx,
double *  cudy 
) [virtual, inherited]

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/p_pB/x/y. The class value for p_look is set by this method.

Parameters:
point 
Returns:
conversion was successful

Reimplemented in Isis::RadarGroundMap.

References Isis::Spice::bodyRotation(), dist, Isis::Camera::DistortionMap(), emission, Isis::SurfacePoint::GetX(), Isis::SurfacePoint::GetY(), Isis::SurfacePoint::GetZ(), Isis::Spice::instrumentPosition(), Isis::Spice::instrumentRotation(), Isis::Target::isSky(), Isis::Displacement::kilometers(), Isis::CameraGroundMap::p_camera, Isis::PI(), Isis::Spice::target(), and Isis::CameraDistortionMap::UndistortedFocalPlaneZ().

Referenced by Isis::ControlPoint::ComputeResiduals(), Isis::ControlPoint::ComputeResiduals_Millimeters(), and Isis::CameraGroundMap::GetXY().

void Isis::VimsGroundMap::Init ( Pvl &  lab  ) 

Initialize vims camera model.

Parameters:
[in] lab (Pvl &) Cube Pvl label
Exceptions:
iException::Io - "Cannot process NYQUIST(undersampled) mode "

References _FILEINFO_, Isis::iTime::Et(), Isis::PvlObject::FindGroup(), Isis::Spice::getClockTime(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Camera::IgnoreProjection(), Isis::IException::Io, Isis::Angle::isValid(), latitude, line, longitude, Isis::CameraGroundMap::p_camera, Isis::Camera::ParentLines(), Isis::Camera::ParentSamples(), Isis::Camera::SetImage(), Isis::Sensor::setTime(), Isis::toDouble(), and Isis::PvlObject::Traverse.

std::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:
lat planetocentric latitude in degrees
lon planetocentric longitude in degrees
radius local radius in meters
wrt take derivative with respect to this value
Returns:
partialDerivative

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

bool Isis::VimsGroundMap::SetFocalPlane ( const double  ux,
const double  uy,
const double  uz 
) [virtual]

Compute ground position from focal plane coordinate.

This method will compute the ground position given an undistorted focal plane coordinate. Note that the latitude/longitude value can be obtained from the camera class passed into the constructor.

Parameters:
ux Distorted focal plane x in millimeters
uy Distorted focal plane y in millimeters
uz Distorted focal plane z in millimeters
Returns:
bool Indicates whether the conversion was successful

Reimplemented from Isis::CameraGroundMap.

References Isis::CameraGroundMap::p_camera, Isis::Camera::ParentLines(), Isis::Camera::ParentSamples(), Isis::Sensor::SetLookDirection(), and Isis::Sensor::setTime().

bool Isis::VimsGroundMap::SetGround ( const SurfacePoint &  surfacePoint  )  [virtual]

Compute undistorted focal plane coordinate from ground position.

Parameters:
surfacePoint Ground surface point
Returns:
bool Indicates whether the conversion was successful.

Reimplemented from Isis::CameraGroundMap.

References Isis::SurfacePoint::GetLatitude(), Isis::SurfacePoint::GetLongitude(), and SetGround().

bool Isis::VimsGroundMap::SetGround ( const Latitude &  lat,
const Longitude &  lon 
) [virtual]

Compute undistorted focal plane coordinate from ground position.

Parameters:
lat Planetocentric latitude in degrees
lon Planetocentric longitude in degrees
Returns:
bool Indicates whether the conversion was successful

Reimplemented from Isis::CameraGroundMap.

References Isis::LeastSquares::AddKnown(), Isis::Angle::degrees(), dist, Isis::LeastSquares::Evaluate(), Isis::Sensor::HasSurfaceIntersection(), Isis::Camera::IgnoreProjection(), Isis::Angle::isValid(), Isis::LeastSquares::Knowns(), line, Isis::Camera::LineResolution(), minLine, Isis::CameraGroundMap::p_camera, Isis::CameraGroundMap::p_focalPlaneX, Isis::CameraGroundMap::p_focalPlaneY, Isis::Camera::ParentLines(), Isis::Camera::ParentSamples(), Isis::Angle::radians(), Isis::Spice::radii(), Isis::Camera::SampleResolution(), Isis::Camera::SetImage(), and Isis::LeastSquares::Solve().

Referenced by SetGround().

Member Data Documentation

Camera* Isis::CameraGroundMap::p_camera [protected, inherited]

Referenced by Isis::CameraGroundMap::CameraGroundMap(), Isis::LineScanCameraGroundMap::FindFocalPlane(), Isis::LineScanCameraGroundMap::FindSpacecraftDistance(), Isis::CameraGroundMap::GetdXYdOrientation(), Isis::CameraGroundMap::GetdXYdPoint(), Isis::CameraGroundMap::GetdXYdPosition(), Isis::CameraGroundMap::GetXY(), Init(), SetFocalPlane(), Isis::CameraGroundMap::SetFocalPlane(), SetGround(), Isis::PushFrameCameraGroundMap::SetGround(), Isis::LineScanCameraGroundMap::SetGround(), and Isis::CameraGroundMap::SetGround().

double Isis::CameraGroundMap::p_focalPlaneX [protected, inherited]

Referenced by Isis::LineScanCameraGroundMap::FindFocalPlane(), Isis::CameraGroundMap::FocalPlaneX(), SetGround(), and Isis::RadarGroundMap::SetGround().

double Isis::CameraGroundMap::p_focalPlaneY [protected, inherited]

Referenced by Isis::LineScanCameraGroundMap::FindFocalPlane(), Isis::CameraGroundMap::FocalPlaneY(), SetGround(), and Isis::RadarGroundMap::SetGround().

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