FitsFile.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// SVN: $Id: FitsFile.h 7080 2010-06-10 15:34:33Z EckhardSutorius $
//-----------------------------------------------------------------------------
#ifndef FITSFILE_H
#define FITSFILE_H

extern "C"
{
  #include "fitsio.h"
}

#include <list>
#include <string>
#include <vector>

#include "MyException.h"
//-----------------------------------------------------------------------------
//@@WARNING: It is anticipated we will only want to read fits files
class FitsFile
{
public:
  enum FitsHdr
  {
    Primary,
    Secondary,
    Catalogue
  };

  enum ExpectKeys
  {
    UTDATE,
    MJD,
    PROJECT,
    FILTER,
    FLATCOR,
    CIRCPM,
    SKYSUB,
    ARC_MFID,
    ARC_TIME,
    OBSNUM,
    XTENSION,
    ZNAXIS,
    ZNAXIS1,
    ZNAXIS2,
    NAXIS,
    NAXIS1,
    NAXIS2,
    CRVAL1,
    CRVAL2,
    CD11,
    CD12,
    CD21,
    CD22,
    CAMNUM,
    TEXPTIME,
    cAMSTART,
    cAMEND,
    cMAGZPT,
    cMAGZRR,
    cEXTINCT,
    cEXP_TIME,
    cCRVAL1,
    cCRVAL2,
    cCTYPE1,
    cCTYPE2,
    cCRPIX1,
    cCRPIX2,
    cCD11,
    cCD12,
    cCD21,
    cCD22,
    cPV21,
    cPV22,
    cPV23,
    cPV24,
    cPV25,
    NumKeys   // This gives the total number of keyword entries
  };          // and should always be the last entry in the list

  FitsFile();

  FitsFile(const std::string& filename);

  ~FitsFile();

  void openFile(const std::string& filename);

  void closeFile();

  const std::string& getFileName() const;

  bool isTile() const;

  /*----------------------------------------------------------------------*/
  /* Keyword reading methods. */
  /*----------------------------------------------------------------------*/

  bool testExpectedKeys(const std::string& fitsType);
  int checkKeys(const std::string& aKeyname);

  bool hasKey(const std::string& keyname) const;

  void readKey(const std::string& keyname, int&    value) const;

  void readKey(const std::string& keyname, float&  value) const;

  void readKey(const std::string& keyname, double& value) const;

  void readKey(const std::string& keyname, std::string& value) const;

  template <typename AnyDataType>
  void readKey(ExpectKeys keyname, AnyDataType& value) const
  {
    readKey(mExpectedKeys.at(keyname).first, value);
  }

  void readKeyUnit(const std::string& keyname, std::string& unit);

  void readHistory(std::list<std::string>& values);

  int getNumCards();

  void readCard(int keyNo, char* card);

  std::string readKeyname(int keyNo);

  /*----------------------------------------------------------------------*/
  /* HDU level routines */
  /*----------------------------------------------------------------------*/

  int getNumHdus() const;

  int getHduNum();

  int movabsHdu(int hdunum) const;

  int movrelHdu(int nmove);

  int getHduType();

  bool isImageHdu();

  bool isAsciiTable();

  bool isBinaryTable();

  /*----------------------------------------------------------------------*/
  /* Table I/O routines */
  /*----------------------------------------------------------------------*/

  int getNumRows();

  int getNumCols();

  int getColnum(const std::string& name);

  void readColumn(const std::string& name, float* data);

  void readColumn(const std::string& name, double* data);

  void readColumn(const std::string& name, std::string* data) {}

  std::string readColumnUnit(const std::string& name);

  // Maybe I should define a readCol into a std::string array?
  // void readCol(const std::string& name, char  **data);

private:
  typedef std::pair<std::string, FitsHdr> FitsKeysPair;
  typedef std::vector<FitsKeysPair> FitsKeysList;

  static FitsKeysList mExpectedKeys;

  std::string fileName;

  fitsfile *fptr;

  void initExpectedKeysList();

  void handleError(int status, bool throwException = true) const;

};
//-----------------------------------------------------------------------------
class FitsIOException : public MyException
{
public:
  FitsIOException(const std::string& aMsg)
    : MyException("FitsIOException: ", aMsg) { }
};
//-----------------------------------------------------------------------------
class FitsColNotFound : public FitsIOException
{
public:
  FitsColNotFound(const std::string& aMsg)
    : FitsIOException("FitsColNotFound: " + aMsg) { }
};
//-----------------------------------------------------------------------------
class FitsKeyNotExist : public FitsIOException
{
public:
  FitsKeyNotExist(const std::string& aMsg)
    : FitsIOException("FitsKeyNotExist: " + aMsg) { }
};
//-----------------------------------------------------------------------------
#endif

---