Isis 3 Programmer Reference
Isis::Sensor Class Referenceabstract

Class for computing sensor ground coordinates. More...

#include <Sensor.h>

Inheritance diagram for Isis::Sensor:
Inheritance graph
Collaboration diagram for Isis::Sensor:
Collaboration graph

Public Member Functions

 Sensor (Cube &cube)
 Constructs a Sensor object and loads SPICE kernels using information from the label object.
 
virtual ~Sensor ()
 Destroys the Sensor.
 
void setTime (const iTime &time)
 By setting the time you essential set the position of the spacecraft and body as indicated in the class Spice.
 
bool SetLookDirection (const double v[3])
 Sets the look direction of the spacecraft.
 
bool SetRightAscensionDeclination (const double ra, const double dec)
 Given the ra/dec compute the look direction.
 
bool SetUniversalGround (const double latitude, const double longitude, bool backCheck=true)
 This is the opposite routine for SetLookDirection.
 
bool SetUniversalGround (const double latitude, const double longitude, const double radius, bool backCheck=true)
 This overloaded method has the opposite function as SetLookDirection.
 
bool SetGround (const SurfacePoint &surfacePt, bool backCheck=true)
 This overloaded method has the opposite function as SetLookDirection.
 
bool HasSurfaceIntersection () const
 Returns if the last call to either SetLookDirection or SetUniversalGround had a valid intersection with the target.
 
void Coordinate (double p[3]) const
 Returns the x,y,z of the surface intersection in BodyFixed km.
 
virtual double UniversalLatitude () const
 Returns the planetocentric latitude, in degrees, at the surface intersection point in the body fixed coordinate system.
 
Latitude GetLatitude () const
 Returns a planetocentric latitude object at the surface intersection point in body fixed.
 
virtual double UniversalLongitude () const
 Returns the positive east, 0-360 domain longitude, in degrees, at the surface intersection point in the body fixed coordinate system.
 
Longitude GetLongitude () const
 Returns a positive east, 0-360 domain longitude object at the surface intersection point in the body fixed coordinate system.
 
virtual SurfacePoint GetSurfacePoint () const
 Returns the surface point (most efficient accessor).
 
Distance LocalRadius () const
 Returns the local radius at the intersection point.
 
Distance LocalRadius (Latitude lat, Longitude lon)
 Returns the local radius at the intersection point.
 
Distance LocalRadius (double lat, double lon)
 Returns the local radius at the intersection point.
 
virtual double PhaseAngle () const
 Returns the phase angle in degrees.
 
virtual double EmissionAngle () const
 Returns the emission angle in degrees.
 
virtual double IncidenceAngle () const
 Returns the incidence angle in degrees.
 
void LookDirection (double v[3]) const
 Returns the look direction in the camera coordinate system.
 
virtual std::vector< double > lookDirectionJ2000 () const
 Returns the look direction in the camera coordinate system.
 
virtual std::vector< double > lookDirectionBodyFixed () const
 Returns the look direction in the body fixed coordinate system.
 
virtual double RightAscension ()
 Returns the right ascension angle (sky longitude).
 
virtual double Declination ()
 Returns the declination angle (sky latitude).
 
void SpacecraftSurfaceVector (double scSurfaceVector[3]) const
 Sets the vector between the spacecraft and surface point in body-fixed.
 
virtual double SlantDistance () const
 Return the distance between the spacecraft and surface point in kmv.
 
double LocalSolarTime ()
 Return the local solar time in hours.
 
virtual double SolarDistance () const
 Returns the distance between the sun and surface point in AU.
 
double SpacecraftAltitude ()
 Returns the distance from the spacecraft to the subspacecraft point in km.
 
virtual double resolution ()
 Virtual method that returns the pixel resolution of the sensor in meters/pix.
 
void IgnoreElevationModel (bool ignore)
 This allows you to ignore the cube elevation model and use the ellipse.
 
virtual QList< QPointF > PixelIfovOffsets ()
 This method is implemented in Camera which defaults to the (pixel pitch * summing mode ) / 2.
 
virtual QString instrumentNameLong () const =0
 
virtual QString instrumentNameShort () const =0
 
virtual QString spacecraftNameLong () const =0
 
virtual QString spacecraftNameShort () const =0
 
void instrumentPosition (double p[3]) const
 Returns the spacecraft position in body-fixed frame km units.
 
virtual SpicePositioninstrumentPosition () const
 Accessor method for the instrument position.
 
virtual void instrumentBodyFixedPosition (double p[3]) const
 Returns the spacecraft position in body-fixed frame km units.
 
virtual void sunPosition (double p[3]) const
 Fills the input vector with sun position information, in either body-fixed or J2000 reference frame and km units.
 
virtual SpicePositionsunPosition () const
 Accessor method for the sun position.
 
virtual double targetCenterDistance () const
 Calculates and returns the distance from the spacecraft to the target center.
 
virtual double sunToBodyDist () const
 
virtual Longitude solarLongitude ()
 Returns the solar longitude.
 
virtual void instrumentBodyFixedVelocity (double v[3]) const
 Returns the spacecraft velocity in body-fixed frame km/sec units.
 
virtual iTime time () const
 Returns the ephemeris time in seconds which was used to obtain the spacecraft and sun positions.
 
void radii (Distance r[3]) const
 Returns the radii of the body in km.
 
virtual void createCache (iTime startTime, iTime endTime, const int size, double tol)
 This method creates an internal cache of spacecraft and sun positions over a specified time range.
 
virtual iTime cacheStartTime () const
 Accessor method for the cache start time.
 
virtual iTime cacheEndTime () const
 Accessor method for the cache end time.
 
virtual void subSpacecraftPoint (double &lat, double &lon)
 Returns the sub-spacecraft latitude/longitude in universal coordinates (0-360 positive east, ocentric)
 
virtual void subSolarPoint (double &lat, double &lon)
 Returns the sub-solar latitude/longitude in universal coordinates (0-360 positive east, ocentric)
 
virtual Targettarget () const
 Returns a pointer to the target object.
 
QString targetName () const
 Returns the QString name of the target.
 
virtual iTime getClockTime (QString clockValue, int sclkCode=-1, bool clockTicks=false)
 This converts the spacecraft clock ticks value (clockValue) to an iTime.
 
SpiceDouble getDouble (const QString &key, int index=0)
 This returns a value from the NAIF text pool.
 
SpiceInt getInteger (const QString &key, int index=0)
 This returns a value from the NAIF text pool.
 
QString getString (const QString &key, int index=0)
 This returns a value from the NAIF text pool.
 
virtual SpiceRotationbodyRotation () const
 Accessor method for the body rotation.
 
virtual SpiceRotationinstrumentRotation () const
 Accessor method for the instrument rotation.
 
bool isUsingAle ()
 
bool hasKernels (Pvl &lab)
 Returns true if the kernel group has kernel files.
 
bool isTimeSet ()
 Returns true if time has been initialized.
 
SpiceInt naifBodyCode () const
 This returns the NAIF body code of the target indicated in the labels.
 
SpiceInt naifSpkCode () const
 This returns the NAIF SPK code to use when reading from SPK kernels.
 
SpiceInt naifCkCode () const
 This returns the NAIF CK code to use when reading from CK kernels.
 
SpiceInt naifIkCode () const
 This returns the NAIF IK code to use when reading from instrument kernels.
 
SpiceInt naifSclkCode () const
 This returns the NAIF SCLK code to use when reading from instrument kernels.
 
SpiceInt naifBodyFrameCode () const
 This returns the NAIF body frame code.
 
PvlObject getStoredNaifKeywords () const
 This returns the PvlObject that stores all of the requested Naif data and can be a replacement for furnishing text kernels.
 

Protected Types

enum  SpiceValueType { SpiceDoubleType , SpiceStringType , SpiceIntType , SpiceByteCodeType }
 NAIF value primitive type. More...
 

Protected Member Functions

QVariant readValue (QString key, SpiceValueType type, int index=0)
 This should be used for reading ALL text naif kernel values.
 
void storeResult (QString name, SpiceValueType type, QVariant value)
 
QVariant getStoredResult (QString name, SpiceValueType type)
 
void storeValue (QString key, int index, SpiceValueType type, QVariant value)
 
QVariant readStoredValue (QString key, SpiceValueType type, int index)
 
virtual void computeSolarLongitude (iTime et)
 Computes the solar longitude for the given ephemeris time.
 

Protected Attributes

SpiceDouble m_lookB [3]
 Look direction in body fixed.
 
bool m_newLookB
 flag to indicate we need to recompute ra/dec
 
SpiceDouble m_uB [3]
 This contains the sun position (u) in the bodyfixed reference frame (B).
 
SpiceDouble m_BJ [3][3]
 This contains the transformation matrix from J2000 (J) to Body fixed (B).
 
Targetm_target
 Target of the observation.
 
iTimem_et
 Ephemeris time (read NAIF documentation for a detailed description)
 
Longitudem_solarLongitude
 Body rotation solar longitude value.
 

Private Member Functions

void CommonInitialize (const std::string &demCube)
 
void computeRaDec ()
 Computes the ra/dec from the look direction.
 
bool SetGroundLocal (bool backCheck)
 Computes look vector.
 
void init (Pvl &pvl, bool noTables, nlohmann::json isd=NULL)
 Initialization of Spice object.
 
void csmInit (Cube &cube, Pvl label)
 Initialize the Spice object for a CSMCamera.
 
void defaultInit ()
 Default initialize the members of the SPICE object.
 
void load (PvlKeyword &key, bool notab)
 Loads/furnishes NAIF kernel(s)
 

Private Attributes

SpiceDouble m_ra
 Right ascension (sky longitude)
 
SpiceDouble m_dec
 Decliation (sky latitude)
 
QVector< QString > * m_kernels
 Vector containing kernels filenames.
 
iTimem_startTime
 Corrected start (shutter open) time of the observation.
 
iTimem_endTime
 Corrected end (shutter close) time of the observation.
 
