GETDocExamples.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETDocExamples.hh
 *
 *  Documentation page defining examples pages.
 */
//======================================================================

//======================================================================
/*! \page get_page_examples Examples for use of the GET library
 *
 *  The files presented in this section are located in the \b examples
 *  directory of the package.
 *
 *
 *  \section get_examples_programs C++ program examples
 *
 *  - These are very simple C++ programs showing how to define a GET
 *    system and read events from a run file: one for a 
 *    Reduced-CoBo system \ref ReadEvent_RCoBo.cxx
 *    and on for a TPC demonstrator system \ref ReadEvent_Demonstrator.cxx
 *
 *  - Reading of the XML configuration files: \ref ReadConfig.cxx
 *
 *  \section get_examples_root ROOT session examples
 *
 *  In order to use the GET library in a ROOT session, it must be
 *  loaded, either in the ROOT login macro, either during the session
 *  itself:
 *  \code
 *  gROOT->Macro ( (getenv("GET_BASE")+string("/root/GETRootLibs.C")).c_str() );
 *  \endcode
 *
 *  - ROOT example for GET channel processing of signal:
 *    \ref TestChannel.C
 *
 *  - ROOT example to read events from a GET system in a ROOT macro:
 *    \ref ReadRCoBo.C
 *
 *  - Reduced-CoBo run file average / RMS (with GETRoot library):
 *    \ref RCoBo_ChannelMeanRMS.C
 *
 *  - TPC demonstrator run file average / RMS: 2 examples showing
 *    the access to channels output signal in one case
 *    (\ref Demonstrator_RMS1.C),
 *    and using the GETRoot library functions in the other case
 *    (\ref Demonstrator_RMS2.C)
 *
 *  - TPC demonstrator noise for all
 *    channels ( \ref Demonstrator_Noise.C)
 *
 *
 *  \section get_splitting_programs Programs for splitting and merging CoBo frames
 *
 *  Two small programs are included in the library in order to extract
 *  data frames (CoBo) from a run file and/or to merge them.
 *
 *
 *  \par Splitting CoBo frames
 *
 *  It happens, when running CoBo modules without MuTAnT, or for any reason,
 *  that the CoBo frames are somewhat mixed in the run file.
 *  The program \b GETCoboFramesSplit allows to read the file, and write
 *  separately the header frames and the frames for every single AsAd
 *  board.
 *
 *  To print the program help, enter the command with no argument:
 *  \code
 *  [shell] GETCoboFramesSplit
 *  \endcode
 *
 *  For example, to split frames from a file <run_file.dat> (in current
 *  directory), where 2 CoBo modules wher used:
 *  \code
 *  [shell] GETCoboFramesSplit 2 <run_file.dat> "."
 *  \endcode
 *
 *  A sub-directory is created for each CoBo/AsAd and for header with a
 *  file <run_file.dat> containing only the corresponding frame.
 *
 *  In addition, an input file \b <run_file.dat>.merge is created for the
 *  program that can remerge the frames.
 *
 *
 *  \par Merging CoBo frames
 *
 *  The program \b GETCoboFramesMerge reads separated CoBo/AsAd frame
 *  files and write them in one single file, ordered according to the
 *  time stamp (to be tested) or the event number (default).
 *
 *  To print the program help and the supported options, enter the command
 *  with no argument:
 *  \code
 *  [shell] GETCoboFramesMerge
 *  \endcode
 *
 *  The program needs an input file such as the one created by the
 *  frames splitting program:
 *  \include "run_file.dat.merge"
 *
 *  The merging can be achieved with:
 *  \code
 *  [shell] GETCoboFramesMerge <run_file.dat>.merge
 *  \endcode
 *
 */

//======================================================================
/*! \example ReadConfig.cxx
 *
 *  WARNING: THE USE OF EFFECTIVE CONFIGRATION FILES IS NOT
 *  YET IMPLEMENTED IN AN EFFECTIVE WAY...
 *
 */

//----------------------------------------------------------------------

/*! \example ReadEvent_RCoBo.cxx
 *
 *  The Reduced-CoBo is a GET system with 1 CoBo module and 1 single
 *  AsAd board.
 *
 */

/*! \example ReadEvent_Demonstrator.cxx
 *
 *  The demonstrator is a GET system with 2 CoBo modules and 8
 *  AsAd boards.
 *
 */

