Changeset 4016 in Sophya for trunk/AddOn/TAcq/mfacq.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/mfacq.cc (modified) (1 diff)

trunk/AddOn/TAcq/mfacq.cc

@@ -3 +3 @@
 //---------------------------------------------------------------
 // Programme d'acquisition BAORadio multi-fibres/multi-threads 
-//  LAL -   2009 - 2010
+//  LAL -   2009 - 2011
 //     R. Ansari, M.Taurigna
 //---------------------------------------------------------------
+/*!
+   \ingroup TAcq
+   \file mfacq.cc
+
+   \brief BAORadio/21cm acquisition main program (see acqparam_exemple.d datacard file)
+
+   This program has four main execution modes:
+   <UL>
+   <LI> -pci2disk : PCI express DMA read of BRPaquet  , data saved to disk in FITS files
+   <LI> -pci2eth :  PCI express DMA read of BRPaquet, data send over ethernet to other mfacq tasks, running 
+   on the same or different machines.
+   <LI> -eth2disk : read data ( BRPaquet ) on network interfaces (ethernet) and save data to disk in FITS files
+   <LI> -eth2visib : read data ( BRPaquet ) on network interfaces (ethernet), compute visibilities and save visibility 
+   matrices to disk
+   </UL> 
+
+  \verbatim
+ csh> mfacq -h 
+ Usage: mfacq Action DataCardFileName [-dc DataCard -dc DataCard] [TargetMachines]
+ o Action = -pci2disk , -pci2eth , -eth2disk , -eth2visib 
+    DataCardFile : File name for parameters list (DataCards) : 
+     fibres outpathname skysource paqsize dmasizekb nbfiles 
+     nblocperfile acqmode memmgr monitor reducpaqsz ... 
+ o -dc DataCard : datacard appended for DataCardFileName
+ o TargetMachines : List of target machines for PCIe2Ethernet (-pci2eth) 
+  
+  \endverbatim 
+*/
 
 static RAcqMemZoneMgr* pMmgr=NULL;