GETObject.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETObject.hh
 *
 *  Include file for the GETObject class.
 */
//======================================================================

#ifndef GET_OBJECT_HH
#define GET_OBJECT_HH

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

#include "GETCommon.hh"
#include "GETProcessLink.hh"
#include "GETProcess.hh"
#include "GETProcessSerie.hh"
#include "GETSignalModifier.hh"
#include "GETResponse.hh"
#include "GETFilter.hh"
#include "GETNoise.hh"


//======================================================================
/*! \class GETObject
 *
 *  This class defines base properties for GET system core objects.
 *  The GET objects, at any level, define the signal processing
 *  information, based on 4 GETProcessingData objects:
 *  - the response function
 *  - the filter for reconstruction of the input signal
 *  - an noise process to a apply on input signal
 *  - an noise process to a apply on output signal
 *
 *  The use of GETProcessingData objects allow to define these processes
 *  (if needed) either locally, either externally for sharing the
 *  same process for several GET objects (see GETProcessingData).
 */
class GETObject
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObjectV(GETObject);
  //------------------------------------------------------------

  friend class GETSystem;

  protected:
    int         id;                 ///< Object identifier number (set by the parent, in filiation)
    GETObject * parent;             ///< Parent AGet chip
    bool        is_read;            ///< Flag indicating some data was read for the object (from exp. raw data)

    GETProcessLink  response;       ///< Signal response function
    GETProcessLink  filter;         ///< Signal processing filter
    GETProcessLink  noise_in;       ///< Simulation input noise generator
    GETProcessLink  noise_out;      ///< Simulation output noise generator
    GETProcessLink  output_corr;    ///< Output signal correction before reconstruction of input

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETObject ( );
    virtual ~GETObject ( );
  //@}

  //----------------------------------------------------------
  /** @name GET system core objects functions */
  //@{
    int     GetId       ( ) const;          // inline

    /*! Return the object string identifier.*/
    virtual string        GetObjectId ( ) const = 0;

    virtual string        GetFullId       ( ) const;
    virtual u_int         GetSignalChannelCount ( ) const;
    virtual u_int         GetTotalChannelCount  ( ) const;
    virtual u_int         GetChannelCount       ( ) const;    // inline
    virtual GETChannel  * GetSignalChannel      ( u_int n );
    virtual GETChannel  * GetTotalChannel       ( u_int n );
    virtual GETChannel  * GetChannel            ( u_int n );  // inline

    const GETObject * GetParent ( ) const;  // inline
          GETObject * GetParent ( );        // inline

    virtual void    SetTimeStep  ( double dt );
    u_int           GetSampleDim ( );
    double          GetTimeStep  ( );

    /*! Return the number of children objects.*/
    virtual u_int   GetChildrenNumber ( ) const = 0;

    /*! Return the pointer of a child objects.*/
    virtual const   GETObject * GetChild ( u_int i ) const = 0;

    /*! Return the pointer of a child objects.*/
    virtual         GETObject * GetChild ( u_int i ) = 0;

    virtual void    SetReadoutFlag         ( bool b = true );   // inline
    bool            GetReadoutFlag         ( ) const;           // inline
    virtual u_int   GetReadoutMultiplicity ( bool fpn = true ) const;
    virtual double  GetSignalSum           ( u_short info = GET::signalOut );

  //@}

  //----------------------------------------------------------
  /** @name Initialization and signal related functions */
  //@{
    virtual void  InitLocalData ( u_int n, double dt );

    virtual void  ValidDataSet  ( );
    virtual void  ValidSimulSet ( );

    virtual void  ClearEvent ( );
  //@}

  //----------------------------------------------------------
  /** @name Common processing data: response function, filter, noise */
  //@{
    virtual void SetResponse         ( GETResponse       * ptr, bool recur = true, bool fpn = false );
    virtual void SetResponse         ( GETResponse       & obj, bool recur = true, bool fpn = false );
    virtual void SetFilter           ( GETFilter         * ptr, bool recur = true, bool fpn = false );
    virtual void SetFilter           ( GETFilter         & obj, bool recur = true, bool fpn = false );
    virtual void SetNoiseIn          ( GETSignalModifier * ptr, bool recur = true, bool fpn = false );
    virtual void SetNoiseIn          ( GETSignalModifier & obj, bool recur = true, bool fpn = false );
    virtual void SetNoiseOut         ( GETSignalModifier * ptr, bool recur = true, bool fpn = false );
    virtual void SetNoiseOut         ( GETSignalModifier & obj, bool recur = true, bool fpn = false );

    // set simple output correction process
    virtual void SetOutputCorrection ( GETProcess        * ptr, bool recur = true, bool fpn = false );
    virtual void SetOutputCorrection ( GETProcess        & obj, bool recur = true, bool fpn = false );

    // set output correction process list
    virtual void RemoveOutputCorrection  ( );
    virtual void SetOutputCorrectionList ( bool warn = true );
    virtual void AddOutputCorrection ( GETProcess * ptr, bool recur = true, bool fpn = false  );
    virtual void AddOutputCorrection ( GETProcess & obj, bool recur = true, bool fpn = false  );

    GETResponse       * GetResponse         ( bool force = true );
    GETFilter         * GetFilter           ( bool force = true );
    GETSignalModifier * GetNoiseIn          ( bool force = true );
    GETSignalModifier * GetNoiseOut         ( bool force = true );
    GETProcess        * GetOutputCorrection ( bool force = true );

  //@}

  //----------------------------------------------------------
  /** @name Samples processing */
  //@{
    virtual int   ProcessData       ( bool in_noise = true );
    virtual int   ProcessOutFromTst ( bool in_noise = true, bool out_noise = true );
    virtual int   ProcessRecFromOut ( bool out_corr = true );

    virtual int   ProcessOutputCorrection ( );
  //@}


  //----------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  public:

    /*! for use within ROOT.*/
    ClassDef(GETObject,0);
  //@}
};


//----------------------------------------------------------------------
//  Inline functions
#include "icc/GETObject.icc"


//======================================================================
#endif