SpiceDouble * m_cacheSize
 Cache size. Note: This value is 1 for Framing cameras.
 
SpiceDouble * m_startTimePadding
 Kernels pvl group StartPadding keyword value.
 
SpiceDouble * m_endTimePadding
 Kernels pvl group EndPadding keyword value.
 
SpicePositionm_instrumentPosition
 Instrument spice position.
 
SpiceRotationm_instrumentRotation
 Instrument spice rotation.
 
SpicePositionm_sunPosition
 Sun spice position.
 
SpiceRotationm_bodyRotation
 Body spice rotation.
 
bool m_allowDownsizing
 Indicates whether to allow downsizing.
 
SpiceInt * m_spkCode
 Spacecraft and planet ephemeris kernel (SPK) code.
 
SpiceInt * m_ckCode
 Camera kernel (CK) code.
 
SpiceInt * m_ikCode
 Instrument kernel (IK) code.
 
SpiceInt * m_sclkCode
 Spacecraft clock correlation kernel (SCLK) code.
 
SpiceInt * m_spkBodyCode
 Spacecraft and planet ephemeris kernel (SPK) body code.
 
SpiceInt * m_bodyFrameCode
 Naif's BODY_FRAME_CODE value.
 
PvlObjectm_naifKeywords
 NaifKeywords PvlObject from cube.
 
bool m_usingNaif
 Indicates whether we are reading values from the NaifKeywords PvlObject in cube.
 
bool m_usingAle
 Indicate whether we are reading values from an ISD returned from ALE.
 

Detailed Description

Class for computing sensor ground coordinates.

The sensor class allows for the computation of parameters related to orbiting instruments. In particular, a time and look direction can be set and from those the ground coordinate (latitude/longitude) along with phase, incidence, and emission angles can be computed. Likewise, a ground point can be set and look direction can be computed. This class is derived from the Spice class.

An important capability of this class is the ability to use a surface model other than an ellipsoid when intersecting the look direction of the sensor with the planetary body. This allows for the generation of othrorectified products. The file containing the surface model is a cube and is obtained from the labels in the follow form:

Group = Kernels
ElevationModel = file.cub
EndGroup
Determine SPICE kernels defined in an ISIS file.
Definition Kernels.h:94
Author
2003-04-11 Jeff Anderson
History

2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...

2003-05-30 Jeff Anderson - Updated unitTest and truth to account for precision due to optimization

2003-10-16 Jeff Anderson - Added LoadEulerMounting() and LoadFrameMounting() methods

2003-11-26 Jeff Anderson - Modified FrameMounting() methods to allow for fixed frames or time dependent frames

2004-01-14 Jeff Anderson - Remove an unused constructor

2004-01-20 Jeff Anderson - Added an option to the SetUniversalGround() method to eliminate checks for points on the backside of the target

2004-02-18 Jeff Anderson - Fixed a problem with the FrameMounting() methods as the frame kernel is unloaded if a cache is created.

2004-02-23 Jeff Anderson - Fixed two bugs in the handling of DEMs. Used universal lat/lon when appropriate and the radius needed to be converted to km when read from the DEM file.

2005-02-15 Elizabeth Ribelin - Modified file to support Doxygen documentation

2005-02-24 Jeff Anderson - Added SlantDistance() method and made the constructor ignore the ElevationModel keyword if it is null

2005-02-25 Jeff Anderson - Added LocalSolarTime() method

2005-06-09 Elizabeth Ribelin - Added LoadEulerMounting() method that accepts a matrix as a parameter

2005-08-24 Jeff Anderson - Make sure LocalSolarTime always return positive hours

2005-09-20 Jeff Anderson - Added tests for trying to intersect the sky

2006-03-31 Elizabeth Miller - Added SpacecraftAltitude() and SolarDistance() methods

2006-09-07 Debbie A. Cook - Changed back-of-planet test to use emission angle instead of length of vector to surface point

2006-10-11 Jeff Anderson - Modified reading radius from DEM using bilinear interpolation

2006-10-12 Jeff Anderson - Modified the SetLookDirection() method to use the DEM (if available) when computing a ground point

2007-05-18 Jeff Anderson - Modify SpacecraftAltitude() method to use DEM

2007-06-11 Debbie A. Cook - Added alternative method that includes radius

2007-08-24 Debbie A. Cook - Replaced references to m_sB since it was removed from Spice

2007-11-27 Debbie A. Cook - Added overloaded method SetUniversalGround(lat, lon, radius)

2008-05-21 Steven Lambright - CubeManager is now used to speed up DEM Cube I/O

2008-06-18 Debbie A. Cook - Made DemRadius radius public instead of private and added method HasElevationModel()

2008-08-06 Stuart Sides - Modified SetLookDirection() to better handle oblique views. In the past it would oscillate and run out of iterations.

2009-02-06 Debbie A. Cook - Changed the tolerance from 1e-6 to 1e-12 for dist**2 (mm)

2009-02-06 Debbie A. Cook - Changed the tolerance back to 1e-6 (mm)

2009-02-15 Debbie A. Cook - Added virtual Resolution() method

2009-06-30 Steven Lambright - Added IgnoreElevationModel() and fixed DemRadius()

2009-07-09 Debbie A. Cook - Corrected documentation on Resolution() method

2009-09-23 Tracie Sucharski - Convert negative longitudes returned by reclat in SetLookDirection().

2010-09-15 Janet Barrett - Modified the SetLookDirection() method to use a new algorithm for finding the intersection of a ray with the DEM. This was required to take care of problems that were encountered at the poles of global DEM files. The algorithm that is being used was taken from "Intersection between spacecraft viewing vectors and digital elevation models" by N.A. Teanby.

2010-11-09 Eric Hyer - moved some private members to protected section for Camera

2010-12-07 Steven Lambright - Added LocalRadius(lat,lon) and removed a sqrt from SetLookDirection()

2011-01-26 Steven Lambright - The LocalRadius methods now return Distance objects and added a LocalRadius() method that uses the Latitude and Longitude classes.

2011-02-08 Jeannie Walldren - Added method parameter documentation.

2011-02-09 Steven Lambright & Debbie Cook - Refactored heavily to use Latitude, Longitude, SurfacePoint, and iTime where applicable. Optimized SetLookDirection. These changes were meant primarily for readability and reducing error-proneness of the code.

2011-03-28 Janet Barrett - Fixed the SetLookDirection routine so that it checks to make sure that the projection of the DEM is in an Equatorial cylindrical projection before using the new ray tracing routine. The check for this was moved when other code was added. This was causing a problem with footprintinit.

2011-05-03 Jeannie Walldren - Added Isis Disclaimer to files.

2011-05-25 Janet Barrett and Steven Lambright - Moved the ownership of the DEM projection to the DEM cube which is owned by CubeManager.

2011-08-22 Steven Lambright - The DEM cube now uses a UniqueIOCachingAlgorithm(5). This will probably behave better in all cases. Fixes #364

2011-08-16 Jeff Anderson - Fixed a problem with an infinite loop in the ray tracing algorithm. The problem was first exposed when trying to intersect the Vesta DEM on the limb.

2011-12-20 Tracie Sucharski - Added SpacecraftSurfaceVector method which returns the vector between the spacecraft and the surface point in body-fixed.

2012-05-04 Steven Lambright - Re-enabled a safety check in the DemRadius() method which was needed due to Projection not uniformly handling Null inputs. Fixes #807.

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

2012-09-06 Steven Lambright and Stuart Sides - Changed the constructors to take Cube instead of Pvl to prevent redundant parsing. This should eventually be refactored into a CubeLabel or similar object so that an actual cube isn't required in the future, but for now this enables the control net GUI to create a camera from a cube with no dimensions in the label.

2012-10-10 Debbie A. Cook - Moved the functionality related to the shape model into new classes: ShapeModel, EllipsoidShape, DemShape, and EquatorialCylindricalShape. Also modified to use new Target class. References #775 and #1114

2012-10-25 Jeannie Backer - Changed resolution() method to lower camel case. References #1181.

2012-03-04 Tracie Sucharski - Added new method, PixelIfovOffsets, which will return the ifov offsets from the center of the pixel in mm. This is a virtual method and if not implemented in the specific instrument camera, this class will throw an error. References #1604.

2015-08-11 Ian Humphrey and Makayla Shepherd - Added pure virtual methods to return the long and short spacecraft and instrument names.

2015-10-01 Jeannie Backer - Made improvements to documentation and brought code closer to ISIS coding standards. References #1438

2017-03-23 Kris Becker - Added support for occlusion checks. Modified SetLocalGround(bool backCheck) to make a callback to the ShapeModel::isOccludedFrom() to test for point visability.

2021-02-17 Kristin Berry, Jesse Mapel, and Stuart Sides - Made several functions virtual and moved look vector member variable to protected. Ensured that m_newLookB always initializes to the same value.

Definition at line 170 of file Sensor.h.

Member Enumeration Documentation

◆ SpiceValueType

enum Isis::Spice::SpiceValueType
protectedinherited

NAIF value primitive type.

Enumerator
SpiceDoubleType 

SpiceDouble type.

SpiceStringType 

SpiceString type.

SpiceIntType 

SpiceInt type.

SpiceByteCodeType 

SpiceByteCode type.

Definition at line 348 of file Spice.h.

Constructor & Destructor Documentation

◆ Sensor()

Isis::Sensor::Sensor ( Cube & cube)

Constructs a Sensor object and loads SPICE kernels using information from the label object.

The constructor expects an Instrument and Kernels group to be in the labels (see Spice documentation).

Parameters
cubeCube whose label contains Instrument and Kernels groups.

Definition at line 47 of file Sensor.cpp.

References m_newLookB.

◆ ~Sensor()

Isis::Sensor::~Sensor ( )
virtual

Destroys the Sensor.

Definition at line 53 of file Sensor.cpp.

Member Function Documentation

◆ bodyRotation()

SpiceRotation * Isis::Spice::bodyRotation ( ) const
virtualinherited

