GETHitMask.hh

Go to the documentation of this file.

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

#ifndef GET_HIT_MASK_HH
#define GET_HIT_MASK_HH

//----------------------------------------------------------------------
#include "GETCommon.hh"
#include "GETChannel.hh"

class GETSystem;


//======================================================================
/*! \class GETHitMask
 *
 *  This class defines a mask for analysis of the hit channels of
 *  the detector.
 *
 *  It requires that the lookup table is defined for the GET system.
 *
 *  The hit mask associated a logical value to each channel, indicating
 *  that the channel signal is larger than a threshold.
 */
class GETHitMask
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETHitMask);
  //------------------------------------------------------------

  protected:
    GETSystem     * get_ptr;        ///< Pointer to the GET system
    u_short         data_info;      ///< The flag indicating on which data the mask acts (test, output or reconstructed sample)

    u_int           size;           ///< Number of GET channels
    bool          * hit_table;      ///< Table of hit channels
    bool          * val_table;      ///< Table of valid channels
    double        * threshold[3];   ///< Current mask threshold table (in, out & rec)

    bool            mask_set;       ///< Whether the mask has been computed
    u_int           nhit;           ///< Number of hit channels
    u_int           nhit_val;       ///< Number of hit valid channels

    u_int         * valid_channel;  ///< Array of valid channels indexes
    GETSample    ** valid_sample;   ///< Array of pointers to valid samples

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETHitMask ( GETSystem * get = NULL );
    GETHitMask ( const GETHitMask & mask );
    GETHitMask & operator = ( const GETHitMask & mask );
    virtual ~GETHitMask ( );

    virtual void CopyData ( const GETHitMask & mask );
  //@}

  //----------------------------------------------------------
  /** @name Hit mask building */
  //@{
    virtual void  EraseMask ( );
    virtual int   InitMask  ( );
    virtual void  ClearHitMask   ( );
    virtual void  ClearValidMask ( );
    virtual void  InvertHits ( );

    virtual bool  IsMaskDefined ( ) const;          // inline
    virtual bool  IsMaskSet     ( ) const;          // inline
    virtual void  MaskSet       ( bool b = true );  // inline

    virtual void    SetDataInfo ( u_short info ); // inline
    virtual u_short GetDataInfo ( ) const;        // inline
  //@}

  //----------------------------------------------------------
  /** @name Hit mask data */
  //@{
    GETSystem     * GetSystemPtr ( ) const;     // inline

    virtual u_int   GetSize      ( ) const;     // inline
    virtual u_int   GetNhit      ( ) const;     // inline
    virtual u_int   GetNhitValid ( ) const;     // inline

    virtual double  GetThreshold ( u_int ic = 0, u_short data = GET::signalOut ) const;  // inline
    virtual void    SetThreshold ( double thr, u_short data = 0 );
    virtual void    SetThreshold ( u_int ic, double thr, u_short data = 0 );

    virtual void    SetThresholds ( double * tab, u_short data = 0 );
    virtual void    SetThresholds ( const string & fname, double fact = 1., double cst = 0., u_short data = 0 );

    virtual u_int   UpdateMask       ( );
    virtual u_int   SetMaskHits      ( );
    virtual u_int   SetValidChannels ( );
    virtual u_int   UpdateHitCounts  ( );

    virtual void    SetValid   ( u_int ic, bool b = true );    // inline
    virtual void    SetHit     ( u_int ic, bool b = true );    // inline
    virtual bool    IsValid    ( u_int ic ) const;             // inline
    virtual bool    IsHit      ( u_int ic ) const;             // inline
    virtual bool    IsValidHit ( u_int ic ) const;             // inline

    virtual int          GetValidChannelIndex ( u_int i ) const;    // inline
    virtual GETSample  * GetValidSamplePtr    ( u_int i ) const;    // inline
  //@}

  //----------------------------------------------------------
  /** @name Read-write function */
  //@{
    virtual int   WriteFileText ( const string & fname, u_short data = GET::signalOut );

    virtual int   CreateThresholdXML ( const string & fname, const double rdiscri = 0.05, u_short data = GET::signalOut );
  //@}

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

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


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


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