Changeset 4016 in Sophya for trunk/AddOn/TAcq/specmfib.cc

Timestamp:

Aug 12, 2011, 2:26:10 PM (14 years ago)

Author:

ansari

Message:

Ajout de commentaires d'autodocumentation Doxygen, Reza 12/08/2011

File:

• trunk/AddOn/TAcq/specmfib.cc (modified) (1 diff)

trunk/AddOn/TAcq/specmfib.cc

@@ -5 +5 @@
 /* ---------------------------------------------------------- 
    Programme de lecture multifibres, calcul de spectres 
-   BAORadio -   LAL/IRFU      R. Ansari, C. Magneville
-   Septembre 2010 - 2011
+   BAORadio -   LAL/IRFU      R. Ansari, C. Magneville, J.E. Campagne
+   2010 - 2011
    ---------------------------------------------------------- */
+/*!
+   \ingroup TAcq
+   \file specmfib.cc
+
+   \brief Data cleaning and computation of mean spectrum of gain/normalization spectrum
+
+   This program uses the BRMeanSpecCalculator, BRGainCalculator and BRMultiFitsReader classes
+   to clean data and compute mean spectra and normalization/gain spectrum from 
+   raw or FFT data read from FITS files (data in BRPaquet format). 
+   The BRFFTCalculator class is used to compute fourier coefficients on raw data and 
+   BRAnaParam class is used for defining and decoding the program run parameters.
+
+  \verbatim
+csh> specmfib 
+ ===> specmfib.cc: decoding command line arguments 
+ --- BRAnaParam : Reading/Processing BAORadio FITS files parameters 
+ Usage:  prgname [-act ACT] [-out OutPath] [-fitsout] 
+                 [-nmean NMean] [-tmint dtime] [-zones NZones,nPaqinZone] 
+                 [-nbloc NBloc] [-freq NumFreqMin,NumFreqMax,NBinFreq] 
+                 [-prt lev,modulo,mod2] [-nvcal n] [-nthr n] [-nosfc]
+                 [-singlechan] [-twochan] [-fftdata] [-rawdata] 
+                 [-freqfilter medhw] [-gain filename] [-varcut min,max] [-nband nband,first,last] 
+                 [-freqfilter] [-gain filename] [-varcut min,max] [-nband nband,first,last] 
+                 [-tmproc hh:mm:ss,nseconds] [-fdtpaq] [-fdtms] [-tspwin wsz,extsz,nfiles] 
+         -in Imin,Imax,Istep InPath FiberList [InPath2 FiberList2 InPath3 FiberList3 ...] 
+
+ prgname -h for detailed instructions
+  \endverbatim 
+*/
 
 // include standard c/c++