Accessor method for the body rotation.

Returns
iTime Body rotation for the image.
Author
Steven Lambright
History
2011-02-09 Steven Lambright - Original version.

Reimplemented in Isis::CSMCamera.

Definition at line 1623 of file Spice.cpp.

References Isis::Spice::m_bodyRotation.

Referenced by computeRaDec(), EmissionAngle(), Isis::CameraGroundMap::GetdXYdPoint(), Isis::CameraGroundMap::GetdXYdTOrientation(), Isis::CameraGroundMap::GetXY(), lookDirectionJ2000(), Isis::MiniRF::MiniRF(), SetGround(), SetGroundLocal(), SetLookDirection(), SetUniversalGround(), and SetUniversalGround().

◆ cacheEndTime()

iTime Isis::Spice::cacheEndTime ( ) const
virtualinherited

Accessor method for the cache end time.

Returns
iTime End time for the image.
Author
Steven Lambright
History
2011-02-09 Steven Lambright - Original version.

Definition at line 765 of file Spice.cpp.

References Isis::Spice::m_endTime.

Referenced by LineOffsetFunctor::operator()().

◆ cacheStartTime()

iTime Isis::Spice::cacheStartTime ( ) const
virtualinherited

Accessor method for the cache start time.

Returns
iTime Start time for the image.
Author
Steven Lambright
History
2011-02-09 Steven Lambright - Original version.

Definition at line 750 of file Spice.cpp.

References Isis::Spice::m_startTime.

Referenced by LineOffsetFunctor::operator()().

◆ computeRaDec()

void Isis::Sensor::computeRaDec ( )
private

Computes the ra/dec from the look direction.

Protected method which computes the ra/dec of the current look direction.

Definition at line 589 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), m_dec, m_lookB, m_newLookB, m_ra, Isis::PI, and Isis::RAD2DEG.

Referenced by Declination(), and RightAscension().

◆ computeSolarLongitude()

◆ Coordinate()

void Isis::Sensor::Coordinate ( double p[3]) const

◆ createCache()

void Isis::Spice::createCache ( iTime startTime,
iTime endTime,
const int size,
double tol )
virtualinherited

This method creates an internal cache of spacecraft and sun positions over a specified time range.

The SPICE kernels are then immediately unloaded. This allows multiple instances of the Spice object to be created as the NAIF toolkit can clash if multiple sets of SPICE kernels are loaded. Note that the cache size is specified as an argument. Therefore, times requested via setTime() which are not directly loaded in the cache will be interpolated. If the instrument position is not cached and cacheSize is greater than 3, the tolerance is passed to the SpicePosition Memcache2HermiteCache() method.

Note: Before this method is called, the private variables m_cacheSize, m_startTime and m_endTime must be set. This is done in the Camera classes using the methods SetCacheSize() and SetStartEndEphemerisTime().

Parameters
startTimeStarting ephemeris time to cache
endTimeEnding ephemeris time to cache
sizeSize of the cache.
tolTolerance.
Exceptions
Isis::IException::Programmer- "Argument cacheSize must be greater than zero"
Isis::IException::Programmer- "Argument startTime must be less than or equal to endTime"
Isis::IException::User- "This instrument does not support time padding"
History
2011-04-10 Debbie A. Cook - Updated to only create cache for instrumentPosition if type is Spice.

Definition at line 649 of file Spice.cpp.

