| The Gaudi Framework v32r1 (f65d50dc)

Generic1D.h
Go to the documentation of this file.
1 #ifndef GAUDISVC_GENERIC1D_H
2 #define GAUDISVC_GENERIC1D_H 1
3
4 #include "AIDA/IProfile1D.h"
5 #include "Annotation.h"
6 #include "Axis.h"
7 #include "GaudiKernel/HistogramBase.h"
8 #include "TFile.h"
9 #include <memory>
10 #include <stdexcept>
11
12 // Hide warning message:
13 // warning: 'XYZ' overrides a member function but is not marked 'override'
14 #ifdef __clang__
15 # pragma clang diagnostic push
16 # pragma clang diagnostic ignored "-Winconsistent-missing-override"
17 #elif defined( __GNUC__ ) && __GNUC__ >= 5
18 # pragma GCC diagnostic push
19 # pragma GCC diagnostic ignored "-Wsuggest-override"
20 #endif
21
22 namespace Gaudi {
23
34 template <class INTERFACE, class IMPLEMENTATION>
35 class GAUDI_API Generic1D : virtual public INTERFACE, virtual public HistogramBase {
36 public:
37 typedef Generic1D<INTERFACE, IMPLEMENTATION> Base;
39 Generic1D() = default;
40
41 protected:
43 Generic1D( IMPLEMENTATION* p ) : m_rep( p ) {}
44
45 public:
47 virtual const std::string& userLevelClassType() const { return m_classType; }
49 void* cast( const std::string& cl ) const override;
51 TObject* representation() const override { return m_rep.get(); }
53 void adoptRepresentation( TObject* rep ) override;
55 std::string title() const override { return m_annotation.value( "Title" ); }
57 bool setTitle( const std::string& title ) override;
59 std::string name() const { return m_annotation.value( "Name" ); }
61 bool setName( const std::string& newName );
63 AIDA::IAnnotation& annotation() override { return m_annotation; }
65 const AIDA::IAnnotation& annotation() const override { return m_annotation; }
67 Axis& axis() { return m_axis; }
69 const Axis& axis() const override { return m_axis; }
70
72 int entries() const override { return m_rep->GetEntries(); }
74 int allEntries() const override { return m_rep->GetEntries(); }
76 int extraEntries() const override;
78 int binEntries( int index ) const override;
79 // spread
80 virtual double binRms( int index ) const;
82 double sumBinHeights() const override { return m_rep->GetSumOfWeights(); }
84 double sumAllBinHeights() const override { return m_rep->GetSum(); }
86 double sumExtraBinHeights() const override { return sumAllBinHeights() - sumBinHeights(); }
88 double minBinHeight() const override { return m_rep->GetMinimum(); }
90 double maxBinHeight() const override { return m_rep->GetMaximum(); }
91
93 virtual double equivalentBinEntries() const;
96 virtual bool scale( double scaleFactor );
98 bool reset() override;
100 bool add( const INTERFACE& profile ) override;
102 virtual int rIndex( int index ) const { return m_axis.rIndex( index ); }
104 double binMean( int index ) const override;
106 double binHeight( int index ) const override;
108 double binError( int index ) const override;
110 double mean() const override { return m_rep->GetMean(); }
112 double rms() const override { return m_rep->GetRMS(); }
114 int coordToIndex( double coord ) const override { return axis().coordToIndex( coord ); }
116 int dimension() const override { return 1; }
118 std::ostream& print( std::ostream& s ) const override;
120 std::ostream& write( std::ostream& s ) const override;
122 int write( const char* file_name ) const override;
123
124 protected:
126 Axis m_axis;
128 mutable AIDA::Annotation m_annotation;
130 std::unique_ptr<IMPLEMENTATION> m_rep;
131 // class type
132 std::string m_classType;
133 // cache sumEntries (allEntries) when setting contents since Root can't compute by himself
134 int m_sumEntries;
135 }; // end class Generic1D
136
137 template <class INTERFACE, class IMPLEMENTATION>
138 bool Generic1D<INTERFACE, IMPLEMENTATION>::setTitle( const std::string& title ) {
139 m_rep->SetTitle( title.c_str() );
140 if ( !annotation().addItem( "Title", title ) ) m_annotation.setValue( "Title", title );
141 if ( !annotation().addItem( "title", title ) ) annotation().setValue( "title", title );
142 return true;
143 }
144
145 template <class INTERFACE, class IMPLEMENTATION>
146 bool Generic1D<INTERFACE, IMPLEMENTATION>::setName( const std::string& newName ) {
147 m_rep->SetName( newName.c_str() );
148 m_annotation.setValue( "Name", newName );
149 return true;
150 }
151
152 template <class INTERFACE, class IMPLEMENTATION>
153 double Generic1D<INTERFACE, IMPLEMENTATION>::binRms( int index ) const {
154 return m_rep->GetBinError( rIndex( index ) );
155 }
156
157 template <class INTERFACE, class IMPLEMENTATION>
158 double Generic1D<INTERFACE, IMPLEMENTATION>::binMean( int index ) const {
159 return m_rep->GetBinCenter( rIndex( index ) );
160 }
161
162 template <class INTERFACE, class IMPLEMENTATION>
163 double Generic1D<INTERFACE, IMPLEMENTATION>::binHeight( int index ) const {
164 return m_rep->GetBinContent( rIndex( index ) );
165 }
166
167 template <class INTERFACE, class IMPLEMENTATION>
168 double Generic1D<INTERFACE, IMPLEMENTATION>::binError( int index ) const {
169 return m_rep->GetBinError( rIndex( index ) );
170 }
171
172 template <class INTERFACE, class IMPLEMENTATION>
173 int Generic1D<INTERFACE, IMPLEMENTATION>::extraEntries() const {
174 return binEntries( AIDA::IAxis::UNDERFLOW_BIN ) + binEntries( AIDA::IAxis::OVERFLOW_BIN );
175 }
176 template <class INTERFACE, class IMPLEMENTATION>
177 bool Generic1D<INTERFACE, IMPLEMENTATION>::reset() {
178 m_sumEntries = 0;
179 m_rep->Reset();
180 return true;
181 }
182
183 template <class INTERFACE, class IMPLEMENTATION>
184 double Generic1D<INTERFACE, IMPLEMENTATION>::equivalentBinEntries() const {
185 if ( sumBinHeights() <= 0 ) return 0;
186 Stat_t stats[11]; // cover up to 3D...
187 m_rep->GetStats( stats );
188 return stats[0] * stats[0] / stats[1];
189 }
190
191 template <class INTERFACE, class IMPLEMENTATION>
192 bool Generic1D<INTERFACE, IMPLEMENTATION>::scale( double scaleFactor ) {
193 m_rep->Scale( scaleFactor );
194 return true;
195 }
196
197 template <class INTERFACE, class IMPLEMENTATION>
198 bool Generic1D<INTERFACE, IMPLEMENTATION>::add( const INTERFACE& h ) {
199 const Generic1D<INTERFACE, IMPLEMENTATION>* p = dynamic_cast<const Generic1D<INTERFACE, IMPLEMENTATION>*>( &h );
200 if ( p ) {
201 m_rep->Add( p->m_rep.get() );
202 return true;
203 }
204 throw std::runtime_error( "Cannot add profile histograms of different implementations." );
205 }
206
207 template <class INTERFACE, class IMPLEMENTATION>
208 std::ostream& Generic1D<INTERFACE, IMPLEMENTATION>::print( std::ostream& s ) const {
210 m_rep->Print( "all" );
211 return s;
212 }
213
215 template <class INTERFACE, class IMPLEMENTATION>
216 std::ostream& Generic1D<INTERFACE, IMPLEMENTATION>::write( std::ostream& s ) const {
217 s << "\n1D Histogram Table: " << std::endl;
218 s << "Bin, Height, Error " << std::endl;
219 for ( int i = 0; i < axis().bins(); ++i )
220 s << binMean( i ) << ", " << binHeight( i ) << ", " << binError( i ) << std::endl;
221 s << std::endl;
222 return s;
223 }
224
226 template <class INTERFACE, class IMPLEMENTATION>
227 int Generic1D<INTERFACE, IMPLEMENTATION>::write( const char* file_name ) const {
228 TFile* f = TFile::Open( file_name, "RECREATE" );
229 Int_t nbytes = m_rep->Write();
230 f->Close();
231 return nbytes;
232 }
233 } // namespace Gaudi
234
235 #ifdef __clang__
236 # pragma clang diagnostic pop
237 #elif defined( __GNUC__ ) && __GNUC__ >= 5
238 # pragma GCC diagnostic pop
239 #endif
240
241 #endif // AIDAROOT_GENERIC1D_H
Gaudi::Generic1D::maxBinHeight
double maxBinHeight() const override
Get the maximum height of the in-range bins.
Definition: Generic1D.h:90
Gaudi::Generic1D::rms
double rms() const override
The RMS of the whole IHistogram1D.
Definition: Generic1D.h:112
Gaudi::Generic1D::sumAllBinHeights
double sumAllBinHeights() const override
Get the sum of all the bins heights (including underflow and overflow bin).
Definition: Generic1D.h:84
Gaudi::Generic1D::binRms
virtual double binRms(int index) const
Definition: Generic1D.h:153
Gaudi::Generic1D::reset
bool reset() override
Reset the Histogram; as if just created.
Definition: Generic1D.h:177
Gaudi::Generic1D::print
std::ostream & print(std::ostream &s) const override
Print (ASCII) the histogram into the output stream.
Definition: Generic1D.h:208
Gaudi::Generic1D::m_classType
std::string m_classType
Definition: Generic1D.h:132
std::endl
T endl(T... args)
Gaudi::Generic1D::userLevelClassType
virtual const std::string & userLevelClassType() const
The AIDA user-level unterface leaf class type.
Definition: Generic1D.h:47
Gaudi::Generic1D::binMean
double binMean(int index) const override
The weighted mean of a bin.
Definition: Generic1D.h:158
std::string
STL class.
Gaudi::Generic1D::binError
double binError(int index) const override
The error of a given bin.
Definition: Generic1D.h:168
Gaudi::Generic1D::allEntries
int allEntries() const override
Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.
Definition: Generic1D.h:74
Gaudi::Generic1D::axis
Axis & axis()
Access to axis object.
Definition: Generic1D.h:67
GaudiPython.Persistency.add
def add(instance)
Definition: Persistency.py:39
Gaudi::Generic1D::m_rep
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic1D.h:130
Gaudi::Generic1D::sumBinHeights
double sumBinHeights() const override
Get the sum of in range bin heights in the IProfile.
Definition: Generic1D.h:82
Gaudi::Generic1D::coordToIndex
int coordToIndex(double coord) const override
Get the bin number corresponding to a given coordinate along the x axis.
Definition: Generic1D.h:114
Gaudi::Generic1D::m_annotation
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic1D.h:128
Gaudi::Generic1D::mean
double mean() const override
The mean of the whole IHistogram1D.
Definition: Generic1D.h:110
HistogramBase.h
Axis.h
Gaudi::Generic1D::add
bool add(const INTERFACE &profile) override
Modifies this IProfile1D by adding the contents of profile to it.
Definition: Generic1D.h:198
Gaudi::Generic1D::setTitle
bool setTitle(const std::string &title) override
Set the title of the object.
Definition: Generic1D.h:138
Gaudi::Generic1D::sumExtraBinHeights
double sumExtraBinHeights() const override
Get the sum of the underflow and overflow bin height.
Definition: Generic1D.h:86
std::runtime_error
STL class.
Gaudi::Generic1D::Generic1D
Generic1D(IMPLEMENTATION *p)
constructor
Definition: Generic1D.h:43
AIDA::Annotation
Implementation of the AIDA IAnnotation interface class.
Definition: Annotation.h:16
Gaudi::Generic1D::m_axis
Axis m_axis
Axis member.
Definition: Generic1D.h:126
Gaudi::Generic1D::representation
TObject * representation() const override
ROOT object implementation.
Definition: Generic1D.h:51
Gaudi::Generic1D::m_sumEntries
int m_sumEntries
Definition: Generic1D.h:134
Gaudi::Generic1D::dimension
int dimension() const override
Get the Histogram's dimension.
Definition: Generic1D.h:116
std::unique_ptr::get
T get(T... args)
Gaudi::Generic1D::extraEntries
int extraEntries() const override
Get the number of entries in the underflow and overflow bins.
Definition: Generic1D.h:173
Gaudi::HistogramBase
Common base class for all histograms Use is solely functional to minimize dynamic_casts inside Histog...
Definition: HistogramBase.h:22
std::unique_ptr< IMPLEMENTATION >
Gaudi::Generic1D::rIndex
virtual int rIndex(int index) const
operator methods
Definition: Generic1D.h:102
std::string::c_str
T c_str(T... args)
Gaudi::Generic1D::axis
const Axis & axis() const override
Get the x axis of the IHistogram1D.
Definition: Generic1D.h:69
gaudirun.s
string s
Definition: gaudirun.py:316
Gaudi::Generic1D::annotation
const AIDA::IAnnotation & annotation() const override
Access annotation object (cons)
Definition: Generic1D.h:65
Gaudi::Generic1D::minBinHeight
double minBinHeight() const override
Get the minimum height of the in-range bins.
Definition: Generic1D.h:88
Gaudi::Generic1D::entries
int entries() const override
Get the number or all the entries.
Definition: Generic1D.h:72
Gaudi::Generic1D::binHeight
double binHeight(int index) const override
Total height of the corresponding bin (ie the sum of the weights in this bin).
Definition: Generic1D.h:163
Gaudi::Generic1D::write
std::ostream & write(std::ostream &s) const override
Write (ASCII) the histogram table into the output stream.
Definition: Generic1D.h:216
Gaudi::Generic1D::equivalentBinEntries
virtual double equivalentBinEntries() const
Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ]
Definition: Generic1D.h:184
Gaudi::Generic1D::annotation
AIDA::IAnnotation & annotation() override
Access annotation object.
Definition: Generic1D.h:63
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:71
Gaudi::Generic1D::name
std::string name() const
object name
Definition: Generic1D.h:59
std::ostream
STL class.
Gaudi::Generic1D::title
std::string title() const override
Get the title of the object.
Definition: Generic1D.h:55
Gaudi
Header file for std:chrono::duration-based Counters.
Definition: __init__.py:1
Gaudi::Axis
An IAxis represents a binned histogram axis.
Definition: Axis.h:29
Annotation.h
Gaudi::Generic1D::setName
bool setName(const std::string &newName)
Set the name of the object.
Definition: Generic1D.h:146
Gaudi::Generic1D::scale
virtual bool scale(double scaleFactor)
Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a g...
Definition: Generic1D.h:192
Gaudi::Generic1D::Base
Generic1D< INTERFACE, IMPLEMENTATION > Base
Definition: Generic1D.h:37
Gaudi::Generic1D
Common AIDA implementation stuff for histograms and profiles using ROOT implementations.
Definition: Generic1D.h:35