Analysis  version 7.0 - august 2014
SpecHSum.hh
Go to the documentation of this file.
1 //======================================================================
2 /*! \file SpecHSum.hh
3  *
4  * Include file for class SpecHSum.
5  */
6 //======================================================================
7 
8 #ifndef SPEC_HSUM_HH
9 #define SPEC_HSUM_HH
10 
11 #include "Spec3Dim.hh"
12 
13 
14 //======================================================================
15 /*! \class SpecHSum
16  *
17  * The class is used to sum another spectrum or histogram, event by event.
18  */
19 class SpecHSum : public Spec3Dim
20 {
21 //----------------------------------------------------------------------
22  /*! \object_doc */
23  GObject(SpecHSum);
24 //----------------------------------------------------------------------
25 
26  protected:
27  const TH1 * histo_src; ///< Pointer to the histogram to cumulate
28  u_int dim; ///< Dimension de l'histogramme
29 
30  public:
31 
32 //----------------------------------------------------------------------
33 // CONSTRUCTEUR / AFFECTATION / DESTRUCTEUR
34 //----------------------------------------------------------------------
35 
36  // Constructor
37  SpecHSum ( const string & spec_name, Spectrum * spec );
38  SpecHSum ( const string & spec_name, const TH1 * hptr );
39 
40  // Copy constructor
41  SpecHSum ( const SpecHSum & original );
42 
43  // Destructorr
44  virtual ~SpecHSum ();
45 
46 //----------------------------------------------------------------------
47 
48  protected:
49  virtual TH1 * SetHistoSum ( const TH1 * hptr = NULL );
50  // incrémentation auto du spectre
51  virtual void IncrementSpectrum ( );
52 
53  public:
54 
55  const TH1 * GetRefHisto ( ) const; // inline
56 
57  // Retourne l'identificateur du type de spectre.
58  u_int TypeId ( ) const;
59 
60  // Retourne le nom du type de spectre.
61  string Type ( ) const;
62 
63  // retourne la dimension du spectre.
64  virtual u_int Dimension ( ) const;
65 
66  // Retourne une chaîne décrivant le spectre.
67  virtual string Definition ( ) const;
68 
69  // Ecriture des données du spectre dans une chaîne de définition.
70  virtual string DefinitionString ( ) const;
71 
72  // Définition d'un spectre de type donné static Spectrum * NewSpectrumDef ( const string & name, const string & defstr, const EventManager * evt_mgr, int & error ); //---------------------------------------------------------------------- // pour ROOT... public: /*! Définition à usage de ROOT... */ ClassDef(SpecHSum,0); } ; //====================================================================== // METHODES INLINE //====================================================================== /*! Retourne l'identificateur du type de spectre. */ inline u_int SpecHSum::TypeId ( ) const { return (spectrumTypeHSum); } /*! Retourne le nom du type de spectre. */ inline string SpecHSum::Type ( ) const { return (SPECTRUM_TYPE_TXT_HSUM); } /*! Fonction qui retourne la dimension du spectre.*/ inline u_int SpecHSum::Dimension ( ) const { return (dim); } /*! Returns the pointer to the reference histogram for the spectrum.*/ inline const TH1 * SpecHSum::GetRefHisto ( ) const { return ( histo_src ); } //====================================================================== #endif
73  static Spectrum * NewSpectrumDef ( const string & name,
74  const string & defstr,
75  const EventManager * evt_mgr,
76  int & error );
77 
78 //----------------------------------------------------------------------
79 // pour ROOT...
80  public:
81  /*! Définition à usage de ROOT... */
82  ClassDef(SpecHSum,0);
83 } ;
84 
85 
86 //======================================================================
87 // METHODES INLINE
88 //======================================================================
89 
90 /*! Retourne l'identificateur du type de spectre.
91  */
92 inline u_int SpecHSum::TypeId ( ) const
93  { return (spectrumTypeHSum); }
94 
95 /*! Retourne le nom du type de spectre.
96  */
97 inline string SpecHSum::Type ( ) const
98  { return (SPECTRUM_TYPE_TXT_HSUM); }
99 
100 /*! Fonction qui retourne la dimension du spectre.*/
101 inline u_int SpecHSum::Dimension ( ) const
102  { return (dim); }
103 
104 /*! Returns the pointer to the reference histogram for the spectrum.*/
105 inline const TH1 * SpecHSum::GetRefHisto ( ) const
106  { return ( histo_src ); }
107 
108 
109 //======================================================================
110 #endif
SpecHSum
Definition: SpecHSum.hh:19
Spec3Dim
Definition: Spec3Dim.hh:23
SpecHSum::Dimension
virtual u_int Dimension() const
Definition: SpecHSum.hh:101
SpecHSum::~SpecHSum
virtual ~SpecHSum()
Definition: SpecHSum.cpp:56
SPECTRUM_TYPE_TXT_HSUM
#define SPECTRUM_TYPE_TXT_HSUM
Nom du type de spectre: event by event summed histogram.
Definition: Spectrum.hh:117
Spectrum
Definition: Spectrum.hh:222
SpecHSum::dim
u_int dim
Dimension de l&#39;histogramme.
Definition: SpecHSum.hh:28
SpecHSum::SpecHSum
SpecHSum(const string &spec_name, Spectrum *spec)
Definition: SpecHSum.cpp:20
SpecHSum::TypeId
u_int TypeId() const
Definition: SpecHSum.hh:92
SpecHSum::Type
string Type() const
Definition: SpecHSum.hh:97
SpecHSum::NewSpectrumDef
static Spectrum * NewSpectrumDef(const string &name, const string &defstr, const EventManager *evt_mgr, int &error)
Definition: SpecHSum.cpp:176
SpecHSum::DefinitionString
virtual string DefinitionString() const
Definition: SpecHSum.cpp:155
SpecHSum::GetRefHisto
const TH1 * GetRefHisto() const
Definition: SpecHSum.hh:105
SpecHSum::histo_src
const TH1 * histo_src
Pointer to the histogram to cumulate.
Definition: SpecHSum.hh:27
SpecHSum::SetHistoSum
virtual TH1 * SetHistoSum(const TH1 *hptr=NULL)
Definition: SpecHSum.cpp:68
SpecHSum::Definition
virtual string Definition() const
Definition: SpecHSum.cpp:139
SpecHSum::IncrementSpectrum
virtual void IncrementSpectrum()
Definition: SpecHSum.cpp:125
SpecHSum::GObject
GObject(SpecHSum)
EventManager
Definition: EventManager.hh:59
SpecHSum::ClassDef
ClassDef(SpecHSum, 0)