GETCommon.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETCommon.hh
 *
 *  Common include file for library sources.
 */
//======================================================================

#ifndef GET_COMMON_HH
#define GET_COMMON_HH

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

// GCpp base include files
#include "GGlobal.hh"
#include "GBaseFunctions.hh"
#include "GLogMessage.hh"
#include "GString.hh"

// ROOT / GRootTools include files
#include "TSystem.h"
#include "TRandom3.h"
#include "TMath.h"
#include "TGraphErrors.h"
#include "TGraph2DErrors.h"
#include "TFile.h"

// GFFT include files
#include "RRealSampleFFT.hh"

//! Define the data type for samples
typedef RRealSampleFFT    GETSample;

//! Maximum data depth
#define GET_MAX_DEPTH   512

// Xerces-c include filess (for XML parsing)
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/sax/HandlerBase.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include <xercesc/dom/DOM.hpp>
#include <xercesc/util/XMLString.hpp>

using namespace xercesc;

// GET general include files
#include "GETMetaFrame.hh"

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

//! Macro inverting 2 bytes values
#define GET_SWAP_BYTES(a,b)   { byte __tmp = a; a = b; b = __tmp; }


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

//! End of file returned value
#define GET_EOF           -1

//! Error code for file problem
#define GET_FILE_ERROR     1

//! Error code for frame problem
#define GET_FRAME_ERROR    3

//! Warning code for MFM frames problem
#define GET_FRAME_WARN    -2


//======================================================================
//  Global variables
//  (defined in GETObject.cpp file)

/*! Unique random generator for GET library.*/
extern  TRandom3    GETRandom;    ///< Random numbers generator


//======================================================================
/*! \namespace GET
 *
 *  This namespace defines some values for GET objects and configuration
 *  files.
 */
namespace GET
{
  //----------------------------------------------------------
  /** @name Experimental / simulation data modes */
  //@{

  //! The samples are filled from an experimental data file (in channel output sample)
  static  const u_short   modeUndefined = 0;

  //! The samples are filled from an experimental data file (in channel output sample)
  static  const u_short   modeData      = 1;

  //! The samples are filled from an experimental data file (in channel output sample)
  static  const u_short   modeSimul     = 2;
  //@}

  //----------------------------------------------------------
  /** @name Channel signal sample identifier */
  //@{

  //! Undefined signal sample
  static  const u_short   signalUndef = 0;

  //! Test input (simulation) signal sample
  static  const u_short   signalTst   = 1;

  //! Output (experimental data) signal sample
  static  const u_short   signalOut   = 2;

  //! Reconstructed signal sample
  static  const u_short   signalRec   = 3;
  //@}

  //----------------------------------------------------------
  /** @name Channel information identifier for analyser (histograms filling) */
  //@{

  //! Computed signal amplitude (depends on amplitude mode)
  static  const u_short   dataAmplitude  = 0x0000;

  //! Integral of signal data
  static  const u_short   dataIntegral   = 0x0001;

  //! Full signal data (for 3D)
  static  const u_short   dataFullSignal = 0x0002;

  //! Time of maximum value of signal data
  static  const u_short   dataTime       = 0x0004;

  //! Time bucket of maximum value of signal data
  static  const u_short   dataTimeBin    = 0x000C;

  //! Whether the channel is hit (1) or not (0)
  static  const u_short   dataHit        = 0x0010;

  //! Whether not to consider saturated data (in summary histo filling)
  static  const u_short   dataNoSat      = 0x0020;

  //! Whether not to consider channels with check problems (in summary histo filling)
  static  const u_short   dataNoBad      = 0x0040;

  //@}

  //----------------------------------------------------------
  /** @name Analysis options */
  //@{

  //! Perform input signal reconstruction
  static  const u_short   analyseInputRec = 0x0001;

  //! Perform raw signal analysis
  static  const u_short   analyseRaw      = 0x0002;

  //! Perform corrected signal analysis
  static  const u_short   analyseCor      = 0x0004;

  //! Perform raw and corrected signal analysis
  static  const u_short   analyseAll      = 0x0006;

  //! Perform raw and corrected signal analysis with input signal reconstruction
  static  const u_short   analyseRecAll   = 0x0007;

  //@}

  //----------------------------------------------------------
  /** @name Channels amplitude and timing analysis modes */
  //@{

  //! Channel amplitude calculation mode: maximum signal time bucket
  static  const u_short   amplitudeMaxSignal    = 0x0000;

  //! Channel amplitude calculation mode: integrate all signal
  static  const u_short   amplitudeIntegAll     = 0x0001;

