GloriaFitsHeader.h

// -*- mode: c++; mode: auto-fill; mode: flyspell-prog; -*-


#ifndef GloriaFitsHeader_h
#define GloriaFitsHeader_h 1


/*
 *   This source code is part of the LUIZA software package for GLORIA.
 *   You are free to use this source files for your own development as
 *   long as it stays in a public research context. You are not
 *   allowed to use it for commercial purpose. You must put this
 *   header with author names in all development based on this file.
 *
 */

#include <string>
#include <vector>
#include <map>
#include <cfitsio/fitsio.h>
using namespace std;

namespace gloria{


  class GloriaFitsHeader {

    friend class GloriaFitsImage ;
    friend class GloriaSkyCatalog ;
    friend class GloriaObjectList ;
    friend class GloriaFitsTable ;

  public:

    struct HeaderRecord {       
                        std::string Keyword;
                        std::string Value;
                        std::string Comment;
                        };


    GloriaFitsHeader();


    virtual ~GloriaFitsHeader();



    void ReadFitsHeader(fitsfile *fp);


    void WriteFitsHeader(fitsfile *fp);


    // Header access methods
    // =====================


    inline int GetKeywordNumber() {return _fitsHeaderRecords.size(); };

    
    inline HeaderRecord& GetRecordAt(const int ikey) {return _fitsHeaderRecords.at(ikey); };   

    inline std::string& GetKeywordAt(const int ikey) {return _fitsHeaderRecords.at(ikey).Keyword; };   

    inline std::string& GetValueAt(const int ikey) {return _fitsHeaderRecords.at(ikey).Value; };   

    inline std::string& GetCommentAt(const int ikey) {return _fitsHeaderRecords.at(ikey).Comment; };   

    bool IsKeywordSet(const char *keyword);

    HeaderRecord& GetKeywordRecord(const char *keyword);   

    std::string& GetKeywordValue(const char *keyword);   

    long   GetKeywordValueInt(const char *keyword);   

    double GetKeywordValueDouble(const char *keyword);   

    void AddKeyword(const char *keyword, std::string value, std::string comment);   

    void AddKeywordDouble(const char *keyword, double value, std::string comment);   
    
    void AddKeywordInt(const char *keyword, int value, std::string comment);   
    
    void AddKeyword(HeaderRecord record);   

    void SetKeyword(const char *keyword, std::string value, std::string comment);   
    
    void SetKeywordDouble(const char *keyword, double value, std::string comment);
    
    void SetKeywordInt(const char *keyword, int value, std::string comment);    
    
    void AddComment(std::string comment);   
    
    void AddHistory(std::string history);   
    

    void RemoveKeyword(const char *keyword);   


    void RemoveKeywords(const char *keyword);   



    void CopyHeader(GloriaFitsHeader* source);


    void PrintHeader( std::ostream& os, int maxRec=100);

    // General status
    // ==============

    inline bool OK() { return _statusOK; };

    inline bool Error() { return !_statusOK; };

    std::string ErrorMessage() { return _errorMessage; };


    inline void ClearError() { _statusOK=true; _errorMessage.clear();};

    inline std::string  InputFileName() { return _inputFileName; };

    inline void  SetInputFileName(string name) {_inputFileName = name; };

    inline std::string  OutputFileName() { return _outputFileName; };

private:


    std::vector<HeaderRecord> _fitsHeaderRecords;

    std::multimap<std::string,int> _headerKeywordMap;




    std::string   _inputFileName;


    std::string   _outputFileName;


    bool _statusOK;

    std::string _errorMessage;

  } ;


}

#endif