The Histogram stack class.
A THStack is a collection of TH1 or TH2 histograms. By using THStack::Draw(), the entire histogram collection is drawn at once according to the specified drawing option.
THStack::Add() allows adding a new histogram to the list. Note that the THStack does not take ownership of the objects in the list.
By default, histograms are shown stacked:
The axis ranges are computed automatically along the X and Y axes to display the complete histogram collection.
Warning: Histogram bins with negative content may produce wrong plots.
The specific stack's drawing options are:
See the THistPainter class for the list of valid histograms' painting options.
Example;
A more complex example:
Note that picking is supported for all drawing modes.
Automatic coloring according to the current palette is available as shown in the following example:
Public Member Functions | |
THStack () | |
THStack (const char *name, const char *title) | |
constructor with name and title | |
THStack (const THStack &hstack) | |
THStack copy constructor. | |
THStack (TH1 *hist, Option_t *axis="x", const char *name=nullptr, const char *title=nullptr, Int_t firstbin=1, Int_t lastbin=-1, Int_t firstbin2=1, Int_t lastbin2=-1, Option_t *proj_option="", Option_t *draw_option="") | |
Creates a new THStack from a TH2 or TH3. | |
~THStack () override | |
THStack destructor. | |
virtual void | Add (TH1 *h, Option_t *option="") |
Add a new histogram to the list. | |
TIter | begin () const |
Get an iterator over internal hists list. | |
void | Browse (TBrowser *b) override |
Browse. | |
void | BuildPrimitives (Option_t *chopt="") |
Int_t | DistancetoPrimitive (Int_t px, Int_t py) override |
Compute distance from point px, py to each graph. | |
void | Draw (Option_t *chopt="") override |
Draw this stack with its current attributes. | |
TIter | end () const |
TH1 * | GetHistogram () const |
Returns a pointer to the histogram used to draw the axis. | |
TList * | GetHists () const |
virtual Double_t | GetMaximum (Option_t *option="", Double_t maxval=std::numeric_limits< Double_t >::max()) |
Returns the maximum of all added histograms smaller than maxval. | |
virtual Double_t | GetMinimum (Option_t *option="", Double_t minval=-std::numeric_limits< Double_t >::max()) |
Returns the minimum of all added histograms larger than minval. | |
Int_t | GetNhists () const |
Return the number of histograms in the stack. | |
TObjArray * | GetStack () |
Return pointer to Stack. Build it if not yet done. | |
TAxis * | GetXaxis () const |
Get the x-axis of the histogram used to draw the stack. | |
TAxis * | GetYaxis () const |
Get the y-axis of the histogram used to draw the stack. | |
TAxis * | GetZaxis () const |
Get the z-axis of the histogram used to draw the stack. | |
TClass * | IsA () const override |
void | ls (Option_t *option="") const override |
List histograms in the stack. | |
virtual Long64_t | Merge (TCollection *li, TFileMergeInfo *info) |
Merge the THStack in the TList into this stack. | |
virtual void | Modified () |
Note: this method invalidates the sum of histograms. | |
void | Paint (Option_t *chopt="") override |
Paint the list of histograms. | |
void | Print (Option_t *chopt="") const override |
Print the list of histograms. | |
void | RecursiveRemove (TObject *obj) override |
Recursively remove the object obj from the list of histograms. | |
void | SavePrimitive (std::ostream &out, Option_t *option="") override |
Save primitive as a C++ statement(s) on output stream out. | |
virtual void | SetHistogram (TH1 *h) |
virtual void | SetMaximum (Double_t maximum=-1111) |
Set maximum. | |
virtual void | SetMinimum (Double_t minimum=-1111) |
Set minimum. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. | |
void | Clear (Option_t *option="") override |
Set name and title to empty strings (""). | |
TObject * | Clone (const char *newname="") const override |
Make a clone of an object using the Streamer facility. | |
Int_t | Compare (const TObject *obj) const override |
Compare two TNamed objects. | |
void | Copy (TObject &named) const override |
Copy this to obj. | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. | |
const char * | GetName () const override |
Returns name of object. | |
const char * | GetTitle () const override |
Returns title of object. | |
ULong_t | Hash () const override |
Return hash value for this object. | |
TClass * | IsA () const override |
Bool_t | IsSortable () const override |
void | ls (Option_t *option="") const override |
List TNamed name and title. | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
void | Print (Option_t *option="") const override |
Print TNamed name and title. | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
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. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual void | Delete (Option_t *option="") |
Delete this object. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1) . | |
virtual void | Dump () const |
Dump contents of object on stdout. | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. | |
virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
Execute method on this object with parameters stored in the TObjArray. | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). | |
virtual Option_t * | GetOption () const |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
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. | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. | |
void | InvertBit (UInt_t f) |
Bool_t | IsDestructed () const |
IsDestructed. | |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
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). | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification (the base implementation is no-op). | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
void | operator delete (void *ptr) |
Operator delete. | |
void | operator delete (void *ptr, void *vp) |
Only called by placement new when throwing an exception. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void | operator delete[] (void *ptr, void *vp) |
Only called by placement new[] when throwing an exception. | |
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. | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
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. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TNamed | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Longptr_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
Protected Member Functions | |
void | BuildAndPaint (Option_t *chopt, Bool_t paint) |
Create all additional objects and stack (if specified). | |
void | BuildStack () |
Build the sum of all histograms. | |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). | |
void | MakeZombie () |
Protected Attributes | |
TH1 * | fHistogram {nullptr} |
Pointer to histogram used for drawing axis. | |
TList * | fHists {nullptr} |
Pointer to array of TH1. | |
Double_t | fMaximum {-1111} |
Maximum value for plotting along y. | |
Double_t | fMinimum {-1111} |
Minimum value for plotting along y. | |
TObjArray * | fStack {nullptr} |
! Pointer to array of sums of TH1 | |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Private Member Functions | |
THStack & | operator= (const THStack &)=delete |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
#include <THStack.h>
THStack::THStack | ( | const char * | name, |
const char * | title | ||
) |
constructor with name and title
Definition at line 135 of file THStack.cxx.
THStack::THStack | ( | TH1 * | hist, |
Option_t * | axis = "x" , |
||
const char * | name = nullptr , |
||
const char * | title = nullptr , |
||
Int_t | firstbin = 1 , |
||
Int_t | lastbin = -1 , |
||
Int_t | firstbin2 = 1 , |
||
Int_t | lastbin2 = -1 , |
||
Option_t * | proj_option = "" , |
||
Option_t * | draw_option = "" |
||
) |
Creates a new THStack from a TH2 or TH3.
It is filled with the 1D histograms from GetProjectionX or GetProjectionY for each bin of the histogram. It illustrates the differences and total sum along an axis.
Parameters:
<axis>
is the value of the parameter axis.Definition at line 172 of file THStack.cxx.
THStack::THStack | ( | const THStack & | hstack | ) |
THStack copy constructor.
Definition at line 346 of file THStack.cxx.
|
override |
THStack destructor.
Definition at line 323 of file THStack.cxx.
Add a new histogram to the list.
Only 1-d and 2-d histograms currently supported. A drawing option may be specified
Definition at line 366 of file THStack.cxx.
TIter THStack::begin | ( | ) | const |
Get an iterator over internal hists list.
Definition at line 1081 of file THStack.cxx.
|
overridevirtual |
Create all additional objects and stack (if specified).
Definition at line 708 of file THStack.cxx.
|
inline |
|
protected |
Build the sum of all histograms.
Build a separate list fStack containing the running sum of all histograms
Definition at line 391 of file THStack.cxx.
|
static |
|
inlinestaticconstexpr |
|
inlinestatic |
Compute distance from point px, py to each graph.
Reimplemented from TObject.
Definition at line 416 of file THStack.cxx.
|
overridevirtual |
Draw this stack with its current attributes.
Options to draw histograms are described in THistPainter::Paint By default (if the option "nostack" is not specified), histograms will be painted stacked on top of each other.
Reimplemented from TObject.
Definition at line 453 of file THStack.cxx.
TH1 * THStack::GetHistogram | ( | ) | const |
Returns a pointer to the histogram used to draw the axis.
Takes into account the two following cases: 1- option 'A' was specified in THStack::Draw. Return fHistogram 2- user had called TPad::DrawFrame. return pointer to hframe histogram
IMPORTANT NOTES
Definition at line 484 of file THStack.cxx.
|
virtual |
Returns the maximum of all added histograms smaller than maxval.
Returns the maximum of all histograms, smaller than maxval, if option "nostack".
Definition at line 498 of file THStack.cxx.
|
virtual |
Returns the minimum of all added histograms larger than minval.
Returns the minimum of all histograms, larger than minval, if option "nostack".
Definition at line 547 of file THStack.cxx.
Int_t THStack::GetNhists | ( | ) | const |
Return the number of histograms in the stack.
Definition at line 591 of file THStack.cxx.
TObjArray * THStack::GetStack | ( | ) |
Return pointer to Stack. Build it if not yet done.
Definition at line 600 of file THStack.cxx.
TAxis * THStack::GetXaxis | ( | ) | const |
Get the x-axis of the histogram used to draw the stack.
IMPORTANT NOTE You must call Draw before calling this function. The returned histogram depends on the selected Draw options.
Definition at line 613 of file THStack.cxx.
TAxis * THStack::GetYaxis | ( | ) | const |
Get the y-axis of the histogram used to draw the stack.
IMPORTANT NOTE You must call Draw before calling this function. The returned histogram depends on the selected Draw options.
Definition at line 626 of file THStack.cxx.
TAxis * THStack::GetZaxis | ( | ) | const |
Get the z-axis of the histogram used to draw the stack.
IMPORTANT NOTE You must call Draw before calling this function. The returned histogram depends on the selected Draw options.
Definition at line 639 of file THStack.cxx.
|
inlineoverridevirtual |
|
overridevirtual |
List histograms in the stack.
Reimplemented from TObject.
Definition at line 651 of file THStack.cxx.
|
virtual |
Merge the THStack in the TList into this stack.
Returns the total number of histograms in the result or -1 in case of an error.
Definition at line 664 of file THStack.cxx.
|
virtual |
Note: this method invalidates the sum of histograms.
Definition at line 687 of file THStack.cxx.
|
overridevirtual |
Reimplemented from TObject.
Definition at line 700 of file THStack.cxx.
|
overridevirtual |
Print the list of histograms.
Reimplemented from TObject.
Definition at line 993 of file THStack.cxx.
|
overridevirtual |
Recursively remove the object obj
from the list of histograms.
Reimplemented from TObject.
Definition at line 1003 of file THStack.cxx.
|
overridevirtual |
Save primitive as a C++ statement(s) on output stream out.
Reimplemented from TObject.
Definition at line 1013 of file THStack.cxx.
|
inlinevirtual |
|
virtual |
Set maximum.
Definition at line 1063 of file THStack.cxx.
|
virtual |
Set minimum.
Definition at line 1072 of file THStack.cxx.
|
overridevirtual |
|
inline |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |