USGS

Isis 3.0 Object Programmers' Reference

 Home
Isis::CameraGroundMap

Isis::CameraGroundMap Class Reference

#include <CameraGroundMap.h>

Inheritance diagram for Isis::CameraGroundMap:

Inheritance graph
[legend]
Collaboration diagram for Isis::CameraGroundMap:

Collaboration graph
[legend]
List of all members.

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.

See also:
Camera

For internal use only.

History:
2005-02-08 Jeff Anderson Original version
History:
2005-11-16 Jeff Anderson Fixed bug in SetGround not setting the proper boolean return value
History:
2007-06-11 Debbie A. Cook - Added overloaded method SetGround that includes a radius argument and the method LookCtoFocalPlaneXY() to handle the common functionality between the SetGround methods
History:
2008-07-14 Steven Lambright Added NaifStatus calls

Definition at line 54 of file CameraGroundMap.h.

Public Member Functions

 CameraGroundMap (Camera *parent)
virtual ~CameraGroundMap ()
 Destructor.
virtual bool SetFocalPlane (const double ux, const double uy, const double uz)
 Compute ground position from focal plane coordinate.
virtual bool SetGround (const double lat, const double lon)
 Compute undistorted focal plane coordinate from ground position.
virtual bool SetGround (const double lat, const double lon, const double radius)
 Compute undistorted focal plane coordinate from ground position that includes a local radius.
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

Private Member Functions

void LookCtoFocalPlaneXY ()
 Compute undistorted focal plane coordinate from camera look vector.

Constructor & Destructor Documentation

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

Destructor.

Definition at line 59 of file CameraGroundMap.h.

Member Function Documentation

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

Return undistorted focal plane x.

Definition at line 68 of file CameraGroundMap.h.

References p_focalPlaneX.

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

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

Return undistorted focal plane y.

Definition at line 71 of file CameraGroundMap.h.

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

void Isis::CameraGroundMap::LookCtoFocalPlaneXY (  )  [private]

Compute undistorted focal plane coordinate from camera look vector.

Definition at line 77 of file CameraGroundMap.cpp.

References Isis::Camera::FocalLength(), p_camera, p_focalPlaneX, and p_focalPlaneY.

Referenced by SetGround().

bool Isis::CameraGroundMap::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:
conversion was successful

Reimplemented in Isis::RadarGroundMap, and Isis::Cassini::VimsGroundMap.

Definition at line 44 of file CameraGroundMap.cpp.

References Isis::NaifStatus::CheckErrors(), p_camera, and Isis::Sensor::SetLookDirection().

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

bool Isis::CameraGroundMap::SetGround ( const double  lat,
const double  lon,
const double  radius 
) [virtual]

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

Parameters:
lat planetocentric latitude in degrees
lon planetocentric longitude in degrees
radius local radius in meters
Returns:
conversion was successful

Reimplemented in Isis::LineScanCameraGroundMap, and Isis::RadarGroundMap.

Definition at line 93 of file CameraGroundMap.cpp.

References LookCtoFocalPlaneXY(), and p_camera.

bool Isis::CameraGroundMap::SetGround ( const double  lat,
const double  lon 
) [virtual]

Compute undistorted focal plane coordinate from ground position.

Parameters:
lat planetocentric latitude in degrees
lon planetocentric longitude in degrees
Returns:
conversion was successful

Reimplemented in Isis::LineScanCameraGroundMap, Isis::PushFrameCameraGroundMap, Isis::RadarGroundMap, and Isis::Cassini::VimsGroundMap.

Definition at line 68 of file CameraGroundMap.cpp.

References LookCtoFocalPlaneXY(), and p_camera.

Referenced by Isis::PushFrameCameraGroundMap::SetGround(), and Isis::Camera::SetUniversalGround().

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