//======================================================================
/*! \example TestChannel.C
 *
 *  The following ROOT macro plots the input, output
 *  and reconstructed signals of a single GET channel:
 *  - the input sample has 2 Gauss component
 *  - some input noise is added to the signal (GETNoise class)
 *  - the response function is analystical (GETResponseFctAget class)
 *  - some noise is added to the output signal (GETNoise class)
 *  - the reconstruction is performed with filtering (GETFilterAgetGaus class)
 *
 *  The \ref TestChannel.C example requires the functions defined in the
 *  \ref TestCore.C.
 *  In this example, it is necessary to compile the ROOT macro files,
 *  because they use function pointers, that are not supported in the
 *  ROOT command interpreter.
 *
 *  \image html "TestChannelSignal100.png"
 *  \image rtf "TestChannelSignal100.png"
 *
 *  \image html "TestChannelPower100.png"
 *  \image rtf "TestChannelPower100.png"
 *
 */
 
/*! \example TestCore.C
 *
 *  Functions definition for the TestChannel.C example:
 *
 *  Header file:
 *  \include TestCore.H
 *
 *  Source file:
 *
 */

//----------------------------------------------------------------------
/*! \example ReadRCoBo.C
 *
 *  Example file to read 1 event and plot the content of a full AGET
 *  chip.
 *
 *  It can be executed in a ROOT session with:
 *  \code
 *  [ROOT] .L ReadRCoBo.C
 *  [ROOT] RCoBoPlotAGet ( "../../data/RCoBo/CoBo_baseline.graw", 1, 17 );
 *  \endcode
 *
 */

//----------------------------------------------------------------------
/*! \example RCoBo_ChannelMeanRMS.C
 *
 *  Example macro file that reads a reduced-CoBo file to build the average
 *  and the RMS for each channel (only one is displayed).
 *
 *  \image html "RCoBo_ChannelMeanRMS.png"
 *  \image rtf "RCoBo_ChannelMeanRMS.png"
 *
 *  This example uses the functions from the GETRoot library.
 *  It can be executed in a ROOT session with:
 *  \code
 *  [ROOT] .L RCoBo_ChannelMeanRMS.C
 *  [ROOT] PlotRCoBo_ChannelMeanRMS ( "../../data/RCoBo/CoBo_baseline.graw", 1, 17 );
 *  \endcode
 *
 */

//----------------------------------------------------------------------
/*! \example Demonstrator_RMS1.C
 *
 *  Example of a ROOT macro that computes the average samples and the RMS
 *  for all channels, from aTPC demonstrator run file.
 *
 *  \image html "Demonstrator_RMS1.png"
 *  \image rtf "Demonstrator_RMS1.png"
 *
 *  \code
 *  [ROOT]  .L Demonstrator_RMS1.C
 *  [ROOT]  PlotDemonstrator_RMS1 ( "../../data/Demonstrator/run_baseline.dat", 0, 0, 1, 17 );
 *  \endcode
 *
 *  The processing is done in the macro itself, from channels output
 *  content.
 */

//----------------------------------------------------------------------
/*! \example Demonstrator_RMS2.C
 *
 *  Example of a ROOT macro that computes the average samples and the RMS
 *  for all channels, from aTPC demonstrator run file.
 *
 *  \image html "Demonstrator_RMS2.png"
 *  \image rtf "Demonstrator_RMS2.png"
 *
 *  \code
 *  [ROOT]  .L Demonstrator_RMS2.C
 *  [ROOT]  PlotDemonstrator_RMS2 ( "../../data/Demonstrator/run_baseline.dat", 0, 0, 1, 17 );
 *  \endcode
 *
 *  The processing is done by the functions from the GETRoot library.
 */

//----------------------------------------------------------------------
/*! \example Demonstrator_Noise.C
 *
 *  Example of a ROOT macro that computes the average fluctuations over
 *  time buckets, for all channels.
 *
 *  \image html "Demonstrator_Noise.png"
 *  \image rtf "Demonstrator_Noise.png"
 *
 *  \code
 *  [ROOT]  .L Demonstrator_Noise.C
 *  [ROOT]  PlotDemonstrator_Noise ( "../../data/Demonstrator/run_baseline.dat", 0, 0, 1, 17 );
 *  \endcode
 *
 *  The processing is done by the functions from the GETRoot library for
 *  the channels mean and RMS samples, and then by the macro for averaging
 *  the RMS over time buckets.
 */

//======================================================================