Changeset 1659 in Sophya for trunk/SophyaExt/FitsIOServer/fabtwriter.cc

Timestamp:

Sep 28, 2001, 7:22:39 PM (24 years ago)

Author:

cmv

Message:

• documentation updatee
• des lecteurs de TVector double,float,int_4 dans FitsABTColRead
• des methodes nouvelles dans le FitsABTColRead

cmv 28/9/01

File:

• trunk/SophyaExt/FitsIOServer/fabtwriter.cc (modified) (6 diffs)

trunk/SophyaExt/FitsIOServer/fabtwriter.cc

@@ -10 +10 @@
   \ingroup FitsIOServer
   Class for writing a FITS ASCII or BINARY table
-  \verbatim\
-  Exemple:
-  FitsABTWriter fbtw("myfits.fits",BINARY_TBL,3);
+  \verbatim
+  //-----------------------------------------------------------
+  -- Exemple 1: Writing element by element
+  FitsABTWriter fbtw(fitswrit,BINARY_TBL);
   fbtw.SetExtName("MY_OWN_EXTENSION");
   fbtw.AddCol("vars",TSHORT,"","km");       // col=0
@@ -33 +34 @@
   cout<<"Number of Overflows when writing: "
       <<fbtw.GetNOverFlow()<<endl;
+
+  //-----------------------------------------------------------
+  -- Exemple 2: Writing into TVector
+  ...
+  TVector<double> datad(100);
+  TVector<float>  dataf(100);
+  TVector<int_4>  datal(100);
+  for(long i=0;i<9990;i+=100) {
+    long i2=i+100-1; if(i2>=9990) i2=9990-1;
+    for(long j=0;j<100;j++) datad(i) =  ...;
+    for(long j=0;j<100;j++) dataf(i) =  ...;
+    for(long j=0;j<100;j++) datal(i) =  ...;
+    fbtw.Write(1,i,datal);
+    fbtw.Write(2,i,dataf);
+    fbtw.Write(3,i,datad);
+  }
   \endverbatim
 */
@@ -39 +56 @@
 /*!
   Constructor.
-  \verbatim
-  fname : FITS file name to be written
-  hdutype : type of extension to be created (BINARY_TBL or ASCII_TBL)
-  lp : debug level
-  \endverbatim
+  \param fname : FITS file name to be written
+  \param hdutype : type of extension to be created (BINARY_TBL or ASCII_TBL)
+  \param lp : debug level
 */
 FitsABTWriter::FitsABTWriter(string fname,int hdutype,int lp)
@@ -103 +118 @@
 /*!
   Add a new column to the FITS table
-  \verbatim
-  label : column label
-  datatype : TSHORT TINT32BIT TFLOAT or TDOUBLE
-  tform : fits tform definition
-          (can be automatically set if BINARY_TBL and tform="")
-  tunit : fits tunit definition (optional)
-  \endverbatim
+  \param label : column label
+  \param datatype : TSHORT TINT32BIT TFLOAT or TDOUBLE
+  \param tform : fits tform definition
+         (can be automatically set if BINARY_TBL and tform="")
+  \param tunit : fits tunit definition (optional)
+  \return The number of the new added column in the table.
+  \warning col = [0,ncol-1]
 */
 int FitsABTWriter::addcol(const char* label,int datatype
@@ -197 +212 @@
 /*!
   Write a short data to FITS file.
-  \verbatim
-  col : column number [0,ncol[
-  row : row number    [0,nrow[
-  val : value to be written
-  WARNING: that routine write a SHORT value into column "col"
+  \param col : column number [0,ncol[
+  \param row : row number    [0,nrow[
+  \param val : value to be written
+  \warning that routine write a SHORT value into column "col"
            which could have been defined with an other type.
            Cast is performed by the cfitsio package.
+  \verbatim
   WARNING: suppose that the column has be defined to be TSHORT
            and suppose that you wanted to write a double value
@@ -254 +269 @@
 /*!
   Write a vector of long data to FITS file.
-  \verbatim
-  col : column number [0,ncol[
-  row : starting row number    [0,nrow[
-  val : vector to be written
-  Return: "N" = number of the next row to be written
-          that is "N-1" is the number of the last row written.
-  \endverbatim
+  \param col : column number [0,ncol[
+  \param row : starting row number    [0,nrow[
+  \param val : vector to be written
+  \return "N" = number of the next row to be written,
+      that is "N-1" is the number of the last row written.
 */
 /*! Write a vector of long data to FITS file (see below) */