The Gaudi Framework
v30r3 (a5ef0a68)
|
Common AIDA implementation stuff for histograms and profiles using ROOT implementations. More...
#include <GaudiPI/Generic2D.h>
Public Types | |
typedef Generic2D< INTERFACE, IMPLEMENTATION > | Base |
Public Member Functions | |
Generic2D ()=default | |
TObject * | representation () const override |
ROOT object implementation. More... | |
void | adoptRepresentation (TObject *rep) override |
Adopt ROOT histogram representation. More... | |
std::string | title () const override |
Get the title of the object. More... | |
bool | setTitle (const std::string &title) override |
Set the title of the object. More... | |
std::string | name () const |
object name More... | |
bool | setName (const std::string &newName) |
Set the name of the object. More... | |
AIDA::IAnnotation & | annotation () override |
Access annotation object. More... | |
const AIDA::IAnnotation & | annotation () const override |
Access annotation object (cons) More... | |
const AIDA::IAxis & | xAxis () const override |
Return the X axis. More... | |
const AIDA::IAxis & | yAxis () const override |
Return the Y axis. More... | |
virtual int | rIndexX (int index) const |
operator methods More... | |
virtual int | rIndexY (int index) const |
operator methods More... | |
int | entries () const override |
Get the number or all the entries. More... | |
int | allEntries () const override |
Get the number or all the entries, both in range and underflow/overflow bins of the IProfile. More... | |
int | extraEntries () const override |
Get the number of entries in the underflow and overflow bins. More... | |
double | sumBinHeights () const override |
Get the sum of in range bin heights in the IProfile. More... | |
double | sumAllBinHeights () const override |
Get the sum of all the bins heights (including underflow and overflow bin). More... | |
double | sumExtraBinHeights () const override |
Get the sum of the underflow and overflow bin height. More... | |
double | minBinHeight () const override |
Get the minimum height of the in-range bins. More... | |
double | maxBinHeight () const override |
Get the maximum height of the in-range bins. More... | |
double | binMeanX (int indexX, int indexY) const override |
The weighted mean along x of a given bin. More... | |
double | binMeanY (int indexX, int indexY) const override |
The weighted mean along y of a given bin. More... | |
int | binEntries (int indexX, int indexY) const override |
The number of entries (ie the number of times fill was called for this bin). More... | |
int | binEntriesX (int indexX) const override |
Equivalent to projectionX().binEntries(indexX) . More... | |
int | binEntriesY (int indexY) const override |
Equivalent to projectionY().binEntries(indexY) . More... | |
double | binHeight (int indexX, int indexY) const override |
Total height of the corresponding bin (ie the sum of the weights in this bin). More... | |
double | binHeightX (int indexX) const override |
Equivalent to projectionX().binHeight(indexX) . More... | |
double | binHeightY (int indexY) const override |
Equivalent to projectionY().binHeight(indexY) . More... | |
double | binError (int indexX, int indexY) const override |
The error on this bin. More... | |
virtual double | binRms (int indexX, int indexY) const |
The spread (RMS) of this bin. More... | |
double | meanX () const override |
Returns the mean of the profile, as calculated on filling-time projected on the X axis. More... | |
double | meanY () const override |
Returns the mean of the profile, as calculated on filling-time projected on the Y axis. More... | |
double | rmsX () const override |
Returns the rms of the profile as calculated on filling-time projected on the X axis. More... | |
double | rmsY () const override |
Returns the rms of the profile as calculated on filling-time projected on the Y axis. More... | |
int | coordToIndexX (double coordX) const override |
Convenience method, equivalent to xAxis().coordToIndex(coord) . More... | |
int | coordToIndexY (double coordY) const override |
Convenience method, equivalent to yAxis().coordToIndex(coord) . More... | |
virtual double | equivalentBinEntries () const |
Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ] More... | |
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 given scale factor. More... | |
bool | add (const INTERFACE &h) override |
Modifies this profile by adding the contents of profile to it. More... | |
bool | reset () override |
void * | cast (const std::string &className) const override |
Introspection method. More... | |
const std::string & | userLevelClassType () const |
The AIDA user-level unterface leaf class type. More... | |
int | dimension () const override |
Get the Histogram's dimension. More... | |
std::ostream & | print (std::ostream &s) const override |
Print (ASCII) the histogram into the output stream. More... | |
std::ostream & | write (std::ostream &s) const override |
Write (ASCII) the histogram table into the output stream. More... | |
int | write (const char *file_name) const override |
Write (ASCII) the histogram table into a file. More... | |
template<> | |
void * | cast (const std::string &className) const |
template<> | |
int | binEntries (int indexX, int indexY) const |
template<> | |
void | adoptRepresentation (TObject *rep) |
Adopt ROOT histogram representation. More... | |
template<> | |
void * | cast (const std::string &className) const |
template<> | |
int | binEntries (int idX, int idY) const |
template<> | |
void | adoptRepresentation (TObject *rep) |
Adopt ROOT histogram representation. More... | |
Public Member Functions inherited from Gaudi::HistogramBase | |
virtual | ~HistogramBase ()=default |
Protected Member Functions | |
Generic2D (IMPLEMENTATION *p) | |
constructor More... | |
Protected Attributes | |
Axis | m_xAxis |
X axis member. More... | |
Axis | m_yAxis |
Y axis member. More... | |
AIDA::Annotation | m_annotation |
Object annotations. More... | |
std::unique_ptr< IMPLEMENTATION > | m_rep |
Reference to underlying implementation. More... | |
std::string | m_classType |
class type More... | |
int | m_sumEntries = 0 |
cache sumEntries (allEntries) when setting contents since Root can't compute by himself More... | |
Common AIDA implementation stuff for histograms and profiles using ROOT implementations.
Credits: This code is the result of some stripdown implementation of LCG/PI. Credits to them!
Definition at line 36 of file Generic2D.h.
typedef Generic2D<INTERFACE, IMPLEMENTATION> Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::Base |
Definition at line 39 of file Generic2D.h.
|
default |
|
inlineprotected |
constructor
Definition at line 45 of file Generic2D.h.
|
override |
Modifies this profile by adding the contents of profile to it.
Definition at line 314 of file Generic2D.h.
|
virtual |
Adopt ROOT histogram representation.
Implements Gaudi::HistogramBase.
Definition at line 42 of file P2D.cpp.
|
overridevirtual |
Adopt ROOT histogram representation.
Implements Gaudi::HistogramBase.
|
virtual |
Adopt ROOT histogram representation.
Implements Gaudi::HistogramBase.
Definition at line 127 of file H2D.cpp.
|
override |
Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.
Definition at line 184 of file Generic2D.h.
|
inlineoverride |
Access annotation object.
Definition at line 61 of file Generic2D.h.
|
inlineoverride |
Access annotation object (cons)
Definition at line 63 of file Generic2D.h.
int Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::binEntries | ( | int | idX, |
int | idY | ||
) | const |
Definition at line 35 of file P2D.cpp.
|
override |
The number of entries (ie the number of times fill was called for this bin).
int Gaudi::Generic2D< IHistogram2D, TH2D >::binEntries | ( | int | indexX, |
int | indexY | ||
) | const |
Definition at line 119 of file H2D.cpp.
|
override |
Equivalent to projectionX().binEntries(indexX)
.
Definition at line 232 of file Generic2D.h.
|
override |
Equivalent to projectionY().binEntries(indexY)
.
Definition at line 240 of file Generic2D.h.
|
override |
The error on this bin.
Definition at line 272 of file Generic2D.h.
|
override |
Total height of the corresponding bin (ie the sum of the weights in this bin).
Definition at line 248 of file Generic2D.h.
|
override |
Equivalent to projectionX().binHeight(indexX)
.
Definition at line 254 of file Generic2D.h.
|
override |
Equivalent to projectionY().binHeight(indexY)
.
Definition at line 264 of file Generic2D.h.
|
override |
The weighted mean along x of a given bin.
Definition at line 220 of file Generic2D.h.
|
override |
The weighted mean along y of a given bin.
Definition at line 226 of file Generic2D.h.
|
virtual |
The spread (RMS) of this bin.
Definition at line 214 of file Generic2D.h.
void * Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::cast | ( | const std::string & | className | ) | const |
void * Gaudi::Generic2D< IHistogram2D, TH2D >::cast | ( | const std::string & | className | ) | const |
|
override |
Introspection method.
|
override |
Convenience method, equivalent to xAxis().coordToIndex(coord)
.
Definition at line 302 of file Generic2D.h.
|
override |
Convenience method, equivalent to yAxis().coordToIndex(coord)
.
Definition at line 308 of file Generic2D.h.
|
inlineoverride |
|
override |
Get the number or all the entries.
Definition at line 178 of file Generic2D.h.
|
virtual |
Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ]
Definition at line 332 of file Generic2D.h.
|
override |
Get the number of entries in the underflow and overflow bins.
Definition at line 323 of file Generic2D.h.
|
override |
Get the maximum height of the in-range bins.
Definition at line 196 of file Generic2D.h.
|
override |
Returns the mean of the profile, as calculated on filling-time projected on the X axis.
Definition at line 278 of file Generic2D.h.
|
override |
Returns the mean of the profile, as calculated on filling-time projected on the Y axis.
Definition at line 284 of file Generic2D.h.
|
override |
Get the minimum height of the in-range bins.
Definition at line 190 of file Generic2D.h.
|
inline |
object name
Definition at line 57 of file Generic2D.h.
|
overridevirtual |
Print (ASCII) the histogram into the output stream.
bin contents and errors are printed for all bins including under and overflows
Implements Gaudi::HistogramBase.
Definition at line 356 of file Generic2D.h.
|
inlineoverridevirtual |
ROOT object implementation.
Implements Gaudi::HistogramBase.
Definition at line 49 of file Generic2D.h.
|
override |
Definition at line 348 of file Generic2D.h.
|
inlinevirtual |
operator methods
Definition at line 70 of file Generic2D.h.
|
inlinevirtual |
operator methods
Definition at line 72 of file Generic2D.h.
|
override |
Returns the rms of the profile as calculated on filling-time projected on the X axis.
Definition at line 290 of file Generic2D.h.
|
override |
Returns the rms of the profile as calculated on filling-time projected on the Y axis.
Definition at line 296 of file Generic2D.h.
|
virtual |
Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.
Definition at line 341 of file Generic2D.h.
bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::setName | ( | const std::string & | newName | ) |
Set the name of the object.
Definition at line 170 of file Generic2D.h.
|
override |
Set the title of the object.
Definition at line 161 of file Generic2D.h.
|
override |
Get the sum of all the bins heights (including underflow and overflow bin).
Definition at line 208 of file Generic2D.h.
|
override |
Get the sum of in range bin heights in the IProfile.
Definition at line 202 of file Generic2D.h.
|
inlineoverride |
Get the sum of the underflow and overflow bin height.
Definition at line 85 of file Generic2D.h.
|
inlineoverride |
Get the title of the object.
Definition at line 53 of file Generic2D.h.
|
inline |
|
overridevirtual |
Write (ASCII) the histogram table into the output stream.
Implements Gaudi::HistogramBase.
Definition at line 365 of file Generic2D.h.
|
overridevirtual |
Write (ASCII) the histogram table into a file.
Implements Gaudi::HistogramBase.
Definition at line 381 of file Generic2D.h.
|
inlineoverride |
|
inlineoverride |
|
mutableprotected |
Object annotations.
Definition at line 151 of file Generic2D.h.
|
protected |
class type
Definition at line 155 of file Generic2D.h.
|
protected |
Reference to underlying implementation.
Definition at line 153 of file Generic2D.h.
|
protected |
cache sumEntries (allEntries) when setting contents since Root can't compute by himself
Definition at line 157 of file Generic2D.h.
|
protected |
X axis member.
Definition at line 147 of file Generic2D.h.
|
protected |
Y axis member.
Definition at line 149 of file Generic2D.h.