Statistical variable, defined by its mean and variance (RMS).
Named, streamable, storable and mergeable.
Definition at line 33 of file TStatistic.h.
Public Member Functions | |
TStatistic (const char *name, Int_t n, const Double_t *val, const Double_t *w=nullptr) | |
Constructor from a vector of values. More... | |
TStatistic (const char *name="") | |
~TStatistic () | |
TStatistic destructor. More... | |
void | Fill (Double_t val, Double_t w=1.) |
Increment the entries in the object by one value-weight pair. More... | |
Double_t | GetM2 () const |
Double_t | GetMax () const |
Double_t | GetMean () const |
Double_t | GetMeanErr () const |
Double_t | GetMin () const |
Long64_t | GetN () const |
const char * | GetName () const |
Returns name of object. More... | |
Long64_t | GetNeff () const |
Double_t | GetRMS () const |
Double_t | GetVar () const |
Double_t | GetW () const |
Double_t | GetW2 () const |
ULong_t | Hash () const |
Return hash value for this object. More... | |
void | ls (Option_t *opt="") const |
The ls function lists the contents of a class on stdout. More... | |
Int_t | Merge (TCollection *in) |
Merge implementation of TStatistic. More... | |
void | Print (Option_t *="") const |
Print the content of the object. More... | |
![]() | |
TObject () | |
TObject constructor. More... | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
virtual | ~TObject () |
TObject destructor. More... | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. More... | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. More... | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. More... | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. More... | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. More... | |
virtual void | Copy (TObject &object) const |
Copy this to obj. More... | |
virtual void | Delete (Option_t *option="") |
Delete this object. More... | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. More... | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. More... | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. More... | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad) . More... | |
virtual void | Dump () const |
Dump contents of object on stdout. More... | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. More... | |
virtual void | Execute (const char *method, const char *params, Int_t *error=0) |
Execute method on this object with the given parameter string, e.g. More... | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
Execute method on this object with parameters stored in the TObjArray. More... | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). More... | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. More... | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. More... | |
virtual const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () const |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. More... | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. More... | |
virtual ULong_t | Hash () const |
Return hash value for this object. More... | |
Bool_t | HasInconsistentHash () const |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More... | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. More... | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". More... | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. More... | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. More... | |
void | InvertBit (UInt_t f) |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). More... | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
virtual Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. More... | |
void | MayNotUse (const char *method) const |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. More... | |
virtual void | Paint (Option_t *option="") |
This method must be overridden if a class wants to paint itself. More... | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. More... | |
virtual void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. More... | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. More... | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. More... | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. More... | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". More... | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. More... | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. More... | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. More... | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. More... | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
virtual void | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More... | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. More... | |
Private Attributes | |
Double_t | fM |
Sum of elements (i.e. sum of (val * weight) pairs. More... | |
Double_t | fM2 |
Second order momentum. More... | |
Double_t | fMax |
Maximum value in the TStatistic object. More... | |
Double_t | fMin |
Minimum value in the TStatistic object. More... | |
Long64_t | fN |
Number of fills. More... | |
TString | fName |
Name given to the TStatistic object. More... | |
Double_t | fW |
Sum of weights. More... | |
Double_t | fW2 |
Sum of squared weights. More... | |
Additional Inherited Members | |
![]() | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
![]() | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
![]() | |
enum | { kOnlyPrepStep = BIT(3) } |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
void | MakeZombie () |
#include <TStatistic.h>
|
inline |
Definition at line 47 of file TStatistic.h.
TStatistic::TStatistic | ( | const char * | name, |
Int_t | n, | ||
const Double_t * | val, | ||
const Double_t * | w = nullptr |
||
) |
Constructor from a vector of values.
[in] | name | The name given to the object |
[in] | n | The total number of entries |
[in] | val | The vector of values |
[in] | w | The vector of weights for the values |
Recursively calls the TStatistic::Fill() function to fill the object.
Definition at line 34 of file TStatistic.cxx.
TStatistic::~TStatistic | ( | ) |
TStatistic destructor.
Definition at line 50 of file TStatistic.cxx.
Increment the entries in the object by one value-weight pair.
[in] | val | Value to fill the Tstatistic with |
[in] | w | The weight of the value |
Also updates statistics in the object. For number of entries, sum of weights, sum of squared weights and sum of (value*weight), one extra value is added to the statistic. For the sum of squared (value*weight) pairs, the function uses formula 1.4 in Chan-Golub, LeVeque : Algorithms for computing the Sample Variance (1983), genralized by LM for the case of weights:
\[ \frac{w_j}{\sum_{i=0}^{j} w_i \cdot \sum_{i=0}^{j-1} w_i} \cdot \left( \sum_{i=0}^{j} w_i \cdot val_i - \sum_{i=0}^{j} \left(w_i \cdot val_i\right) \right) \]
The minimum(maximum) is computed by checking that the fill value is either less(greater) than the current minimum(maximum)
Definition at line 76 of file TStatistic.cxx.
|
inline |
Definition at line 57 of file TStatistic.h.
|
inline |
Definition at line 65 of file TStatistic.h.
|
inline |
Definition at line 58 of file TStatistic.h.
|
inline |
Definition at line 59 of file TStatistic.h.
|
inline |
Definition at line 64 of file TStatistic.h.
|
inline |
Definition at line 55 of file TStatistic.h.
|
inlinevirtual |
Returns name of object.
This default method returns the class name. Classes that give objects a name should override this method.
Reimplemented from TObject.
Definition at line 52 of file TStatistic.h.
|
inline |
Definition at line 56 of file TStatistic.h.
|
inline |
Definition at line 60 of file TStatistic.h.
|
inline |
Definition at line 61 of file TStatistic.h.
|
inline |
Definition at line 62 of file TStatistic.h.
|
inline |
Definition at line 63 of file TStatistic.h.
|
inlinevirtual |
Return hash value for this object.
Note: If this routine is overloaded in a derived class, this derived class should also add
Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like
Reimplemented from TObject.
Definition at line 53 of file TStatistic.h.
The ls function lists the contents of a class on stdout.
Ls output is typically much less verbose then Dump().
Reimplemented from TObject.
Definition at line 75 of file TStatistic.h.
Int_t TStatistic::Merge | ( | TCollection * | in | ) |
Merge implementation of TStatistic.
[in] | in | Other TStatistic objects to be added to the current one |
The function merges the statistics of all objects together to form a new one. Merging quantities is done via simple addition for the following class data members:
The sum of squared (value*weight) pairs fM2 is updated using the same formula as in TStatistic::Fill() function.
The minimum(maximum) is updated by checking that the minimum(maximum) of the next TStatistic object in the queue is either less(greater) than the current minimum(maximum).
Definition at line 135 of file TStatistic.cxx.
Print the content of the object.
Prints the statistics held by the object in one line. These include the mean, mean error, RMS, the total number of values, the minimum and the maximum.
Reimplemented from TObject.
Definition at line 113 of file TStatistic.cxx.
|
private |
Sum of elements (i.e. sum of (val * weight) pairs.
Definition at line 40 of file TStatistic.h.
|
private |
Second order momentum.
Definition at line 41 of file TStatistic.h.
|
private |
Maximum value in the TStatistic object.
Definition at line 43 of file TStatistic.h.
|
private |
Minimum value in the TStatistic object.
Definition at line 42 of file TStatistic.h.
|
private |
Number of fills.
Definition at line 37 of file TStatistic.h.
|
private |
Name given to the TStatistic object.
Definition at line 36 of file TStatistic.h.
|
private |
Sum of weights.
Definition at line 38 of file TStatistic.h.
|
private |
Sum of squared weights.
Definition at line 39 of file TStatistic.h.