Spice.h

Go to the documentation of this file.

#ifndef Spice_h
#define Spice_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <string>
#include <vector>
 
#include <SpiceUsr.h>
#include <SpiceZfc.h>
#include <SpiceZmc.h>
 
#include "Pvl.h"
#include "ShapeModel.h"
#include "SpicePosition.h"
#include "SpiceRotation.h"
 
namespace Isis {
  class Cube;
  class iTime;
  class Distance;
  class EllipsoidShape;
  class Longitude;
  class Target;

  class Spice {
    public:
      // constructors
      Spice(Cube &cube);
      Spice(Pvl &lab, nlohmann::json isd);
 
      // destructor
      virtual ~Spice();
 
      // Methods
      virtual void setTime(const iTime &time);
      void instrumentPosition(double p[3]) const;
      virtual void instrumentBodyFixedPosition(double p[3]) const;
      virtual void sunPosition(double p[3]) const;
      virtual double targetCenterDistance() const;
      virtual double sunToBodyDist() const;
 
      virtual Longitude solarLongitude();
      virtual void instrumentBodyFixedVelocity(double v[3]) const;
      virtual iTime time() const;
 
      void radii(Distance r[3]) const;
 
      virtual void createCache(iTime startTime, iTime endTime,
                               const int size, double tol);
      virtual iTime cacheStartTime() const;
      virtual iTime cacheEndTime() const;
 
      virtual void subSpacecraftPoint(double &lat, double &lon);
      virtual void subSolarPoint(double &lat, double &lon);
 
      virtual Target *target() const;
      QString targetName() const;
 
      virtual iTime getClockTime(QString clockValue,
                                 int sclkCode = -1,
                                 bool clockTicks=false);
      SpiceDouble getDouble(const QString &key, int index = 0);
      SpiceInt getInteger(const QString &key,   int index = 0);
      QString getString(const QString &key,     int index = 0);
 
      virtual SpicePosition *sunPosition() const;
      virtual SpicePosition *instrumentPosition() const;
      virtual SpiceRotation *bodyRotation() const;
      virtual SpiceRotation *instrumentRotation() const;
 
      bool isUsingAle();
      bool hasKernels(Pvl &lab);
      bool isTimeSet();
 
      SpiceInt naifBodyCode() const;
      SpiceInt naifSpkCode() const;
      SpiceInt naifCkCode() const;
      SpiceInt naifIkCode() const;
      SpiceInt naifSclkCode() const;
      SpiceInt naifBodyFrameCode() const;
 
      PvlObject getStoredNaifKeywords() const;
      virtual double resolution();
 
    protected:
      enum SpiceValueType {
        SpiceDoubleType,  
        SpiceStringType,  
        SpiceIntType,     
        SpiceByteCodeType 
      };
 
      QVariant readValue(QString key, SpiceValueType type, int index = 0);
 
      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);
 
      // Leave these protected so that inheriting classes don't
      // have to convert between double and spicedouble
      // None of the below data elements are usable (except
      // m_radii) until SetEphemerisTime is invoked
      SpiceDouble m_uB[3];    
      SpiceDouble m_BJ[3][3]; 
      Target *m_target; 
      iTime *m_et; 
      Longitude *m_solarLongitude; 
 
    private:
      // Don't allow copies
      Spice(const Spice &other);
      Spice &operator=(const Spice &other);
 
      void init(Cube &cube, Pvl &pvl, bool noTables);
      void isdInit(Pvl &pvl, nlohmann::json isd);
      void csmInit(Cube &cube, Pvl label);
      void defaultInit();
 
      void load(PvlKeyword &key, bool notab);
 
      QVector<QString> * m_kernels; 
 
      // cache stuff
      iTime *m_startTime; 
      iTime *m_endTime; 
      SpiceDouble *m_cacheSize; 
 
      SpiceDouble *m_startTimePadding; 
      SpiceDouble *m_endTimePadding; 
 
      SpicePosition *m_instrumentPosition; 
      SpiceRotation *m_instrumentRotation; 
      SpicePosition *m_sunPosition; 
      SpiceRotation *m_bodyRotation; 
 
      bool m_allowDownsizing; 
 
      // Constants
      //      SpiceInt *m_bodyCode;        /**< The NaifBodyCode value, if it exists in the
      //                                        labels. Otherwise, if the target is sky,
      //                                        it's the SPK code and if not sky then it's
      //                                        calculated by the naifBodyCode() method.*/
      SpiceInt *m_spkCode;         
      SpiceInt *m_ckCode;          
      SpiceInt *m_ikCode;          
      SpiceInt *m_sclkCode;        
      SpiceInt *m_spkBodyCode;     
      SpiceInt *m_bodyFrameCode;   
 
      PvlObject *m_naifKeywords; 
 
      bool m_usingNaif; 
 
      bool m_usingAle; 
 
  };
}
 
#endif