  //! Channel amplitude calculation mode: integrate signal over threshold around maximum
  static  const u_short   amplitudeIntegTOT     = 0x0002;

  //! Channel amplitude calculation mode: integrate all signal over threshold
  static  const u_short   amplitudeIntegThr     = 0x0003;

  //! Channel amplitude (and time) from quadratic estimate on 3 points
  static  const u_short   amplitudeQuadraticMax = 0x0004;

  //  -- fits analysis modes

  //! Flag indicating fit function
  static  const u_short   amplitudeFitFct        = 0x001F;
  //! Flag indicating fit mode
  static  const u_short   amplitudeFit           = 0x0010;
  //! Flag indicating Gauss fit mode
  static  const u_short   amplitudeFitG          = 0x0011;
  //! Flag indicating Gauss x SinC fit mode
  static  const u_short   amplitudeFitGSC        = 0x0012;
  //! Flag indicating Square convolution with Gauss fit mode
  static  const u_short   amplitudeFitSqG        = 0x0013;
  //! Flag indicating Square convolution with Gauss x SinC fit mode
  static  const u_short   amplitudeFitSqGSC      = 0x0014;
  //! Flag indicating fit integral result
  static  const u_short   amplitudeFitInteg      = 0x0100;

  //! Channel amplitude calculation mode: maximum of a Gauss fit (with constant background)
  static  const u_short   amplitudeMaxFitG       = 0x0011;

  //! Channel amplitude calculation mode: integral of a Gauss fit (with constant background)
  static  const u_short   amplitudeIntegFitG     = 0x0111;

  //! Channel amplitude calculation mode: maximum of a Gauss x SinC fit (with constant background)
  static  const u_short   amplitudeMaxFitGSC     = 0x0012;

  //! Channel amplitude calculation mode: integral of a Gauss x SinC fit (with constant background)
  static  const u_short   amplitudeIntegFitGSC   = 0x0112;

  //! Channel amplitude calculation mode: maximum of a Square convolution with Gauss fit (with constant background)
  static  const u_short   amplitudeMaxFitSqG     = 0x0013;

  //! Channel amplitude calculation mode: maximum of a Square convolution with Gauss fit (with constant background)
  static  const u_short   amplitudeIntegFitSqG   = 0x0113;

  //! Channel amplitude calculation mode: maximum of a Square convolution with Gauss x SinC fit (with constant background)
  static  const u_short   amplitudeMaxFitSqGSC   = 0x0014;

  //! Channel amplitude calculation mode: maximum of a Square convolution with Gauss x SinC fit (with constant background)
  static  const u_short   amplitudeIntegFitSqGSC = 0x0114;

  //// Channel amplitude calculation mode: integral of the Gaus part of a Gaus x SinC fit (with constant background)
  ////static  const u_short   amplitudeIntGausFitGSC = 0x0112;

  //  -- local analysis modes

  //! Flag indicating local analysis mode
  static  const u_short   amplitudeLocal       = 0x0200;

  //! Channel amplitude calculation mode: average around maximum signal time bucket
  static  const u_short   amplitudeLocalAvg    = 0x0200;

  //! Channel amplitude calculation mode: quadratic fit around maximum signal time bucket
  static  const u_short   amplitudeLocalFitP2  = 0x0201;


  //! Channel timing from maximum amplitude
  static  const u_short   timingMaxSignal      = 0x0000;

  //! Channel timing from CFD algorithm
  static  const u_short   timingCFD            = 0x0001;

  //! Channel timing from quadratic estimate on 3 points
  static  const u_short   timingQuadraticMax   = 0x0002;

  //@}

  //----------------------------------------------------------
  /** @name Reduced-CoBo options */
  //@{

  //! When reading experimental data, correct for sample 0 artefact
  static  const u_int   RCoBoData0Correction  = 0x00000001;

  //! When reading experimental data, correct for last sample artefact
  static  const u_int   RCoBoDataNCorrection  = 0x00000002;

  //! When reading experimental data, correct for last cell read of AGet number 2
  static  const u_int   RCoBoCorrectLC2       = 0x00000010;

  //! When reading experimental data, correct with closer FPN channel (only for signal channels)
  static  const u_int   RCoBoCorrectFPN1      = 0x00000020;

  //! When reading experimental data, correct with 2 half chip FPN channels average (only for signal channels)
  static  const u_int   RCoBoCorrectFPN2      = 0x00000040;