References Isis::SpicePosition::cacheSize(), Isis::NaifStatus::CheckErrors(), Isis::Spice::computeSolarLongitude(), Isis::iTime::Et(), Isis::SpicePosition::GetSource(), Isis::SpiceRotation::GetSource(), Isis::SpicePosition::HasVelocity(), Isis::Spice::instrumentPosition(), Isis::SpicePosition::IsCached(), Isis::SpiceRotation::IsCached(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::Spice::m_bodyRotation, Isis::Spice::m_cacheSize, Isis::Spice::m_endTime, Isis::Spice::m_endTimePadding, Isis::Spice::m_et, Isis::Spice::m_instrumentPosition, Isis::Spice::m_instrumentRotation, Isis::Spice::m_kernels, Isis::Spice::m_startTime, Isis::Spice::m_startTimePadding, Isis::Spice::m_sunPosition, Isis::SpicePosition::Memcache, Isis::SpiceRotation::Memcache, Isis::SpicePosition::Memcache2HermiteCache(), Isis::SpiceRotation::MinimizeCache(), Isis::IException::Programmer, Isis::IException::User, and Isis::SpiceRotation::Yes.

Referenced by Isis::CrismCamera::CrismCamera(), Isis::Camera::LoadCache(), and Isis::MiniRF::MiniRF().

◆ csmInit()

void Isis::Spice::csmInit ( Cube & cube,
Pvl label )
privateinherited

Initialize the Spice object for a CSMCamera.

This sets up the Spice/Sensor/Camera object to not have any SPICE dependent members initialized.

Parameters
cubeThe Cube containing image data for the camera
labelThe label containing information for the camera

Definition at line 97 of file Spice.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::Spice::defaultInit(), and Isis::Spice::m_target.

Referenced by Isis::Spice::Spice().

◆ Declination()

double Isis::Sensor::Declination ( )
virtual

Returns the declination angle (sky latitude).

Returns
double Declination angle, in degrees.

Reimplemented in Isis::CSMCamera.

Definition at line 578 of file Sensor.cpp.

References computeRaDec(), m_dec, and m_newLookB.

Referenced by Isis::Camera::CelestialNorthClockAngle(), Isis::CameraPointInfo::GetPointInfo(), Isis::VimsSkyMap::Init(), Isis::Camera::RaDecRange(), Isis::Camera::RaDecResolution(), and Isis::Camera::RawFocalPlanetoImage().

◆ defaultInit()

◆ EmissionAngle()

◆ getClockTime()

iTime Isis::Spice::getClockTime ( QString clockValue,
int sclkCode = -1,
bool clockTicks = false )
virtualinherited

This converts the spacecraft clock ticks value (clockValue) to an iTime.

If the clock ticks value is provided directly, rather than the spacecraft clock string, set clockTicks=true.

Use this when possible because naif calls (such as scs2e_c) cannot be called when not using naif.

Definition at line 1060 of file Spice.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::Spice::naifSclkCode(), Isis::Spice::SpiceDoubleType, and Isis::toString().

Referenced by Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::Hyb2OncCamera::Hyb2OncCamera(), Isis::VimsGroundMap::Init(), Isis::VimsSkyMap::Init(), Isis::JunoCamera::JunoCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::OsirisRexOcamsCamera::OsirisRexOcamsCamera(), Isis::DawnVirCamera::readHouseKeeping(), Isis::RosettaVirtisCamera::readHouseKeeping(), Isis::RosettaVirtisCamera::readSCET(), Isis::RosettaOsirisCamera::RosettaOsirisCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::VikingCamera::VikingCamera(), and Isis::VimsCamera::VimsCamera().

◆ getDouble()

SpiceDouble Isis::Spice::getDouble ( const QString & key,
int index = 0 )
inherited

This returns a value from the NAIF text pool.

It is a static convience method

Parameters
keyName of NAIF keyword to obtain from the pool
indexIf the keyword is an array, the element to obtain. Defaults to 0
Returns
SpiceDouble Spice double from NAIF text pool
Exceptions
Isis::iException::Io- "Can not find key in instrument kernels."

Definition at line 1046 of file Spice.cpp.

References Isis::Spice::readValue(), and Isis::Spice::SpiceDoubleType.

Referenced by Isis::LroWideAngleCameraDistortionMap::addFilter(), Isis::LroWideAngleCameraFocalPlaneMap::addFilter(), Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::ClipperPushBroomCamera::ClipperPushBroomCamera(), Isis::MdisCamera::computeFocalLength(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::HiresCamera::HiresCamera(), Isis::HrscCamera::HrscCamera(), Isis::Hyb2OncCamera::Hyb2OncCamera(), Isis::CameraFocalPlaneMap::Init(), Isis::Spice::init(), Isis::RosettaOsirisCamera::initDistortion(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::JunoCamera::JunoCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), Isis::KaguyaTcCameraDistortionMap::KaguyaTcCameraDistortionMap(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::MarciDistortionMap::MarciDistortionMap(), Isis::Mariner10Camera::Mariner10Camera(), Isis::MdisCamera::MdisCamera(), Isis::MexHrscSrcCamera::MexHrscSrcCamera(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::NirCamera::NirCamera(), Isis::OsirisRexOcamsCamera::OsirisRexOcamsCamera(), Isis::RosettaOsirisCamera::RosettaOsirisCamera(), Isis::RosettaVirtisCamera::RosettaVirtisCamera(), Isis::KaguyaMiCameraDistortionMap::SetDistortion(), Isis::LroNarrowAngleDistortionMap::SetDistortion(), Isis::TaylorCameraDistortionMap::SetDistortion(), Isis::Camera::SetFocalLength(), Isis::Camera::SetPixelPitch(), Isis::SsiCamera::SsiCamera(), Isis::TgoCassisCamera::TgoCassisCamera(), Isis::TgoCassisDistortionMap::TgoCassisDistortionMap(), and Isis::UvvisCamera::UvvisCamera().

◆ getInteger()

SpiceInt Isis::Spice::getInteger ( const QString & key,
int index = 0 )
inherited

This returns a value from the NAIF text pool.

It is a static convience

Parameters
keyName of NAIF keyword to obtain from the pool
indexIf the keyword is an array, the element to obtain. Defaults to 0
Returns
SpiceInt Spice integer from NAIF text pool
Exceptions
Isis::iException::Io- "Can not find key in instrument kernels

Definition at line 1032 of file Spice.cpp.

References Isis::Spice::readValue(), and Isis::Spice::SpiceIntType.

Referenced by Isis::DawnVirCamera::getPointingTable(), Isis::RosettaVirtisCamera::getPointingTable(), Isis::LroWideAngleCamera::GetVector(), Isis::Spice::init(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::Target::lookupNaifBodyCode(), and Isis::LroWideAngleCamera::LroWideAngleCamera().

◆ GetLatitude()

Latitude Isis::Sensor::GetLatitude ( ) const

Returns a planetocentric latitude object at the surface intersection point in body fixed.

Returns
Latidude Universal latitude object.

Definition at line 223 of file Sensor.cpp.

References Isis::Spice::target().

Referenced by Isis::ControlNetFilter::PointLatLonFilter(), and UniversalLatitude().

◆ GetLongitude()

Longitude Isis::Sensor::GetLongitude ( ) const

Returns a positive east, 0-360 domain longitude object at the surface intersection point in the body fixed coordinate system.

Returns
Longitude Universal longitude object.

Definition at line 247 of file Sensor.cpp.

References Isis::Spice::target().

Referenced by UniversalLongitude().

◆ getStoredNaifKeywords()

PvlObject Isis::Spice::getStoredNaifKeywords ( ) const
inherited

This returns the PvlObject that stores all of the requested Naif data and can be a replacement for furnishing text kernels.

Definition at line 1005 of file Spice.cpp.

References Isis::Spice::m_naifKeywords.

Referenced by Isis::LroWideAngleCamera::GetVector().

◆ getStoredResult()

QVariant Isis::Spice::getStoredResult ( QString name,
SpiceValueType type )
protectedinherited

Definition at line 1180 of file Spice.cpp.

◆ getString()

QString Isis::Spice::getString ( const QString & key,
int index = 0 )
inherited

This returns a value from the NAIF text pool.

It is a static convience method

Parameters
keyName of NAIF keyword to obtain from the pool
indexIf the keyword is an array, the element to obtain. Defaults to 0
Returns
QString Value from the NAIF text pool
Exceptions
Isis::IException::Io- "Can not find key in instrument kernels."

Definition at line 1273 of file Spice.cpp.

References Isis::Spice::readValue(), and Isis::Spice::SpiceStringType.

Referenced by Isis::LightTimeCorrectionState::checkAberrationCorrection(), Isis::LightTimeCorrectionState::checkLightTimeToSurfaceCorrect(), Isis::LightTimeCorrectionState::checkObserverTargetSwap(), Isis::MdisCamera::computeFocalLength(), Isis::MdisCamera::MdisCamera(), and Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera().

◆ GetSurfacePoint()

SurfacePoint Isis::Sensor::GetSurfacePoint ( ) const
virtual

◆ hasKernels()

bool Isis::Spice::hasKernels ( Pvl & lab)
inherited

Returns true if the kernel group has kernel files.

Parameters
labLabel containing Instrument and Kernels groups.
Returns
bool status of kernel files in the kernel group

Definition at line 1538 of file Spice.cpp.

References Isis::PvlContainer::hasKeyword(), Isis::PvlKeyword::size(), and Isis::PvlObject::Traverse.

◆ HasSurfaceIntersection()

bool Isis::Sensor::HasSurfaceIntersection ( ) const

Returns if the last call to either SetLookDirection or SetUniversalGround had a valid intersection with the target.

If so then other methods such as Coordinate, UniversalLatitude, UniversalLongitude, etc can be used with confidence.

Returns
bool True if the look direction intersects with the target.

Definition at line 188 of file Sensor.cpp.

References Isis::Spice::target().

Referenced by Isis::Camera::ComputeAzimuth(), Isis::Camera::DetectorResolution(), Isis::CSMCamera::DetectorResolution(), Isis::CameraPointInfo::GetPointInfo(), Isis::CSMCamera::LineResolution(), Isis::Camera::ObliqueDetectorResolution(), Isis::CSMCamera::SampleResolution(), Isis::VimsGroundMap::SetGround(), and Isis::Camera::SetImageSkyMapProjection().

◆ IgnoreElevationModel()

void Isis::Sensor::IgnoreElevationModel ( bool ignore)

This allows you to ignore the cube elevation model and use the ellipse.

Parameters
ignoreIndicates whether the elevation model is ignored.

Definition at line 62 of file Sensor.cpp.

References Isis::Spice::target().

Referenced by Isis::StereoTool::calculateElevation(), Isis::ImagePolygon::Create(), and Isis::ImagePolygon::initCube().

◆ IncidenceAngle()

double Isis::Sensor::IncidenceAngle ( ) const
virtual

Returns the incidence angle in degrees.

This does not use the surface model.

Returns
double Incidence angle, in degrees.

Reimplemented in Isis::CSMCamera.

Definition at line 339 of file Sensor.cpp.

References Isis::Spice::m_uB, and Isis::Spice::target().

Referenced by Isis::PhotometricFunction::compute(), Isis::ImagePolygon::FixPolePoly(), Isis::CameraPointInfo::GetPointInfo(), Isis::InterestOperator::InterestByMeasure(), and Isis::ImagePolygon::SetImage().

◆ init()

void Isis::Spice::init ( Pvl & lab,
bool noTables,
nlohmann::json isd = NULL )
privateinherited

Initialization of Spice object.

Parameters
labPvl labels
noTablesIndicates the use of tables.
Exceptions
Isis::IException::Io- "Can not find NAIF code for NAIF target"
Isis::IException::Camera- "No camera pointing available"
Isis::IException::Camera- "No instrument position available"
History
2011-02-08 Jeannie Walldren - Initialize pointers to null.

Definition at line 154 of file Spice.cpp.

References Isis::SpicePosition::cacheSize(), Isis::NaifStatus::CheckErrors(), Isis::Spice::defaultInit(), Isis::Angle::Degrees, Isis::PvlObject::findObject(), Isis::Spice::getDouble(), Isis::Spice::getInteger(), Isis::PvlObject::hasKeyword(), Isis::PvlContainer::hasKeyword(), Isis::IException::Io, Isis::Target::isSky(), Isis::Distance::Kilometers, Isis::Spice::load(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::SpiceRotation::LoadTimeCache(), Isis::Spice::m_bodyFrameCode, Isis::Spice::m_bodyRotation, Isis::Spice::m_ckCode, Isis::Spice::m_endTimePadding, Isis::Spice::m_ikCode, Isis::Spice::m_instrumentPosition, Isis::Spice::m_instrumentRotation, Isis::Spice::m_naifKeywords, Isis::Spice::m_sclkCode, Isis::Spice::m_solarLongitude, Isis::Spice::m_spkBodyCode, Isis::Spice::m_spkCode, Isis::Spice::m_startTimePadding, Isis::Spice::m_sunPosition, Isis::Spice::m_target, Isis::Spice::m_usingAle, Isis::Spice::m_usingNaif, Isis::SpicePosition::Memcache2HermiteCache(), Isis::SpiceRotation::MinimizeCache(), Isis::Target::naifBodyCode(), Isis::ShapeModel::name(), Isis::Target::name(), Isis::Target::radii(), Isis::Spice::radii(), Isis::Target::setRadii(), Isis::Target::shape(), Isis::Spice::solarLongitude(), Isis::Spice::SpiceIntType, Isis::toDouble(), Isis::toInt(), Isis::toString(), Isis::PvlObject::Traverse, Isis::IException::Unknown, and Isis::SpiceRotation::Yes.

Referenced by Isis::Spice::Spice(), and Isis::Spice::Spice().

◆ instrumentBodyFixedPosition()

void Isis::Spice::instrumentBodyFixedPosition ( double p[3]) const
virtualinherited

Returns the spacecraft position in body-fixed frame km units.

Parameters
p[]Spacecraft position
See also
setTime()
Exceptions
Isis::iException::Programmer- "You must call SetTime first"

Reimplemented in Isis::CSMCamera.

Definition at line 842 of file Spice.cpp.

References Isis::SpicePosition::Coordinate(), Isis::Spice::m_bodyRotation, Isis::Spice::m_et, Isis::Spice::m_instrumentPosition, Isis::IException::Programmer, and Isis::SpiceRotation::ReferenceVector().

Referenced by Isis::IsisSensor::getState(), Isis::IsisSensor::getState(), Isis::Spice::instrumentPosition(), Isis::Camera::LocalPhotometricAngles(), PhaseAngle(), and SlantDistance().

◆ instrumentBodyFixedVelocity()

void Isis::Spice::instrumentBodyFixedVelocity ( double v[3]) const
virtualinherited

Returns the spacecraft velocity in body-fixed frame km/sec units.

Parameters
v[]Spacecraft velocity

Definition at line 860 of file Spice.cpp.

References Isis::SpicePosition::Coordinate(), Isis::Spice::m_bodyRotation, Isis::Spice::m_et, Isis::Spice::m_instrumentPosition, Isis::IException::Programmer, Isis::SpiceRotation::ReferenceVector(), and Isis::SpicePosition::Velocity().

◆ instrumentNameLong()

virtual QString Isis::Sensor::instrumentNameLong ( ) const
pure virtual

Implemented in Isis::Camera, and Isis::IdealCamera.

◆ instrumentNameShort()

virtual QString Isis::Sensor::instrumentNameShort ( ) const
pure virtual

Implemented in Isis::Camera, and Isis::IdealCamera.

◆ instrumentPosition() [1/2]

SpicePosition * Isis::Spice::instrumentPosition ( ) const
virtualinherited

◆ instrumentPosition() [2/2]

void Isis::Spice::instrumentPosition ( double p[3]) const
inherited

Returns the spacecraft position in body-fixed frame km units.

Parameters
p[]Spacecraft position
See also
setTime()
Exceptions
Isis::iException::Programmer- "You must call SetTime first"

Definition at line 829 of file Spice.cpp.

References Isis::Spice::instrumentBodyFixedPosition().

Referenced by Isis::CameraGroundMap::GetdXYdPosition(), Isis::CameraPointInfo::GetPointInfo(), and Isis::CameraGroundMap::GetXY().

◆ instrumentRotation()

◆ isTimeSet()

bool Isis::Spice::isTimeSet ( )
inherited

Returns true if time has been initialized.

Author
2016-10-19 Kristin Berry
Returns
bool true if time has been set

Definition at line 1589 of file Spice.cpp.

References Isis::Spice::m_et.

Referenced by Isis::CameraDetectorMap::SetParent(), and Isis::RollingShutterCameraDetectorMap::SetParent().

◆ isUsingAle()

bool Isis::Spice::isUsingAle ( )
inherited

Definition at line 1638 of file Spice.cpp.

◆ load()

void Isis::Spice::load ( PvlKeyword & key,
bool noTables )
privateinherited

Loads/furnishes NAIF kernel(s)

Parameters
keyPvlKeyword
noTablesIndicates the use of tables.
Exceptions
Isis::IException::Io- "Spice file does not exist."

Definition at line 486 of file Spice.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::IException::Io, Isis::Spice::m_kernels, and Isis::PvlKeyword::size().

Referenced by Isis::Spice::init().

◆ LocalRadius() [1/3]

◆ LocalRadius() [2/3]

Distance Isis::Sensor::LocalRadius ( double lat,
double lon )

Returns the local radius at the intersection point.

This is either the radius on the ellipsoid, the radius from the surface model passed into the constructor, or the radius set with SetUniversalGround.

Parameters
lat
lon
Returns
Distance The distance from the center of the planet to this lat,lon in meters.

Definition at line 303 of file Sensor.cpp.

References Isis::Angle::Degrees, and Isis::Spice::target().

◆ LocalRadius() [3/3]

Distance Isis::Sensor::LocalRadius ( Latitude lat,
Longitude lon )

Returns the local radius at the intersection point.

This is either the radius on the ellipsoid, the radius from the surface model passed into the constructor, or the radius set with SetUniversalGround.

Parameters
lat
lon
Returns
Distance The distance from the center of the planet to this lat,lon in meters.

Definition at line 287 of file Sensor.cpp.

References Isis::Spice::target().

◆ LocalSolarTime()

double Isis::Sensor::LocalSolarTime ( )

Return the local solar time in hours.

Returns
double Local solar time, in hours.

Definition at line 665 of file Sensor.cpp.

References Isis::Spice::subSolarPoint(), and UniversalLongitude().

Referenced by Isis::CameraPointInfo::GetPointInfo().

◆ LookDirection()

void Isis::Sensor::LookDirection ( double v[3]) const

Returns the look direction in the camera coordinate system.

Parameters
v[]The look vector.

Definition at line 527 of file Sensor.cpp.

References Isis::Spice::instrumentRotation(), and lookDirectionJ2000().

Referenced by Isis::CameraPointInfo::GetPointInfo(), and Isis::PixelFOV::instantaneousFov().

◆ lookDirectionBodyFixed()

vector< double > Isis::Sensor::lookDirectionBodyFixed ( ) const
virtual

Returns the look direction in the body fixed coordinate system.

Returns
vector<double> Look direction in body fixed coordinate system.

Definition at line 539 of file Sensor.cpp.

References m_lookB.

Referenced by Isis::CameraPointInfo::GetPointInfo(), Isis::IsisSensor::getState(), Isis::IsisSensor::getState(), lookDirectionJ2000(), and SetGroundLocal().

◆ lookDirectionJ2000()

vector< double > Isis::Sensor::lookDirectionJ2000 ( ) const
virtual

Returns the look direction in the camera coordinate system.

Returns
vector<double> Look direction in J2000 cooridinate system.

Definition at line 553 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), and lookDirectionBodyFixed().

Referenced by Isis::CameraPointInfo::GetPointInfo(), Isis::IsisSensor::getState(), Isis::IsisSensor::getState(), and LookDirection().

◆ naifBodyCode()

SpiceInt Isis::Spice::naifBodyCode ( ) const
inherited

This returns the NAIF body code of the target indicated in the labels.

Returns
SpiceInt NAIF body code

Definition at line 948 of file Spice.cpp.

References Isis::Spice::m_target, and Isis::Target::naifBodyCode().

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

◆ naifBodyFrameCode()

SpiceInt Isis::Spice::naifBodyFrameCode ( ) const
inherited

This returns the NAIF body frame code.

It is read from the labels, if it exists. Otherwise, it's calculated by the init() method.

Returns
SpiceInt NAIF body frame code

Definition at line 996 of file Spice.cpp.

References Isis::Spice::m_bodyFrameCode.

◆ naifCkCode()

SpiceInt Isis::Spice::naifCkCode ( ) const
inherited

This returns the NAIF CK code to use when reading from CK kernels.

Returns
SpiceInt NAIF CK code

Definition at line 966 of file Spice.cpp.

References Isis::Spice::m_ckCode.

◆ naifIkCode()

SpiceInt Isis::Spice::naifIkCode ( ) const
inherited

This returns the NAIF IK code to use when reading from instrument kernels.

Returns
SpiceInt NAIF IK code

Definition at line 975 of file Spice.cpp.

References Isis::Spice::m_ikCode.

Referenced by Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), Isis::ClipperNacRollingShutterCamera::ClipperNacRollingShutterCamera(), Isis::ClipperPushBroomCamera::ClipperPushBroomCamera(), Isis::ClipperWacFcCamera::ClipperWacFcCamera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::Hyb2OncCamera::Hyb2OncCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::JunoCamera::JunoCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::Mariner10Camera::Mariner10Camera(), Isis::MdisCamera::MdisCamera(), Isis::MexHrscSrcCamera::MexHrscSrcCamera(), Isis::MiniRF::MiniRF(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::NirCamera::NirCamera(), Isis::OsirisRexOcamsCamera::OsirisRexOcamsCamera(), Isis::RosettaOsirisCamera::RosettaOsirisCamera(), Isis::RosettaVirtisCamera::RosettaVirtisCamera(), Isis::Camera::SetFocalLength(), Isis::Camera::SetPixelPitch(), Isis::SsiCamera::SsiCamera(), Isis::TgoCassisCamera::TgoCassisCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::UvvisCamera::UvvisCamera(), Isis::VikingCamera::VikingCamera(), Isis::VimsCamera::VimsCamera(), and Isis::VoyagerCamera::VoyagerCamera().

◆ naifSclkCode()

SpiceInt Isis::Spice::naifSclkCode ( ) const
inherited

This returns the NAIF SCLK code to use when reading from instrument kernels.

Returns
SpiceInt NAIF SCLK code

Definition at line 985 of file Spice.cpp.

References Isis::Spice::m_sclkCode.

Referenced by Isis::CrismCamera::CrismCamera(), and Isis::Spice::getClockTime().

◆ naifSpkCode()

SpiceInt Isis::Spice::naifSpkCode ( ) const
inherited

This returns the NAIF SPK code to use when reading from SPK kernels.

Returns
SpiceInt NAIF SPK code

Definition at line 957 of file Spice.cpp.

References Isis::Spice::m_spkCode.

Referenced by Isis::DawnVirCamera::readHouseKeeping(), Isis::RosettaVirtisCamera::readHouseKeeping(), Isis::RosettaVirtisCamera::readSCET(), and Isis::Camera::SpkTargetId().

◆ PhaseAngle()

double Isis::Sensor::PhaseAngle ( ) const
virtual

Returns the phase angle in degrees.

This does not use the surface model.

Returns
double Phase angle, in degrees.

Reimplemented in Isis::CSMCamera.

Definition at line 314 of file Sensor.cpp.

References Coordinate(), Isis::Spice::instrumentBodyFixedPosition(), Isis::Spice::m_uB, and Isis::RAD2DEG.

Referenced by Isis::PhotometricFunction::compute(), and Isis::CameraPointInfo::GetPointInfo().

◆ PixelIfovOffsets()

QList< QPointF > Isis::Sensor::PixelIfovOffsets ( )
virtual

This method is implemented in Camera which defaults to the (pixel pitch * summing mode ) / 2.

If the instrument has a non-square ifov, it must implement this method to return offsets from the center of the pixel.

Author
tsucharski (3/8/2013)
Returns
QList<QPointF>

Reimplemented in Isis::Camera, Isis::CSMCamera, Isis::VimsCamera, and Isis::HayabusaNirsCamera.

Definition at line 83 of file Sensor.cpp.

References Isis::IException::Programmer.

◆ radii()

void Isis::Spice::radii ( Distance r[3]) const
inherited

Returns the radii of the body in km.

The radii are obtained from the appropriate SPICE kernel for the body specified by TargetName in the Instrument group of the labels.

Parameters
r[]Radii of the target in kilometers

Definition at line 937 of file Spice.cpp.

References Isis::Spice::m_target, and Isis::Target::radii().

Referenced by Isis::Camera::BasicMapping(), Isis::CameraPointInfo::GetPointInfo(), Isis::Camera::GroundRange(), Isis::VimsGroundMap::Init(), Isis::Spice::init(), Isis::MiniRF::MiniRF(), Isis::CSMCamera::setTarget(), Isis::Spice::subSolarPoint(), and Isis::Spice::subSpacecraftPoint().

◆ readStoredValue()

QVariant Isis::Spice::readStoredValue ( QString key,
SpiceValueType type,
int index )
protectedinherited

Definition at line 1232 of file Spice.cpp.

◆ readValue()

QVariant Isis::Spice::readValue ( QString key,
SpiceValueType type,
int index = 0 )
protectedinherited

This should be used for reading ALL text naif kernel values.

This will read it from Naif if we're using naif/not attached kernels. If we have attached kernels and a NaifKeywords label object we will grab it from there instead. This allows us to not furnish kernels after spiceinit.

Parameters
keyThe naif keyword,value name
typeThe naif value's primitive type
indexThe index into the naif keyword array to read

Definition at line 1100 of file Spice.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::IException::Io, Isis::Spice::m_usingAle, Isis::Spice::m_usingNaif, Isis::Spice::SpiceDoubleType, Isis::Spice::SpiceIntType, Isis::Spice::SpiceStringType, and Isis::IException::Unknown.

Referenced by Isis::Spice::getDouble(), Isis::Spice::getInteger(), Isis::Spice::getString(), and Isis::IdealCamera::IdealCamera().

◆ resolution()

virtual double Isis::Sensor::resolution ( )
inlinevirtual

Virtual method that returns the pixel resolution of the sensor in meters/pix.

Returns
double Resolution value of 1.0

Reimplemented from Isis::Spice.

Reimplemented in Isis::Camera.

Definition at line 221 of file Sensor.h.

◆ RightAscension()

double Isis::Sensor::RightAscension ( )
virtual

Returns the right ascension angle (sky longitude).

Returns
double The angle of right ascension, in degrees.

Reimplemented in Isis::CSMCamera.

Definition at line 565 of file Sensor.cpp.

References computeRaDec(), m_newLookB, and m_ra.

Referenced by Isis::Camera::CelestialNorthClockAngle(), Isis::CameraPointInfo::GetPointInfo(), Isis::VimsSkyMap::Init(), Isis::Camera::RaDecRange(), Isis::Camera::RaDecResolution(), and Isis::Camera::RawFocalPlanetoImage().

◆ SetGround()

bool Isis::Sensor::SetGround ( const SurfacePoint & surfacePt,
bool backCheck = true )

This overloaded method has the opposite function as SetLookDirection.

Instead of computing a point on the target, a point is set and the look direction is computed. Other methods such as lat/lon, phase, incidence, etc. can be used if this method returns a true.

Parameters
backCheckIf true this method will check the lat/lon point to see if it falls on the backside of the target (or beyond the horizon). If false this test will not occur. Defaults to true.
Returns
bool
History
2017-03-23 Kris Becker - Added support for occlusion test

Definition at line 447 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), Isis::ShapeModel::clearSurfacePoint(), Coordinate(), Isis::Spice::instrumentPosition(), SetGroundLocal(), and Isis::Spice::target().

◆ SetGroundLocal()

bool Isis::Sensor::SetGroundLocal ( bool backCheck)
private

Computes look vector.

This method handles the common functions for the overloaded SetUniversalGround methods.

Instead of computing a point on the target, a point is set (lat,lon,radius) and the look direction is computed.

Parameters
backCheckIf true this method will check the lat/lon point to see if it falls on the backside of the target (or beyond the horizon). If false this test will not occur. Defaults to true.
Returns
bool True if the look direction intersects the target.
History
2017-03-23 Kris Becker - Added formal occlusion callback

Definition at line 479 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), Isis::ShapeModel::clearSurfacePoint(), Coordinate(), Isis::ShapeModel::hasIntersection(), Isis::Spice::instrumentPosition(), Isis::ShapeModel::isVisibleFrom(), lookDirectionBodyFixed(), m_lookB, m_newLookB, Isis::ShapeModel::setHasIntersection(), Isis::ShapeModel::surfaceIntersection(), and Isis::Spice::target().

Referenced by SetGround(), SetUniversalGround(), and SetUniversalGround().

◆ SetLookDirection()

bool Isis::Sensor::SetLookDirection ( const double v[3])

Sets the look direction of the spacecraft.

This routine will then attempt to intersect the look direction with the target. If successful you can utilize the methods which return the lat/lon, phase, incidence, etc. This routine returns false if the look direction does not intersect the target.

Parameters
v[]A look vector in camera coordinates. For example, (0,0,1) is usually the look direction out of the boresight of a camera.
Returns
bool Indicates whether the given look direction intersects the target.
History

2009-09-23 Tracie Sucharski - Convert negative longitudes returned my reclat.

2010-09-15 Janet Barrett - Modified this method to use a new algorithm for finding the intersection of a ray with the DEM. This was required to take care of problems that were encountered at the poles of global DEM files. The algorithm that is being used was taken from "Intersection between spacecraft viewing vectors and digital elevation models" by N.A. Teanby. This algorithm only works on Equatorial Cylindrical projections. Other projections still use the previous algorithm.

2010-10-26 Janet Barrett - The tolerance value of 1E-5 was too small and was causing a divide by zero error when the current and last intersections were virtually the same. The tolerance was changed to 3E-8 * a (where a is the equatorial radius of the planet we are dealing with).

2011-01-24 Janet Barrett - Got rid of extra loop that wasn't needed for the new ray tracing algorithm.

History
2011-08-16 Jeff Anderson - Fixed a problem with an infinite loop in the ray tracing algorithm. The problem was first exposed when trying to intersect the Vesta DEM on the limb.

Definition at line 143 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), Coordinate(), Isis::Spice::instrumentPosition(), Isis::Spice::instrumentRotation(), m_lookB, m_newLookB, and Isis::Spice::target().

Referenced by Isis::PixelFOV::instantaneousFov(), Isis::CameraGroundMap::SetFocalPlane(), Isis::CameraSkyMap::SetFocalPlane(), Isis::VimsGroundMap::SetFocalPlane(), Isis::VimsSkyMap::SetFocalPlane(), and SetRightAscensionDeclination().

◆ SetRightAscensionDeclination()

bool Isis::Sensor::SetRightAscensionDeclination ( const double ra,
const double dec )

Given the ra/dec compute the look direction.

Parameters
raRight ascension in degrees (sky longitude).
decDeclination in degrees (sky latitude).
Returns
bool True if successful.

Definition at line 613 of file Sensor.cpp.

References Isis::DEG2RAD, Isis::Spice::instrumentRotation(), and SetLookDirection().

◆ setTime()

void Isis::Sensor::setTime ( const iTime & time)
virtual

By setting the time you essential set the position of the spacecraft and body as indicated in the class Spice.

However, after this is invoked there will be no intersection point until SetLookDirection or SetUniversalGround is invoked. (Read NAIF documentation for a detailed description of ephemeris time.)

Parameters
timeEphemeris time.

Reimplemented from Isis::Spice.

Definition at line 99 of file Sensor.cpp.

References Isis::Spice::setTime(), Isis::Spice::target(), and Isis::Spice::time().

Referenced by Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::ClipperNacRollingShutterCamera::ClipperNacRollingShutterCamera(), Isis::ClipperPushBroomCamera::ClipperPushBroomCamera(), Isis::ClipperWacFcCamera::ClipperWacFcCamera(), Isis::CrismCamera::CrismCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::HiresCamera::HiresCamera(), Isis::Hyb2OncCamera::Hyb2OncCamera(), Isis::IdealCamera::IdealCamera(), Isis::VimsGroundMap::Init(), Isis::VimsSkyMap::Init(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::JunoCamera::JunoCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), Isis::Camera::LoadCache(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LwirCamera::LwirCamera(), Isis::Mariner10Camera::Mariner10Camera(), Isis::MdisCamera::MdisCamera(), Isis::MexHrscSrcCamera::MexHrscSrcCamera(), Isis::MiniRF::MiniRF(), Isis::MsiCamera::MsiCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NirCamera::NirCamera(), Isis::OsirisRexOcamsCamera::OsirisRexOcamsCamera(), Isis::RosettaOsirisCamera::RosettaOsirisCamera(), Isis::RosettaVirtisCamera::RosettaVirtisCamera(), Isis::ThemisVisCamera::SetBand(), Isis::NewHorizonsMvicFrameCamera::SetBand(), Isis::VimsGroundMap::SetFocalPlane(), Isis::VimsSkyMap::SetFocalPlane(), Isis::PushFrameCameraDetectorMap::SetFramelet(), Isis::ApolloPanoramicDetectorMap::SetParent(), Isis::RadarPulseMap::SetParent(), Isis::CameraDetectorMap::SetParent(), Isis::LineScanCameraDetectorMap::SetParent(), Isis::RollingShutterCameraDetectorMap::SetParent(), Isis::VariableLineScanCameraDetectorMap::SetParent(), Isis::SsiCamera::SsiCamera(), Isis::TgoCassisCamera::TgoCassisCamera(), Isis::UvvisCamera::UvvisCamera(), Isis::VikingCamera::VikingCamera(), and Isis::VoyagerCamera::VoyagerCamera().

◆ SetUniversalGround() [1/2]

bool Isis::Sensor::SetUniversalGround ( const double latitude,
const double longitude,
bool backCheck = true )

This is the opposite routine for SetLookDirection.

Instead of computing a point on the target, a point is set and the look direction is computed. Other methods such as lat/lon, phase, incidence, etc. can be used if this method returns a true.

Parameters
latitudePlanetocentric latitude.
longitudePositive east longitude.
backCheckIf true this method will check the lat/lon point to see if it falls on the backside of the target (or beyond the horizon). If false this test will not occur. Defaults to true.
Returns
bool True if the look direction intersects the target.
History
2017-03-23 Kris Becker - Added support for occlusion tests

Definition at line 363 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), Isis::ShapeModel::clearSurfacePoint(), Coordinate(), Isis::Angle::Degrees, Isis::Spice::instrumentPosition(), SetGroundLocal(), and Isis::Spice::target().

◆ SetUniversalGround() [2/2]

bool Isis::Sensor::SetUniversalGround ( const double latitude,
const double longitude,
const double radius,
bool backCheck = true )

This overloaded method has the opposite function as SetLookDirection.

Instead of computing a point on the target, a point is set and the look direction is computed. Other methods such as lat/lon, phase, incidence, etc. can be used if this method returns a true.

Parameters
latitudePlanetocentric latitude in degrees.
longitudePositive east longitude in degrees.
radiusRadius in meters.
backCheckIf true this method will check the lat/lon point to see if it falls on the backside of the target (or beyond the horizon). If false this test will not occur. Defaults to true.
Returns
bool True if the look direction intersects the target.
History
2017-03-23 Kris Becker - Added support for occlusion test

Definition at line 405 of file Sensor.cpp.

References Isis::Spice::bodyRotation(), Isis::ShapeModel::clearSurfacePoint(), Coordinate(), Isis::Angle::Degrees, Isis::Spice::instrumentPosition(), Isis::Distance::Meters, SetGroundLocal(), and Isis::Spice::target().

◆ SlantDistance()

double Isis::Sensor::SlantDistance ( ) const
virtual

Return the distance between the spacecraft and surface point in kmv.

Returns
double Slant distance.

Reimplemented in Isis::CSMCamera.

Definition at line 646 of file Sensor.cpp.

References Isis::Spice::instrumentBodyFixedPosition(), and Isis::Spice::target().

Referenced by Isis::PushFrameCameraGroundMap::FindSpacecraftDistance(), and Isis::CameraPointInfo::GetPointInfo().

◆ SolarDistance()

double Isis::Sensor::SolarDistance ( ) const
virtual

Returns the distance between the sun and surface point in AU.

Returns
double Solar distance.

Reimplemented in Isis::CSMCamera.

Definition at line 682 of file Sensor.cpp.

References Isis::Displacement::kilometers(), Isis::Spice::sunPosition(), and Isis::Spice::target().

Referenced by Isis::CameraPointInfo::GetPointInfo().

◆ solarLongitude()

Longitude Isis::Spice::solarLongitude ( )
virtualinherited

Returns the solar longitude.

Returns
double The Solar Longitude

Definition at line 1521 of file Spice.cpp.

References Isis::Spice::computeSolarLongitude(), Isis::Spice::m_et, and Isis::Spice::m_solarLongitude.

Referenced by Isis::CameraPointInfo::GetPointInfo(), and Isis::Spice::init().

◆ SpacecraftAltitude()

double Isis::Sensor::SpacecraftAltitude ( )

Returns the distance from the spacecraft to the subspacecraft point in km.

It uses the ellipsoid, not the shape model.

Returns
double Spacecraft altitude.

Definition at line 703 of file Sensor.cpp.

References Isis::Spice::instrumentPosition(), LocalRadius(), and Isis::Spice::subSpacecraftPoint().

Referenced by Isis::CrismCamera::CrismCamera(), Isis::CameraPointInfo::GetPointInfo(), Isis::Camera::LoadCache(), and Isis::MiniRF::MiniRF().

◆ spacecraftNameLong()

virtual QString Isis::Sensor::spacecraftNameLong ( ) const
pure virtual

Implemented in Isis::Camera, and Isis::IdealCamera.

◆ spacecraftNameShort()

virtual QString Isis::Sensor::spacecraftNameShort ( ) const
pure virtual

Implemented in Isis::Camera, and Isis::IdealCamera.

◆ SpacecraftSurfaceVector()

void Isis::Sensor::SpacecraftSurfaceVector ( double scSurfaceVector[3]) const

Sets the vector between the spacecraft and surface point in body-fixed.

Parameters
scSurfaceVectorThe direction vector from the observer to the surface intersection.
Author
2011-12-20 Tracie Sucharski

Definition at line 634 of file Sensor.cpp.

References m_lookB.

◆ storeResult()

void Isis::Spice::storeResult ( QString name,
SpiceValueType type,
QVariant value )
protectedinherited

Definition at line 1165 of file Spice.cpp.

◆ storeValue()

void Isis::Spice::storeValue ( QString key,
int index,
SpiceValueType type,
QVariant value )
protectedinherited

Definition at line 1201 of file Spice.cpp.

◆ subSolarPoint()

void Isis::Spice::subSolarPoint ( double & lat,
double & lon )
virtualinherited

Returns the sub-solar latitude/longitude in universal coordinates (0-360 positive east, ocentric)

Parameters
latSub-solar latitude
lonSub-solar longitude
See also
setTime()
Exceptions
Isis::IException::Programmer- "You must call SetTime first."

Reimplemented in Isis::CSMCamera.

Definition at line 1341 of file Spice.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::Spice::m_et, Isis::Spice::m_uB, Isis::PI, Isis::IException::Programmer, Isis::Spice::radii(), and Isis::Spice::target().

Referenced by Isis::CameraPointInfo::GetPointInfo(), LocalSolarTime(), and Isis::Camera::SunAzimuth().

◆ subSpacecraftPoint()

void Isis::Spice::subSpacecraftPoint ( double & lat,
double & lon )
virtualinherited

Returns the sub-spacecraft latitude/longitude in universal coordinates (0-360 positive east, ocentric)

Parameters
latSub-spacecraft latitude
lonSub-spacecraft longitude
See also
setTime()
Exceptions
Isis::IException::Programmer- "You must call SetTime first."

Reimplemented in Isis::CSMCamera.

Definition at line 1290 of file Spice.cpp.

References Isis::NaifStatus::CheckErrors(), Isis::SpicePosition::Coordinate(), Isis::Spice::m_bodyRotation, Isis::Spice::m_et, Isis::Spice::m_instrumentPosition, Isis::PI, Isis::IException::Programmer, Isis::Spice::radii(), Isis::SpiceRotation::ReferenceVector(), and Isis::Spice::target().

Referenced by Isis::CameraPointInfo::GetPointInfo(), Isis::Camera::GroundRangeResolution(), SpacecraftAltitude(), and Isis::Camera::SpacecraftAzimuth().

◆ sunPosition() [1/2]

SpicePosition * Isis::Spice::sunPosition ( ) const
virtualinherited

Accessor method for the sun position.

Returns
iTime Sun position for the image.
Author
Steven Lambright
History
2011-02-09 Steven Lambright - Original version.

Reimplemented in Isis::CSMCamera.

Definition at line 1601 of file Spice.cpp.

References Isis::Spice::m_sunPosition.

Referenced by SolarDistance().

◆ sunPosition() [2/2]

void Isis::Spice::sunPosition ( double p[3]) const
virtualinherited

Fills the input vector with sun position information, in either body-fixed or J2000 reference frame and km units.

Parameters
p[]Sun position
See also
setTime()

Reimplemented in Isis::CSMCamera.

Definition at line 909 of file Spice.cpp.

References Isis::Spice::m_et, Isis::Spice::m_uB, and Isis::IException::Programmer.

Referenced by Isis::CameraPointInfo::GetPointInfo().

◆ sunToBodyDist()

double Isis::Spice::sunToBodyDist ( ) const
virtualinherited

Definition at line 1395 of file Spice.cpp.

◆ target()

Target * Isis::Spice::target ( ) const
virtualinherited

Returns a pointer to the target object.

Returns
string

Definition at line 1380 of file Spice.cpp.

References Isis::Spice::m_target.

Referenced by Isis::Camera::BasicMapping(), Isis::Camera::basicRingMapping(), Coordinate(), Isis::FindTool::distancePerPixel(), Isis::CSMCamera::EmissionAngle(), EmissionAngle(), GetLatitude(), Isis::Camera::GetLocalNormal(), GetLongitude(), GetSurfacePoint(), Isis::CameraGroundMap::GetXY(), Isis::UniversalGroundMap::GroundRange(), Isis::Camera::GroundRangeResolution(), HasSurfaceIntersection(), IgnoreElevationModel(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::CSMCamera::IncidenceAngle(), IncidenceAngle(), Isis::Camera::LoadCache(), LocalRadius(), LocalRadius(), LocalRadius(), Isis::Camera::NorthAzimuth(), Isis::CSMCamera::PhaseAngle(), Isis::Camera::RawFocalPlanetoImage(), Isis::CameraGroundMap::SetGround(), Isis::VimsGroundMap::SetGround(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), SetGround(), Isis::Camera::SetGround(), Isis::CSMCamera::SetGround(), SetGroundLocal(), Isis::Camera::SetImage(), Isis::CSMCamera::SetImage(), Isis::Camera::SetImage(), SetLookDirection(), Isis::CSMCamera::SetLookDirection(), Isis::Camera::SetRightAscensionDeclination(), Isis::CSMCamera::setTarget(), setTime(), Isis::Camera::SetUniversalGround(), SetUniversalGround(), Isis::Camera::SetUniversalGround(), SetUniversalGround(), SlantDistance(), Isis::Camera::Slope(), SolarDistance(), Isis::Spice::subSolarPoint(), and Isis::Spice::subSpacecraftPoint().

◆ targetCenterDistance()

double Isis::Spice::targetCenterDistance ( ) const
virtualinherited

Calculates and returns the distance from the spacecraft to the target center.

Returns
double Distance to the center of the target from the spacecraft

Reimplemented in Isis::CSMCamera.

Definition at line 925 of file Spice.cpp.

References Isis::SpicePosition::Coordinate(), Isis::Spice::m_bodyRotation, Isis::Spice::m_instrumentPosition, and Isis::SpiceRotation::ReferenceVector().

Referenced by Isis::CameraPointInfo::GetPointInfo().

◆ targetName()

QString Isis::Spice::targetName ( ) const
inherited

Returns the QString name of the target.

Returns
QString

Definition at line 1390 of file Spice.cpp.

References Isis::Spice::m_target, and Isis::Target::name().

◆ time()

iTime Isis::Spice::time ( ) const
virtualinherited

Returns the ephemeris time in seconds which was used to obtain the spacecraft and sun positions.

Returns
iTime the currently set ephemeris time
Exceptions
IException::Programmer"Unable to retrieve the time Spice::setTime must be called first."

Definition at line 891 of file Spice.cpp.

References Isis::Spice::m_et, and Isis::IException::Programmer.

Referenced by Isis::RadarSlantRangeMap::ComputeA(), Isis::CameraPointInfo::GetPointInfo(), Isis::IsisSensor::getState(), Isis::IsisSensor::getState(), Isis::HiresCamera::HiresCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LwirCamera::LwirCamera(), Isis::NewHorizonsMvicFrameCamera::SetBand(), Isis::ApolloPanoramicDetectorMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::RadarSlantRangeMap::SetFocalPlane(), Isis::CameraDetectorMap::SetParent(), Isis::RollingShutterCameraDetectorMap::SetParent(), setTime(), Isis::RadarSlantRangeMap::SetUndistortedFocalPlane(), Isis::ApolloMetricCamera::ShutterOpenCloseTimes(), Isis::IssNACamera::ShutterOpenCloseTimes(), Isis::IssWACamera::ShutterOpenCloseTimes(), Isis::HiresCamera::ShutterOpenCloseTimes(), Isis::LwirCamera::ShutterOpenCloseTimes(), Isis::NirCamera::ShutterOpenCloseTimes(), Isis::UvvisCamera::ShutterOpenCloseTimes(), Isis::ClipperWacFcCamera::ShutterOpenCloseTimes(), Isis::DawnFcCamera::ShutterOpenCloseTimes(), Isis::SsiCamera::ShutterOpenCloseTimes(), Isis::HayabusaAmicaCamera::ShutterOpenCloseTimes(), Isis::HayabusaNirsCamera::ShutterOpenCloseTimes(), Isis::Hyb2OncCamera::ShutterOpenCloseTimes(), Isis::JunoCamera::ShutterOpenCloseTimes(), Isis::LoHighCamera::ShutterOpenCloseTimes(), Isis::LoMediumCamera::ShutterOpenCloseTimes(), Isis::Mariner10Camera::ShutterOpenCloseTimes(), Isis::MdisCamera::ShutterOpenCloseTimes(), Isis::MexHrscSrcCamera::ShutterOpenCloseTimes(), Isis::MsiCamera::ShutterOpenCloseTimes(), Isis::NewHorizonsLorriCamera::ShutterOpenCloseTimes(), Isis::NewHorizonsMvicFrameCamera::ShutterOpenCloseTimes(), Isis::OsirisRexOcamsCamera::ShutterOpenCloseTimes(), Isis::RosettaOsirisCamera::ShutterOpenCloseTimes(), Isis::TgoCassisCamera::ShutterOpenCloseTimes(), Isis::VikingCamera::ShutterOpenCloseTimes(), Isis::VoyagerCamera::ShutterOpenCloseTimes(), Isis::FramingCamera::ShutterOpenCloseTimes(), Isis::Camera::StartEndEphemerisTimes(), and Isis::UvvisCamera::UvvisCamera().

◆ UniversalLatitude()

double Isis::Sensor::UniversalLatitude ( ) const
virtual

◆ UniversalLongitude()

double Isis::Sensor::UniversalLongitude ( ) const
virtual

Member Data Documentation

◆ m_allowDownsizing

bool Isis::Spice::m_allowDownsizing
privateinherited

Indicates whether to allow downsizing.

Definition at line 411 of file Spice.h.

Referenced by Isis::Spice::defaultInit().

◆ m_BJ

SpiceDouble Isis::Spice::m_BJ[3][3]
protectedinherited

This contains the transformation matrix from J2000 (J) to Body fixed (B).

Recall that the transpose of this matrix JB will convert from body-fixed to J2000. It is left in protected space so that conversions between double and SpiceDouble do not have to occur in inheriting classes.

Definition at line 374 of file Spice.h.

◆ m_bodyFrameCode

SpiceInt* Isis::Spice::m_bodyFrameCode
privateinherited

Naif's BODY_FRAME_CODE value.

It is read from the labels, if it exists. Otherwise, it's calculated by the init() method.

Definition at line 423 of file Spice.h.

Referenced by Isis::Spice::defaultInit(), Isis::Spice::init(), Isis::Spice::naifBodyFrameCode(), and Isis::Spice::~Spice().

◆ m_bodyRotation

◆ m_cacheSize

SpiceDouble* Isis::Spice::m_cacheSize
privateinherited

Cache size. Note: This value is 1 for Framing cameras.

Definition at line 401 of file Spice.h.

Referenced by Isis::Spice::createCache(), Isis::Spice::defaultInit(), Isis::Spice::setTime(), and Isis::Spice::~Spice().

◆ m_ckCode

SpiceInt* Isis::Spice::m_ckCode
privateinherited

Camera kernel (CK) code.

Definition at line 419 of file Spice.h.

Referenced by Isis::Spice::defaultInit(), Isis::Spice::init(), Isis::Spice::naifCkCode(), and Isis::Spice::~Spice().

◆ m_dec

SpiceDouble Isis::Sensor::m_dec
private

Decliation (sky latitude)

Definition at line 242 of file Sensor.h.

Referenced by computeRaDec(), and Declination().

◆ m_endTime

iTime* Isis::Spice::m_endTime
privateinherited

Corrected end (shutter close) time of the observation.

Definition at line 400 of file Spice.h.

Referenced by Isis::Spice::cacheEndTime(), Isis::Spice::createCache(), Isis::Spice::defaultInit(), Isis::Spice::setTime(), and Isis::Spice::~Spice().

◆ m_endTimePadding

SpiceDouble* Isis::Spice::m_endTimePadding
privateinherited

Kernels pvl group EndPadding keyword value.

Definition at line 404 of file Spice.h.

Referenced by Isis::Spice::createCache(), Isis::Spice::defaultInit(), Isis::Spice::init(), and Isis::Spice::~Spice().

◆ m_et

◆ m_ikCode

SpiceInt* Isis::Spice::m_ikCode
privateinherited

Instrument kernel (IK) code.

Definition at line 420 of file Spice.h.

Referenced by Isis::Spice::defaultInit(), Isis::Spice::init(), Isis::Spice::naifIkCode(), and Isis::Spice::~Spice().

◆ m_instrumentPosition

◆ m_instrumentRotation

SpiceRotation* Isis::Spice::m_instrumentRotation
privateinherited

◆ m_kernels

QVector<QString>* Isis::Spice::m_kernels
privateinherited

Vector containing kernels filenames.

Definition at line 396 of file Spice.h.

Referenced by Isis::Spice::createCache(), Isis::Spice::defaultInit(), Isis::Spice::load(), and Isis::Spice::~Spice().

◆ m_lookB

SpiceDouble Isis::Sensor::m_lookB[3]
protected

◆ m_naifKeywords

PvlObject* Isis::Spice::m_naifKeywords
privateinherited

NaifKeywords PvlObject from cube.

Definition at line 427 of file Spice.h.

Referenced by Isis::Spice::getStoredNaifKeywords(), and Isis::Spice::init().

◆ m_newLookB

bool Isis::Sensor::m_newLookB
protected

flag to indicate we need to recompute ra/dec

Definition at line 235 of file Sensor.h.

Referenced by computeRaDec(), Declination(), RightAscension(), Sensor(), Isis::CSMCamera::SetGround(), SetGroundLocal(), SetLookDirection(), and Isis::CSMCamera::SetLookDirection().

◆ m_ra

SpiceDouble Isis::Sensor::m_ra
private

Right ascension (sky longitude)

Definition at line 241 of file Sensor.h.

Referenced by computeRaDec(), and RightAscension().

◆ m_sclkCode

SpiceInt* Isis::Spice::m_sclkCode
privateinherited

Spacecraft clock correlation kernel (SCLK) code.

Definition at line 421 of file Spice.h.

Referenced by Isis::Spice::defaultInit(), Isis::Spice::init(), Isis::Spice::naifSclkCode(), and Isis::Spice::~Spice().

◆ m_solarLongitude

Longitude* Isis::Spice::m_solarLongitude
protectedinherited

Body rotation solar longitude value.

Definition at line 383 of file Spice.h.

Referenced by Isis::Spice::computeSolarLongitude(), Isis::Spice::defaultInit(), Isis::Spice::init(), Isis::Spice::solarLongitude(), and Isis::Spice::~Spice().

◆ m_spkBodyCode

SpiceInt* Isis::Spice::m_spkBodyCode
privateinherited

Spacecraft and planet ephemeris kernel (SPK) body code.

Definition at line 422 of file Spice.h.

Referenced by Isis::Spice::computeSolarLongitude(), Isis::Spice::defaultInit(), Isis::Spice::init(), and Isis::Spice::~Spice().

◆ m_spkCode

SpiceInt* Isis::Spice::m_spkCode
privateinherited

Spacecraft and planet ephemeris kernel (SPK) code.

Definition at line 418 of file Spice.h.

Referenced by Isis::Spice::defaultInit(), Isis::Spice::init(), Isis::Spice::naifSpkCode(), and Isis::Spice::~Spice().

◆ m_startTime

iTime* Isis::Spice::m_startTime
privateinherited

Corrected start (shutter open) time of the observation.

Definition at line 399 of file Spice.h.

Referenced by Isis::Spice::cacheStartTime(), Isis::Spice::createCache(), Isis::Spice::defaultInit(), Isis::Spice::setTime(), and Isis::Spice::~Spice().

◆ m_startTimePadding

SpiceDouble* Isis::Spice::m_startTimePadding
privateinherited

Kernels pvl group StartPadding keyword value.

Definition at line 403 of file Spice.h.

Referenced by Isis::Spice::createCache(), Isis::Spice::defaultInit(), Isis::Spice::init(), and Isis::Spice::~Spice().

◆ m_sunPosition

◆ m_target

◆ m_uB

SpiceDouble Isis::Spice::m_uB[3]
protectedinherited

This contains the sun position (u) in the bodyfixed reference frame (B).

It is left protected so that conversions between double and SpiceDouble do not have to occur in inheriting classes. Units are km

Definition at line 369 of file Spice.h.

Referenced by IncidenceAngle(), Isis::Camera::LocalPhotometricAngles(), PhaseAngle(), Isis::Spice::setTime(), Isis::Spice::subSolarPoint(), and Isis::Spice::sunPosition().

◆ m_usingAle

bool Isis::Spice::m_usingAle
privateinherited

Indicate whether we are reading values from an ISD returned from ALE.

Definition at line 432 of file Spice.h.

Referenced by Isis::Spice::computeSolarLongitude(), Isis::Spice::init(), and Isis::Spice::readValue().

◆ m_usingNaif

bool Isis::Spice::m_usingNaif
privateinherited

Indicates whether we are reading values from the NaifKeywords PvlObject in cube.

Definition at line 429 of file Spice.h.

Referenced by Isis::Spice::computeSolarLongitude(), Isis::Spice::init(), and Isis::Spice::readValue().


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