GETDocMainPage.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETDocMainPage.hh
 *
 *  Main documentation page for GET library.
 */
//======================================================================

//======================================================================
/*! \mainpage GET Library documentation
 *
 *  \author J. Giovinazzo (giovinaz@cenbg.in2p3.fr)
 *
 *  \par Presentation
 *
 *  The GET library defines classes to process signals from the GET
 *  electronics architecture.
 *  It is designed to analyse data from real measurements (that fill
 *  the GET system channels \b output samples) or from simulations
 *  (that must be considered as the \b input channels data that are processed
 *  by the GET system library objects).
 *
 *  The purpose of processing simulated data is mainly to test the analysis
 *  procedures developed for physics analysis, and to some extend to set the
 *  optimal experimental conditions.
 *
 *
 *  \par Requirements, compilation and configuration
 *
 *  For compilation see page \ref get_page_compilation.
 *  Only Linux OS are supported.
 *
 *
 *  \par Using the libraries
 *
 *  - \ref get_page_linking
 *
 *  - \ref get_page_embed_root
 *
 *  - Additional tools associated to the library:
 *    - \ref get_page_actar_reader
 *
 *
 *  \par Library description
 *
 *  The C++ source files are organised in source subdirectories:
 *  - Core : the classes describing GET system main objects, following
 *    the GET electronics architecture
 *  - Processing : the classes needed for signal processing (response functions
 *    and filtering classes).
 *  - Config : the classes holding GET system configuration data (from XML
 *    configuration files)
 *
 *  For more details, see:
 *  - \ref get_page_core for the description of the GET objects that define
 *    a system;
 *  - \ref get_page_process for the processes that may be defined for
 *    signal processing;
 *  - \ref get_page_config for interaction of the core objects with
 *    experimental system configuration files (<B>not yet implemented</B>);
 *  - \ref get_page_examples for examples of the use of the library.
 *
 *  There are also ROOT macros provided for display or analysis of the GET
 *  signals.
 *  A specific documentation is generated at compilation time, for the
 *  description of the ROOT macros provided.\n
 *
 *  See file \global_docs_dir/GET\get_version/root/html/index.html (website documentation)
 *
 *  or
 *  <a href="$(GET_BASE)/root/docs/html/index.html">
 *              <tt>${GET_BASE}/root/docs/html/index.html</tt>
 *           </a> (if locally installed documentation)
 *
 *
 *  \par Units system
 *
 *  GET core classes:
 *  - time unit = \b us (this can be important if mixing the library objects
 *    with other packages (such as Geant4).
 *
 */
//======================================================================