/data3/calcul/jacquem/working_dir/Micromegas/micromegasFrameWork/include/root/CaloEvent.hh

Go to the documentation of this file.

/* @version $Revision: 1416 $ * @modifiedby $Author: jacquem $ * @lastmodified $Date: 2011-11-18 16:11:02 +0100 (Fri, 18 Nov 2011) $ */

#ifndef ROOT_CALOEVENT
#define ROOT_CALOEVENT

#include "TObject.h"
#include "TClonesArray.h"



/*!
 * \file CaloEvent.hh
 * \brief Describe calorimeter event 
 * 
 * -pointer to event's hits collection: fHits
 *
 * -event Id: fEventId
 *
 * -number of hits : fNHits
 *
 * -Position of track extrapolated at m2 prototype along X :  fXExtrapol  
 *
 * -Position of track extrapolated at m2 prototype along Y :   fXExtrapol  
 *
 * \author Jean  and Max
 * \version "$Revision: 1416 $"
 */

//////////////////////////////////////////////////////////////////////////
//                                                                      //
// CaloEvent   
//                                                                      //
//////////////////////////////////////////////////////////////////////////

class CaloHit;
class MTEvent;

/*!
 * \class CaloEvent
 * \brief Describe calorimeter event
 * 
 * -pointer to event's hits collection: fHits
 *
 * -event Id: fEventId
 *
 * -number of hits : fNHits
 *
 * -value along x axis for telescope : fXTelescope
 *
 * -value along y axis for telescope : fYTelescope
 *
 */

class CaloEvent :  public TObject {

public:
 /*!
 *  \brief Constructor
 *
 *  CaloEvent class constructor
 *
 *  \param none
 */

   CaloEvent();
 /*!
 *  \brief copy assignment operator
 *
 *  CaloEvent copy assignment operator. Copy MTEvent to CaloEvent
 *
 *  \param const reference of MTEvent to copy
 */
   CaloEvent& operator=( const  MTEvent& rhs) ;
 /*!
 *  \brief Destructor
 *
 *  CaloEvent class destructor
 *
 *  \param none
 */
   virtual ~CaloEvent();   // virtual to call ~TObject

 /**
 * \fn AddHit(const CaloHit& ahit) 
 * \brief Add hits to this event.
 * \param const reference on CaloHit.
 *
 * \Create new CaloHit and store it into class fHits TClonesArray.
 * \return pouinter to the new created CaloHit.
 */

   CaloHit* AddHit(const CaloHit& ahit);

/**
 * \fn Clear(Option_t *option ="") 
 * \brief Clear fHits TClonesArray and set number of hit for this event to zero
 * \param Option_t for TClonesArray::Clear method
 *
 */
   void Clear(Option_t *option ="");

 /**
 * \fn GetHits(void)
 * \brief Getter for fHits TClonesArray.
 * \param void.
 * \return pointer to fHits TClonesArray
 */
   inline TClonesArray* GetHits() const { return fHits; };

 /**
 * \fn GetNHits(void)
 * \brief Getter for number of event's hits, fNHits .
 * \param void.
 * \return fNHits, number of eventś hits
 */
   inline UInt_t GetNHits() const { return fNHits; };

/**
 * \fn GetXExtrapol(void) const
 * \brief Getter expected position along x axis of CaloHit (calculated from telescope info)
 * \param void.
 * \return fXExtrapol
 */
   inline Float_t GetXExtrapol(void) const { return fXExtrapol; };

/**
 * \fn GetYExtrapol(void) const
 * \brief Getter expected position along y axis of CaloHit (calculated from telescope info)
 * \param void.
 * \return fYExtrapol
 */
   inline Float_t GetYExtrapol(void) const { return fYExtrapol; };

/**
 * \fn UInt_t GetTrkQuality(void) { return fTrkQuality; } ;
 * \brief Getter for quality of trak from pad telescope
 * \param  UInt_t value = 0,1,2
 * 0: track (aligned 3x3 cm2 clusters in all chambers)
 * 1: straight track (aligned max. in all chambers)
 * 2: stiff track (single hit in all chambers)
 * \return track quality
 */
  inline UInt_t GetTrkQuality(void) { return fTrkQuality; } ;

 /**
 * \fn GetEventId()
 * \brief Getter for fEventId .
 * \param void.
 * \return fEventI
 */
  inline UInt_t  GetEventId(void) { return fEventId; } ; 

/**
 * \fn SetEventId(const UInt_t value)
 * \brief Setter for event id
 * \param UInt_t new event id.
 * \return none
 */
  inline void SetEventId(const UInt_t value) { fEventId = value; } ; 

 /**
 * \fn GetDeltaTmax()
 * \brief Getter for deltaT candidate (number of hits upper than threshold) fDeltaTmax  .
 * \param void.
 * \return fDeltaTmaxNHits, deltaT candidate
 */
  inline UInt_t  GetDeltaTmax(void) { return fDeltaTmax; } ; 

 /**
 * \fn GetBcIdAbs()
 * \brief Getter for fBcIdAbs. BcIdAbs is RAMFull record time (identical for all CalEvent of a Lcio record)
 * \param void.
 * \return fBcIdAbs
 */
  inline UInt_t  GetBcIdAbs(void) { return fBcIdAbs; } ; 

 /**
 * \fn SetBcIdAbs()
 * \brief Setter for fBcIdAbs. BcIdAbs is RAMFull record time (identical for all CalEvent of a Lcio record)
 * \param UInt_t new bcIdAbs value.
 * \return none
 */
  void SetBcIdAbs(UInt_t value) { fBcIdAbs = value; } ; 

/**
 * \fn SetXExtrapol(const Float_t value)
 * \brief Setter for expected position along x axis of CaloHit (calculated from telescope info)
 * \param  Float_t new telescope value along x axis
 * \return none
 */
  inline void SetXExtrapol(const Float_t value) { fXExtrapol = value; } ; 

/**
 * \fn SetYExtrapol(const Float_t value)
 * \brief Setter for expected position along y axis of CaloHit (calculated from telescope info)
 * \param  Float_t new telescope value along y axis
 * \return none
 */
  inline void SetYExtrapol(const Float_t value) { fYExtrapol = value; } ; 

/**
 * \fn SetTrkQuality(const UInt_t value) { fTrkQuality = value; } ; 
 * \brief Setter for quality of trak from pad telescope
 * \param  UInt_t value = 0,1,2
 * 0: track (aligned 3x3 cm2 clusters in all chambers)
 * 1: straight track (aligned max. in all chambers)
 * 2: stiff track (single hit in all chambers)
 * \return none
 */
  inline void SetTrkQuality(const UInt_t value) { fTrkQuality = value; } ; 

 /**
 * \fn SetDeltaTmax()
 * \brief Setter for number of event's hits, fNHits .
 e \param void.
 * \return fNHits, number of eventś hits
 */
  inline void SetDeltaTmax(const UInt_t dtmax) { fDeltaTmax = dtmax; } ; 




private:
  static TClonesArray *fgHits;
  UInt_t         fEventId;
  TClonesArray  *fHits;          //->array with all hits
  Int_t          fNHits;         //Number of hit for this event
  Float_t        fXExtrapol;
  Float_t        fYExtrapol;
  UInt_t         fTrkQuality;
  UInt_t         fDeltaTmax;
  UInt_t         fBcIdAbs;






   ClassDef(CaloEvent, 34)  //MTEvent structure

};

#endif

---