Changeset 1218 in Sophya for trunk/SophyaExt/FitsIOServer/fitsfile.h

Timestamp:

Oct 3, 2000, 2:14:14 PM (25 years ago)

Author:

ansari

Message:

doc dans .cc

File:

• trunk/SophyaExt/FitsIOServer/fitsfile.h (modified) (12 diffs)

trunk/SophyaExt/FitsIOServer/fitsfile.h

@@ -10 +10 @@
 #define LEN_KEYWORD 9
 
+// classes for saving/loading SOPHYA objects to/from FITS files...
+// Guy le Meur (september 2000)
+
+
 namespace SOPHYA {
 
-struct BnTblLine 
- {
-BnTblLine() {}
-void setFormat(int dc, int fc, int ic, int cc, vector<string> names)
-   {
-    int nbcols = dc + fc + ic + cc;
-    int maxName = names.size();
-    if (nbcols != maxName)
-      {
-        cout << " WARNING: BnTblLine:: length of vector of column names not equal to total number of columns" << endl;
-        maxName = nbcols < maxName ? nbcols : maxName;
-      }
-    ColName_ = vector<string>(nbcols);
-     for (int k=0; k < maxName; k++) ColName_[k] = names[k];
-    if (dc >0) ddata_ = vector<double>(dc);
-    if (fc >0) fdata_ = vector<float>(fc);
-    if (ic >0) idata_ = vector<int>(fc);
-    if (cc >0) cdata_ = vector<string>(fc);
-   }
-
-bool sameFormat(const BnTblLine& btl) const
-   {
-     if (btl.ddata_.size() == ddata_.size() && btl.fdata_.size() == fdata_.size() && btl.idata_.size() == idata_.size() && btl.cdata_.size() == cdata_.size()) return true;
-     else return false;
-   }
-
-void Print()
-   {
-     int k;
-     cout << " ********* ligne ************* " << endl;
-     cout << " *** noms de variables  " << endl;
-     for (k=0; k < ColName_.size(); k++) cout << ColName_[k] << " ";
-     cout << endl;
-     cout << " *** variables doubles  " << endl;
-     for (k=0; k < ddata_.size(); k++) cout << ddata_[k] << " ";
-     cout << endl;
-     cout << " *** variables float  " << endl;
-     for (k=0; k < fdata_.size(); k++) cout << fdata_[k] << " ";
-     cout << endl;
-     cout << " *** variables int  " << endl;
-     for (k=0; k < idata_.size(); k++) cout << idata_[k] << " ";
-     cout << endl;
-     cout << " *** variables string  " << endl;
-     for (k=0; k < cdata_.size(); k++) cout << cdata_[k] << " ";
-     cout << endl;
-     cout << " ***************************** " << endl;
-   }
-  vector<double> ddata_;
-  vector<float>  fdata_;
-  vector<int>    idata_;
-  vector<string>  cdata_;
-  vector<string> ColName_;
-
- };
-
- class FitsFile;
- class FitsInFile;
- class FitsOutFile;
- enum WriteMode {append, clear, unknown};
-
+  struct BnTblLine;
+  class FitsFile;
+  class FitsInFile;
+  class FitsOutFile;
+  enum WriteMode {append, clear, unknown};
+  
 
 //
 //! Class for managing Interface for SOPHYA objects to FITS Format Files (uses cfitsio lib)
 
-/*! 
-The class structure is analogous to Sophya-PPersist system :
-Each SOPHYA object XXX is associated with a object of class FITS_XXX 
- (inheriting from FitsFileHandler), to which input/output operations with FITS 
- files are delegated (through a class Hierarchy : FitsFile (virtual), 
- FitsInFile, FitsOutFile) . A typical example of use is the following : 
-
-\verbatim
-  int m=... ;
-  SphereHEALPix<r_8> sphere1(m);           // definition of the SOPHYA object
-  .... fill the sphere ....
-
-  FITS_SphereHEALPix<r_8> fits_sph1(sphere1); 
-                                           // delegated object
-  fits_sph.Write("myfile.fits");           // writing on FITS file
-
-   FITS_SphereHEALPix<r_8> fits_sph2("myfile.fits"); 
-                                           // load a delegated object 
-                                           // from FITS file
-   SphereHEALPix<r_8> sphere2=(SphereHEALPix<r_8>)fits_sph2; 
-                                           // casting the delegated object
-                                           // into a SOPHYA object
-\endverbatim
-
-*/
-
-class FitsIOHandler {
-
-
-  public:
-
-virtual ~FitsIOHandler() {}
-/*!
-this method is called from inherited objects : 
-
-opens a file 'flnm' 
-
-gets parameters in extension-header (hdunum)
-
-calls the method 'ReadFromFits' from the inherited  object
-
-
-*/ 
-  void   Read(char flnm[],int hdunum= 0);
-/*!
-this method is called from inherited objects : 
-
-for writing a new object in a new fits-extension :
-
-???
-
- at the end of 
-
-the existing file (flnm), if OldFile=true. 
-
-If OldFile=false, an exception occurs
+ class FitsIOHandler {
+
+
+ public:
+
+   virtual ~FitsIOHandler() {}
+   void   Read(char flnm[],int hdunum= 0);
+   void   Write(char flnm[]) ;
+   void   Read(FitsInFile& ifts, int hdunum=0);
+   void   Write(FitsOutFile& ofts) ;
+
+
+ protected:
+  
+   virtual void    ReadFromFits(FitsInFile& is)=0;           
+   virtual void    WriteToFits(FitsOutFile& os) =0;   
+        
+   friend class FitsInFile;
+   friend class FitsOutFile;
+  };
+
+
+//! Class (virtual) for managing FITS format files
+ class FitsFile {
+
+ public:
+
+   FitsFile() { InitNull(); };
+   virtual ~FitsFile();
+   static string GetErrStatus(int status);
+   inline  int   statusF() const { return fits_status_;}
  
-By convention, primary header does not contain fits-image data : i.e. 
-all data are fits-extensions. The first relevant header will have hdunum=2.
-For switching off this convention use the method : 
-
-firstImageOnPrimaryHeader() (see below)
-
-In that case do not forget to precise hdunum=1 when reading data on primary header.
-
-calls the method 'WriteToFits' from the inherited  object
-
-*/ 
-  void   Write(char flnm[]) ;
-
-  /*!
-Read the data on extension hdunum (or primary header, if hdunum=1) from FitsInFIle. With default value for hdunum, one reads the next extension, with respect to the current position. 
-   */
-  void   Read(FitsInFile& ifts, int hdunum=0);
-  void   Write(FitsOutFile& ofts) ;
-
-
-  protected:  
-  virtual void    ReadFromFits(FitsInFile& is)=0;           
-  virtual void    WriteToFits(FitsOutFile& os) =0;           
-  friend class FitsInFile;
-  friend class FitsOutFile;
-  private :
-  };
-
-
-
-class FitsFile
-{
-
-public:
-
-FitsFile() 
-{ 
- InitNull();
-};
-  virtual ~FitsFile();
-
-  static string GetErrStatus(int status);
-
-
-
-
-inline  int statusF() const { return fits_status_;}
- 
-
-protected:
-
-   void ResetStatus(int& status) ; 
+
+ protected:
+
+   void         ResetStatus(int& status) ; 
    static  void printerror(int&) ;
    static  void printerror(int&,char* texte) ;
-   inline void InitNull() {fptr_ = NULL; hdutype_= 0; hdunum_ = 1; 
+   inline void  InitNull() {fptr_ = NULL; hdutype_= 0; hdunum_ = 1; 
    fits_status_ = 0;}
 
-  //! pointer to the FITS file, defined in fitsio.h 
-  fitsfile *fptr_; 
-  
-  //!  image or bintable ?
-  int hdutype_;
-
-//! index of header to be read/written
-  int hdunum_;  
-
-  //! last status returned by fitsio library. updated only by several methods
-  int fits_status_;
-
-    
-};
-
+   fitsfile *fptr_;     /**<  pointer to the FITS file, defined in fitsio.h */
+   int hdutype_;        /**<  image or bintable ? */
+   int hdunum_;         /**<   index of header to be read/written */
+   int fits_status_;    /**< last status returned by fitsio library. updated only by several methods */
+
+ };
+
+//! Class for saving  SOPHYA objects on FITS Format Files (uses cfitsio lib)
 
  class FitsInFile : public  FitsFile {
@@ -210 +80 @@
  public:
    FitsInFile();
-   //   FitsInFile(char flnm[], int hdunum=0);
    FitsInFile(char flnm[]);
    ~FitsInFile() { ; };
 
-
-//////////////////////////////////////////////////////////
-//     methods with general purpose
-///////////////////////////////////////
-
-
-
-  static int NbBlocks(char flnm[]);
-  static void GetBlockType(char flnm[], int hdunum, string& typeOfExtension, int& naxis, vector<int>& naxisn, string& dataType, DVList& dvl  );
-
-
-
-  //  void ReadFInit(char flnm[],int hdunum=0);
-  void ReadFInit(int hdunum);
+   static int  NbBlocks(char flnm[]);
+   static void GetBlockType(char flnm[], int hdunum, string& typeOfExtension, int& naxis, vector<int>& naxisn, string& dataType, DVList& dvl  );
+   void        ReadFInit(int hdunum);
  
-  /*! return a reference on a DVList containing the keywords from FITS file
-   */
-inline const DVList& DVListFromFits() const { return dvl_;}
-
-/* get the keywords of primary header in a DVList */
-DVList  DVListFromPrimaryHeader() const;
-
-void moveToFollowingHeader();
+  /*! \return a reference on a DVList containing the keywords from FITS file */
+  inline const DVList& DVListFromFits() const { return dvl_;}
+
+  DVList  DVListFromPrimaryHeader() const;
+  void    moveToFollowingHeader();
+
+
 
 
@@ -242 +99 @@
        ///////   methods for managing extensions ////////////////
        //////////////////////////////////////////////////////////
-
 
 
@@ -250 +106 @@
 
 
-/*! return true if the current header  corresponds to a FITS image extension */
+
+/*! \return true if the current header  corresponds to a FITS image extension */
 inline bool IsFitsImage() const { return (hdutype_ == IMAGE_HDU);}
 
 
 
-  /*! number of dimensions of an image extension : NAXIS parameter (in FITS notations)
-   */
+  /*! \return number of dimensions of an image extension : NAXIS parameter (in FITS notations)   */
 inline int nbDimOfImage() const {return naxis_;}
-/*! a reference on a vector containing sizes of the NAXIS dimensions : NAXIS1, NAXIS2, NAXIS3 wtc.
- */
+
+/*! \return a reference on a vector containing sizes of the NAXIS dimensions : NAXIS1, NAXIS2, NAXIS3 etc.  */
  inline const vector<int>& dimOfImageAxes() const { return naxisn_;}
-/*!
- total number of data in the current IMAGE extension
- */
+
+
+/*! \return total number of data in the current IMAGE extension */
 inline int nbOfImageData() const { return nbData_; }
 
@@ -275 +131 @@
 
 
-/*! return true if the current header  corresponds to a FITS ASCII or BINTABLE extension */
+/*! \return true if the current header  corresponds to a FITS ASCII or BINTABLE extension */
 inline bool IsFitsTable() const {return (hdutype_ == ASCII_TBL || hdutype_ == BINARY_TBL);}
 
 
-static  void GetBinTabParameters(fitsfile* fileptr, int& nbcols, int& nrows,
+ static  void GetBinTabParameters(fitsfile* fileptr, int& nbcols, int& nrows,
                                   vector<int>& repeat,
                                   vector<string>& noms, 
                                   vector<char>& types,   
                                   vector<int>&  taille_des_chaines);
-
-
-
-  /*! return a character denoting data type of column number 'nocol' in a BINTABLE :
-
-D : double
-
-E : float 
-
-I : integer
-    
-S : character string 
-
-  */
-  char    ColTypeFromFits(int nocol) const;
-  /*! name of the column number 'nocol' of the current BINTABLE extension
-   */
-  string  ColNameFromFits(int nocol) const;
-
-  /*! number of characters of each data  for the column number 'nocol' (if char* typed) of the current BINTABLE extension
-   */
-  int     ColStringLengthFromFits(int nocol) const;
-
-
-
-  /*!
-Get the NoLine-th 'line'  from the current BINTABLE extension on FITS file,
-  */
-  void GetBinTabLine(int NoLine, double* ddata, float* fdata, int* idata, char
+ char   ColTypeFromFits(int nocol) const;
+ string ColNameFromFits(int nocol) const;
+ int    ColStringLengthFromFits(int nocol) const;
+ void   GetBinTabLine(int NoLine, double* ddata, float* fdata, int* idata, char
 ** cdata) ;
-  /*!
-Get the NoLine-th 'line'  from the current BINTABLE extension on FITS file,
-  */
-  void GetBinTabLine(long NoLine, BnTblLine& ligne) ;
-
-  /*!
-Get the NoLine-th 'line'  from the current BINTABLE extension on FITS file,
-  */
-  void GetBinTabLine(int NoLine, float* fdata) ;
-
-/*!
-fill the array 'valeurs' with double data from the current BINTABLE extension on FITS file, from column number 'NoCol'
-
-\param <nentries>  number of data to be read
-  */
-  void GetBinTabFCol(double* valeurs, int nentries, int NoCol) const;
-
-  /*! same as previous method with float data */
-  void GetBinTabFCol(float* valeurs, int nentries, int NoCol) const;
-  /*! same as previous method with int data */
-  void GetBinTabFCol(int* valeurs, int nentries,  int NoCol) const;
-  /*! same as previous method with char* data */
-  void GetBinTabFCol(char** valeurs,int nentries, int NoCol) const;
-  // Write elements into the FITS data array
+ void   GetBinTabLine(long NoLine, BnTblLine& ligne) ;
+ void   GetBinTabLine(int NoLine, float* fdata) ;
+ void   GetBinTabFCol(double* valeurs, int nentries, int NoCol) const;
+ void   GetBinTabFCol(float* valeurs, int nentries, int NoCol) const;
+ void   GetBinTabFCol(int* valeurs, int nentries,  int NoCol) const;
+ void   GetBinTabFCol(char** valeurs,int nentries, int NoCol) const;
 
 /////////////////////////////////////////////////////////////
@@ -343 +156 @@
 ////////////////////////////////////////////////////////
 
- /*! return number of columns (return 1 if IMAGE) */
   int     NbColsFromFits() const;
-  /*! number of data in the current IMAGE extension on FITS file, or number
- of data of column number 'nocol' of the current BINTABLE extension
-  */
   int     NentriesFromFits(int nocol) const;
 
 
-/*!
-fill the array 'map' with double data from the current extension on FITS file.
-If the extension is BINTABLE, the first column is provided. 
-
-\param <nentries>  number of data to be read
-  */
   void    GetSingleColumn(double* map, int nentries) const;
 
-  /*! same as above with float data */
   void    GetSingleColumn(float*  map, int nentries) const;
 
-  /*! same as above with int data */
   void    GetSingleColumn(int* map, int nentries) const;
 
@@ -371 +172 @@
 static  void GetImageParameters (fitsfile* fileptr,int& bitpix,int& naxis,vector<int>& naxisn);
 
-
- 
-
-  //! fits-Image parameter 
-  int bitpix_;
-
-  //! fits-Image parameter 
-  int naxis_;
-
-  //! fits-Image parameters : sizes of dimensions
-  vector<int> naxisn_;
-
-  //! fits-Image parameter: number of data 
-  int nbData_;
-
-  //! Bintable parameter
-  int nrows_;
-
-  //! Bintable parameter
-  vector<int> repeat_;
-
-  //! Bintable parameter
-  int nbcols_;
-
-  //! Bintable parameter: column names
-  vector<string> noms_; 
-
-  //! Bintable parameters: types of columns (D: double, E: float, I: integers,  A: char*)
-  vector<char> types_;   
-
-  //! Bintable parameters:   length of the char* variables                 
-  vector<int>  taille_des_chaines_;
-
-  //! DVList for transferring keywords
-  DVList dvl_;
-
-
- };
-
+ int bitpix_;          /**< fits-Image parameter */
+ int naxis_;           /**< fits-Image parameter */
+ vector<int> naxisn_;  /**< fits-Image parameters : sizes of dimensions */
+ int nbData_;          /*< fits-Image parameter: number of data */
+ int nrows_;           /**< Bintable parameter */
+ vector<int> repeat_;  /**< Bintable parameter */
+ int nbcols_;          /**< Bintable parameter */
+ vector<string> noms_; /**< Bintable parameter: column names */
+ vector<char> types_;  /**< Bintable parameters: types of columns (D: double, E: float, I: integers,  A: char*) */
+ DVList dvl_;          /**< DVList for transferring keywords */
+ vector<int>  taille_des_chaines_; /**< Bintable parameters:   length of the char* variables */
+
+ };
+
+//! Class for loading  SOPHYA objects from FITS Format Files (uses cfitsio lib)
 
  class FitsOutFile : public  FitsFile {
@@ -417 +194 @@
 
    FitsOutFile();
-   /*!
-\param <WriteMode>  enum , WriteMode = clear -> if alreadyy exists, the file will be overwritten (else created) ; WriteMode = append -> further objects will be appended to the file if it exists (else : file created). WriteMode = unknown -> file created if does not exist, else : exception. (the last situation is the default)
-
-   */
    FitsOutFile(char flnm[], WriteMode wrm = unknown );
    ~FitsOutFile() { ;};
@@ -437 +210 @@
 
    inline void firstImageOnPrimaryHeader() {imageOnPrimary_=true;}
-
-  /*! create an IMAGE header on FITS file.
-\param <type> type of data (see method ColTypeFromFits)
-\param <nbdim>  number of dimensions : 1D, 2D, 3D etc. = NAXIS
-\param <naxisn>  array containind sizes of the different dimensions
-  */
-  void makeHeaderImageOnFits(char type, int nbdim, int* naxisn,  DVList &dvl) ;
-
-
-  /*! write double data from array 'map'on an IMAGE extension 
-\param <nbData>  number of data to be written
-
-   */
-  void PutImageToFits( int nbData, double* map) const;
-
-  /*! same as previous method with float data */
-  void PutImageToFits(int nbData, float* map ) const;
-
-  /*! same as previous method with int data */
-  void PutImageToFits(int nbData, int* map) const;
+   void makeHeaderImageOnFits(char type, int nbdim, int* naxisn, DVList &dvl) ;
+   void PutImageToFits( int nbData, double* map) const;
+   void PutImageToFits(int nbData, float* map ) const;
+   void PutImageToFits(int nbData, int* map) const;
 
 
@@ -466 +223 @@
 
 
-  /*! create an BINTABLE header on FITS file.
-\param <fieldType> array conta
-ining characters denoting types of the different column (see method ColTypeFromFits)
-\param <Noms>  array of the names of columns
-\param <nentries>  number of data of each column
-\param <tfields> number of columns
-\param <dvl> a SOPHYA DVList containing keywords to be appended
-\param <extname> keyword EXTNAME for FITS file
-\param <taille_des_chaines> vector containing the number of characters of  data  for each char* typed column, with order of appearance in 'fieldType'
-   */
    void makeHeaderBntblOnFits ( string fieldType, vector<string> Noms, int nentries, int tfields, DVList &dvl, string extname,  vector<int> taille_des_chaines) ;
-
-  /*! write double data from array 'donnees ' on column number 'nocol' of a BINTABLE  extension.
-\param <nentries>  number of data to be written
-
-   */
-  void PutColToFits(int nocol, int nentries, double* donnees) const;
-
-  /*! same as previous method with float data */
-  void PutColToFits(int nocol, int nentries, float* donnees) const;
-
-  /*! same as previous method with int data */
-  void PutColToFits(int nocol, int nentries, int* donnees) const;
-
-  /*! same as previous method with char* data */
-  void PutColToFits(int nocol, int nentries, char** donnees) const;
-
-  void PutBinTabLine(long NoLine,  BnTblLine& ligne) const;
+   void PutColToFits(int nocol, int nentries, double* donnees) const;
+   void PutColToFits(int nocol, int nentries, float* donnees) const;
+   void PutColToFits(int nocol, int nentries, int* donnees) const;
+   void PutColToFits(int nocol, int nentries, char** donnees) const;
+   void PutBinTabLine(long NoLine,  BnTblLine& ligne) const;
 
 
@@ -501 +236 @@
 
 
-/* Put keywords from a DVList into the primary header of the fits-file */
 void  DVListIntoPrimaryHeader(DVList& dvl) const;
 
@@ -515 +249 @@
  };
 
+ struct BnTblLine 
+ {
+   BnTblLine() {}
+   void setFormat(int dc, int fc, int ic, int cc, vector<string> names);
+   bool sameFormat(const BnTblLine& btl) const;
+
+   void Print();
+
+   vector<double> ddata_;
+   vector<float>  fdata_;
+   vector<int>    idata_;
+   vector<string>  cdata_;
+   vector<string> ColName_;
+
+ };