  //! When reading experimental data, correct with average FPN (only for signal channels)
  static  const u_int   RCoBoCorrectFPN4      = 0x00000060;
  //! When reading experimental data, correct with average FPN (only for signal channels)
  static  const u_int   RCoBoCorrectFPN       = 0x00000060;

  //! all option for corrections when reading events
  static  const u_int   RCoBoCorrectEvents    = 0x000000FF;

  //@}

  //----------------------------------------------------------
  /** @name All GET systems options */
  //@{

  //! When reading experimental data, correct for first sample(s) artefact
  static  const u_int   CoBoData0Correction   = RCoBoData0Correction;

  //! When reading experimental data, correct for last sample(s) artefact
  static  const u_int   CoBoDataNCorrection   = RCoBoDataNCorrection;

  //! When reading experimental data, correct with closer FPN channel (only for signal channels)
  static  const u_int   CoBoCorrectFPN1       = RCoBoCorrectFPN1;

  //! When reading experimental data, correct with 2 half chip FPN channels average (only for signal channels)
  static  const u_int   CoBoCorrectFPN2       = RCoBoCorrectFPN2;

  //! When reading experimental data, correct with average FPN (only for signal channels)
  static  const u_int   CoBoCorrectFPN4       = RCoBoCorrectFPN4;
  //! When reading experimental data, correct with average FPN (only for signal channels)
  static  const u_int   CoBoCorrectFPN        = RCoBoCorrectFPN4;


  /*! When reading experimental data, a (software) zero suppression is
   *  performed on data.
   *  Note that this option cancels the FPN and automatic baseline
   *  corrections.
   */
  static  const u_int   CoBoZeroSuppress      = 0x00000400;

  /*! Option to check and correct for bad data read (this option
   *  works only if hardware zero suppress mode is NOT set).
   */
  static  const u_int   CoBoCorrectBadData    = 0x00001000;

  //! All options for corrections when reading events
  static  const u_int   CoBoCorrectEvents     = 0x00001FFF;

  //@}

  //----------------------------------------------------------
  /** @name Options for (un)merged events processing */
  //@{

  //! Skip events with incomplete merged frames
  static  const u_int   MergedIncompleteSkip    = 0x00001000;

  //! Error on events with incomplete merged frames
  static  const u_int   MergedIncompleteError   = 0x00003000;

  //! Process single CoBo/AsAd frames as events
  static  const u_int   ProcessSingleFrames     = 0x00004000;

  //! Do not unpack CoBo/AsAd frames (fast reading)
  static  const u_int   NoCoBoFrameUnpack       = 0x00008000;

  //@}


  //----------------------------------------------------------
  /** @name Filters options */
  //@{

  //! Normalize filter to conserve signal integral
  static  const u_int   filterNormalize   = 0x00000001;

  //@}

  //----------------------------------------------------------
  // Configuration files data

  //! This namespace defines configuration files values.
  namespace CFG
  {

  //----------------------------------------------------------
  /** @name Channels configuration */
  //@{

    //! Defines the trigger inhibit identifiers.
    enum TriggerInhibit { inhibitChannel,
                          inhibitTriggerData,
                          inhibitTriggerFunction,
                          inhibitNone };

    //! Defines the CSA gain identifiers.
    enum CSAGain { csa10pC, csa120fC, csa1pC, csa240fC };

    //! Defines the reading modes identifiers.
    enum ReadingMode { readAlways,
                       readNever,
                       readOnlyIfHit };
  //@}

  //----------------------------------------------------------
  /** @name AGet configuration */
  //@{

    // AGet / Global / Reg1 configuration */

    //! Defines the test mode capacitors values identifiers.
    enum TestModeRange { capa10pF, capa120fF, capa1pF, capa240fF };

    //! Defines the peaking time values identifiers.
    enum PeakingTime { peaking70,  peaking117, peaking232, peaking280,
                       peaking334, peaking383, peaking502, peaking541,
                       peaking568, peaking632, peaking721, peaking760,
                       peaking831, peaking870, peaking976, peaking1014 };

    //! Defines the test mode selection identifiers.
    enum TestModeSelection { testModeCalibration,
                             testModeFunctionality,
                             testModeNothing,
                             testModeTest };

    //! Defines the SCA pointer identifiers.
    enum TSCAPointer { anySCAPointer,
                       col0or128or256or384,
                       col0or256,
                       column0 };

    //! Defines the Vicm values identifiers.
    enum Vicm { vicm125V, vicm135V, vicm155V, vicm165V };
  //@}

  }
}

//----------------------------------------------------------------------
#endif