Isis 3 Programmer Reference
Public Member Functions | Protected Attributes | List of all members
Isis::CameraSkyMap Class Reference

Convert between undistorted focal plane and ra/dec coordinates. More...

#include <CameraSkyMap.h>

Inheritance diagram for Isis::CameraSkyMap:
Inheritance graph
Collaboration diagram for Isis::CameraSkyMap:
Collaboration graph

Public Member Functions

 CameraSkyMap (Camera *parent)
 Constructor a map between focal plane x/y and right acension/declination. More...
 
virtual ~CameraSkyMap ()
 Destructor. More...
 
virtual bool SetFocalPlane (const double ux, const double uy, const double uz)
 Compute ra/dec from focal plane coordinate. More...
 
virtual bool SetSky (const double ra, const double dec)
 Compute undistorted focal plane coordinate from ra/dec. More...
 
double FocalPlaneX () const
 
double FocalPlaneY () const
 

Protected Attributes

Camera * p_camera
 The main camera to calculate distortions on. More...
 
double p_focalPlaneX
 Undistorted x value for the focal plane. More...
 
double p_focalPlaneY
 Undistorted y value for the focal plane. More...
 

Detailed Description

Convert between undistorted focal plane and ra/dec coordinates.

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

See also
Camera
Author
2005-02-08 Jeff Anderson
History:
2005-02-08 Jeff Anderson Original version
History:
2008-07-14 Steven Lambright Added NaifStatus calls
History:
2017-08-30 Summer Stapleton - Updated documentation. References #4807.

Definition at line 31 of file CameraSkyMap.h.

Constructor & Destructor Documentation

◆ CameraSkyMap()

Isis::CameraSkyMap::CameraSkyMap ( Camera *  parent)

Constructor a map between focal plane x/y and right acension/declination.

Parameters
parentparent camera which will use this map

Definition at line 17 of file CameraSkyMap.cpp.

References p_camera, and Isis::Camera::SetSkyMap().

◆ ~CameraSkyMap()

virtual Isis::CameraSkyMap::~CameraSkyMap ( )
inlinevirtual

Destructor.

Definition at line 36 of file CameraSkyMap.h.

Member Function Documentation

◆ FocalPlaneX()

double Isis::CameraSkyMap::FocalPlaneX ( ) const
inline
Returns
The undistorted focal plane x

Definition at line 46 of file CameraSkyMap.h.

References p_focalPlaneX.

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

◆ FocalPlaneY()

double Isis::CameraSkyMap::FocalPlaneY ( ) const
inline
Returns
The undistorted focal plane y

Definition at line 53 of file CameraSkyMap.h.

References p_focalPlaneY.

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

◆ SetFocalPlane()

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

Compute ra/dec from focal plane coordinate.

This method will compute the right ascension and declination given an undistorted focal plane coordinate. Note that the ra/dec values can be obtained from the parent camera class passed into the constructor.

Parameters
uxdistorted focal plane x in millimeters
uydistorted focal plane y in millimeters
uzdistorted focal plane z in millimeters
Returns
conversion was successful

Reimplemented in Isis::VimsSkyMap, and Isis::RadarSkyMap.

Definition at line 34 of file CameraSkyMap.cpp.

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

◆ SetSky()

bool Isis::CameraSkyMap::SetSky ( const double  ra,
const double  dec 
)
virtual

Compute undistorted focal plane coordinate from ra/dec.

Parameters
raThe right ascension angle
decThe declination
Returns
conversion was successful
Todo:
what happens if we are looking behind the focal plane?????
Todo:
what happens if we are looking parallel to the focal plane??
Todo:
can lookC[2] == zero imply parallel
Todo:
can this all be solved by restricting the physical size of the focal plane?

Reimplemented in Isis::VimsSkyMap, Isis::RadarSkyMap, and Isis::LineScanCameraSkyMap.

Definition at line 65 of file CameraSkyMap.cpp.

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

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

Member Data Documentation

◆ p_camera

Camera* Isis::CameraSkyMap::p_camera
protected

The main camera to calculate distortions on.

Definition at line 58 of file CameraSkyMap.h.

Referenced by CameraSkyMap(), Isis::VimsSkyMap::Init(), SetFocalPlane(), Isis::VimsSkyMap::SetFocalPlane(), SetSky(), Isis::LineScanCameraSkyMap::SetSky(), and Isis::VimsSkyMap::SetSky().

◆ p_focalPlaneX

double Isis::CameraSkyMap::p_focalPlaneX
protected

Undistorted x value for the focal plane.

Definition at line 59 of file CameraSkyMap.h.

Referenced by FocalPlaneX(), SetSky(), Isis::LineScanCameraSkyMap::SetSky(), and Isis::VimsSkyMap::SetSky().

◆ p_focalPlaneY

double Isis::CameraSkyMap::p_focalPlaneY
protected

Undistorted y value for the focal plane.

Definition at line 60 of file CameraSkyMap.h.

Referenced by FocalPlaneY(), SetSky(), Isis::LineScanCameraSkyMap::SetSky(), and Isis::VimsSkyMap::SetSky().

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