Isis Developer Reference
Public Member Functions | Protected Attributes | List of all members
Isis::CSMSkyMap Class Reference

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

#include <CSMSkyMap.h>

Inheritance diagram for Isis::CSMSkyMap:
Inheritance graph
Collaboration diagram for Isis::CSMSkyMap:
Collaboration graph

Public Member Functions

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

Protected Attributes

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

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

Constructor & Destructor Documentation

◆ CSMSkyMap()

Isis::CSMSkyMap::CSMSkyMap ( Camera * parent)

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

Parameters
parentparent camera which will use this map

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

Member Function Documentation

◆ FocalPlaneX()

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

References Isis::CameraSkyMap::p_focalPlaneX.

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

◆ FocalPlaneY()

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

References Isis::CameraSkyMap::p_focalPlaneY.

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

◆ SetFocalPlane()

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

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::RadarSkyMap, and Isis::VimsSkyMap.

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

◆ SetSky()

bool Isis::CSMSkyMap::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

Reimplemented from Isis::CameraSkyMap.

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

Member Data Documentation

◆ p_camera

Camera* Isis::CameraSkyMap::p_camera
protectedinherited

The main camera to calculate distortions on.

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

◆ p_focalPlaneX

double Isis::CameraSkyMap::p_focalPlaneX
protectedinherited

Undistorted x value for the focal plane.

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

◆ p_focalPlaneY

double Isis::CameraSkyMap::p_focalPlaneY
protectedinherited

Undistorted y value for the focal plane.

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

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