Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TPaveStats Class Reference

The histogram statistics painter class.

To draw histogram statistics and fit parameters.

Statistics Display

The type of information shown in the histogram statistics box can be selected with:

R__EXTERN TStyle * gStyle
Definition TStyle.h:413
void SetOptStat(Int_t stat=1)
The type of information printed in the histogram statistics box can be selected via the parameter mod...
Definition TStyle.cxx:1589

The "`mode`" has up to nine digits that can be set to on (1 or 2), off (0).

mode = ksiourmen (default = 000001111)
k = 1; kurtosis printed
k = 2; kurtosis and kurtosis error printed
s = 1; skewness printed
s = 2; skewness and skewness error printed
i = 1; integral of bins printed
o = 1; number of overflows printed
u = 1; number of underflows printed
r = 1; rms printed
r = 2; rms and rms error printed
m = 1; mean value printed
m = 2; mean and mean error values printed
e = 1; number of entries printed
n = 1; name of histogram is printed
ROOT::R::TRInterface & r
Definition Object.C:4
#define e(i)
Definition RSha256.hxx:103
char name[80]
Definition TGX11.cxx:110
const Int_t n
Definition legend1.C:16
auto * m
Definition textangle.C:8

For example:

displays only the name of histogram and the number of entries, whereas:

displays the name of histogram, mean value and RMS.

WARNING 1: never do:

gStyle->SetOptStat(0001111);

but instead do:

because 0001111 will be taken as an octal number!

WARNING 2: for backward compatibility with older versions

is taken as:

To print only the name of the histogram do:

gStyle->SetOptStat(1000000001);

NOTE that in case of 2D histograms, when selecting only underflow (10000) or overflow (100000), the statistics box will show all combinations of underflow/overflows and not just one single number.

The parameter mode can be any combination of the letters kKsSiourRmMen

k : kurtosis printed
K : kurtosis and kurtosis error printed
s : skewness printed
S : skewness and skewness error printed
i : integral of bins printed
o : number of overflows printed
u : number of underflows printed
r : rms printed
R : rms and rms error printed
m : mean value printed
M : mean value mean error values printed
e : number of entries printed
n : name of histogram is printed
#define R(a, b, c, d, e, f, g, h, i)
Definition RSha256.hxx:110

For example, to print only name of histogram and number of entries do:

To print only the name of the histogram do:

The default value is:

gStyle->SetOptStat("nemr");

When a histogram is painted, a TPaveStats object is created and added to the list of functions of the histogram. If a TPaveStats object already exists in the histogram list of functions, the existing object is just updated with the current histogram parameters.

Once a histogram is painted, the statistics box can be accessed using h->FindObject("stats"). In the command line it is enough to do:

Root > h->Draw()
Root > TPaveStats *st = (TPaveStats*)h->FindObject("stats")
#define h(i)
Definition RSha256.hxx:106
virtual TObject * FindObject(const char *name) const
Must be redefined in derived classes.
Definition TObject.cxx:393
The histogram statistics painter class.
Definition TPaveStats.h:18

because after h->Draw() the histogram is automatically painted. But in a script file the painting should be forced using gPad->Update() in order to make sure the statistics box is created:

h->Draw();
gPad->Update();
TPaveStats *st = (TPaveStats*)h->FindObject("stats");
#define gPad

Without gPad->Update() the line h->FindObject("stats") returns a null pointer.

When a histogram is drawn with the option "`SAME`", the statistics box is not drawn. To force the statistics box drawing with the option "`SAME`", the option "`SAMES`" must be used. If the new statistics box hides the previous statistics box, one can change its position with these lines ("`h`" being the pointer to the histogram):

Root > TPaveStats *st = (TPaveStats*)h->FindObject("stats")
Root > st->SetX1NDC(newx1); //new x start position
Root > st->SetX2NDC(newx2); //new x end position
virtual void SetX1NDC(Double_t x1)
Definition TPave.h:78
virtual void SetX2NDC(Double_t x2)
Definition TPave.h:79

To change the type of information for an histogram with an existing TPaveStats one should do:

st->SetOptStat(mode);
void SetOptStat(Int_t stat=1)
Set the stat option.

Where "`mode`" has the same meaning than when calling gStyle->SetOptStat(mode) (see above).

One can delete the statistics box for a histogram TH1* h with:

h->SetStats(0)

and activate it again with:

h->SetStats(1).

Fit Statistics

The type of information about fit parameters printed in the histogram statistics box can be selected via the parameter mode. The parameter mode can be = pcev (default = 0111)

p = 1; print Probability
c = 1; print Chisquare/Number of degrees of freedom
e = 1; print errors (if e=1, v must be 1)
v = 1; print name/values of parameters
#define c(i)
Definition RSha256.hxx:101

Example:

void SetOptFit(Int_t fit=1)
The type of information about fit parameters printed in the histogram statistics box can be selected ...
Definition TStyle.cxx:1541

print fit probability, parameter names/values and errors.

  1. When "v" = 1 is specified, only the non-fixed parameters are shown.
  2. When "v" = 2 all parameters are shown.

Note: gStyle->SetOptFit(1) means "default value", so it is equivalent to gStyle->SetOptFit(111)

Statistics box editing

The following example show how to remove and add a line in a statistics box.

TCanvas *statsEditing() {
// Create and plot a test histogram with stats
TCanvas *se = new TCanvas;
TH1F *h = new TH1F("h","test",100,-3,3);
h->FillRandom("gaus",3000);
h->Draw();
se->Update();
// Retrieve the stat box
TPaveStats *ps = (TPaveStats*)se->GetPrimitive("stats");
ps->SetName("mystats");
TList *listOfLines = ps->GetListOfLines();
// Remove the RMS line
TText *tconst = ps->GetLineWith("RMS");
listOfLines->Remove(tconst);
// Add a new line in the stat box.
// Note that "=" is a control character
TLatex *myt = new TLatex(0,0,"Test = 10");
myt ->SetTextFont(42);
myt ->SetTextSize(0.04);
listOfLines->Add(myt);
// the following line is needed to avoid that the automatic redrawing of stats
h->SetStats(0);
se->Modified();
return se;
}
@ kRed
Definition Rtypes.h:66
virtual void SetTextColor(Color_t tcolor=1)
Set the text color.
Definition TAttText.h:44
virtual void SetTextFont(Font_t tfont=62)
Set the text font.
Definition TAttText.h:46
virtual void SetTextSize(Float_t tsize=1)
Set the text size.
Definition TAttText.h:47
The Canvas class.
Definition TCanvas.h:23
void Update() override
Update canvas pad buffers.
Definition TCanvas.cxx:2502
1-D histogram with a float per channel (see TH1 documentation)}
Definition TH1.h:575
To draw Mathematical Formula.
Definition TLatex.h:18
A doubly linked list.
Definition TList.h:38
virtual void Add(TObject *obj)
Definition TList.h:81
virtual TObject * Remove(TObject *obj)
Remove object from the list.
Definition TList.cxx:822
void Modified(Bool_t flag=1) override
Definition TPad.h:413
TObject * GetPrimitive(const char *name) const override
Get primitive.
Definition TPad.cxx:2894
virtual TList * GetListOfLines() const
Definition TPaveText.h:49
virtual TText * GetLineWith(const char *text) const
Get Pointer to first containing string text in this pavetext.
virtual void SetName(const char *name="")
Definition TPave.h:75
Base class for several text objects.
Definition TText.h:22

Definition at line 18 of file TPaveStats.h.

Public Member Functions

 TPaveStats ()
 TPaveStats default constructor.
 
 TPaveStats (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="br")
 TPaveStats normal constructor.
 
virtual ~TPaveStats ()
 TPaveStats default destructor.
 
virtual TBoxAddBox (Double_t, Double_t, Double_t, Double_t)
 Add a new graphics box to this pavetext.
 
virtual TLineAddLine (Double_t, Double_t, Double_t, Double_t)
 Add a new graphics line to this pavetext.
 
virtual void DeleteText ()
 Delete text at the mouse position.
 
virtual void EditText ()
 Edit text at the mouse position.
 
virtual const char * GetFitFormat () const
 
Int_t GetOptFit () const
 Return the fit option.
 
Int_t GetOptStat () const
 Return the stat option.
 
virtual TObjectGetParent () const
 
virtual const char * GetStatFormat () const
 
virtual void InsertLine ()
 Add a new line at the mouse position.
 
virtual void InsertText (const char *)
 Add a new Text line at the mouse position.
 
virtual void Paint (Option_t *option="")
 Paint the pave stat.
 
virtual void ReadFile (const char *, Option_t *, Int_t, Int_t)
 Read lines of filename in this pavetext.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out.
 
virtual void SaveStyle ()
 Save This TPaveStats options in current style.
 
virtual void SetAllWith (const char *, Option_t *, Double_t)
 Set attribute option for all lines containing string text.
 
virtual void SetFitFormat (const char *format="5.4g")
 Change (i.e. set) the format for printing fit parameters in statistics box.
 
virtual void SetMargin (Float_t)
 
void SetOptFit (Int_t fit=1)
 Set the fit option.
 
void SetOptStat (Int_t stat=1)
 Set the stat option.
 
virtual void SetParent (TObject *obj)
 
virtual void SetStatFormat (const char *format="6.4g")
 Change (i.e. set) the format for printing statistics.
 
virtual void UseCurrentStyle ()
 Replace current attributes by current style.
 
- Public Member Functions inherited from TPaveText
 TPaveText ()
 pavetext default constructor.
 
 TPaveText (const TPaveText &pavetext)
 pavetext copy constructor.
 
 TPaveText (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="br")
 PaveText normal constructor.
 
virtual ~TPaveText ()
 pavetext default destructor.
 
virtual TTextAddText (const char *label)
 Add a new Text line to this pavetext.
 
virtual TTextAddText (Double_t x1, Double_t y1, const char *label)
 Add a new Text line to this pavetext at given coordinates.
 
virtual void Clear (Option_t *option="")
 Clear all lines in this pavetext.
 
virtual void Draw (Option_t *option="")
 Draw this pavetext with its current attributes.
 
virtual void DrawFile (const char *filename, Option_t *option="")
 Draw lines in filename in this pavetext.
 
const char * GetLabel () const
 
virtual TTextGetLine (Int_t number) const
 Get Pointer to line number in this pavetext.
 
virtual TTextGetLineWith (const char *text) const
 Get Pointer to first containing string text in this pavetext.
 
virtual TListGetListOfLines () const
 
Float_t GetMargin () const
 
virtual TObjectGetObject (Double_t &ymouse, Double_t &yobj) const
 Get object pointed by the mouse in this pavetext.
 
virtual Int_t GetSize () const
 return number of text lines (ignoring TLine, etc)
 
TPaveTextoperator= (const TPaveText &)
 assignment operator
 
virtual void PaintPrimitives (Int_t mode)
 Paint list of primitives in this pavetext.
 
virtual void Print (Option_t *option="") const
 Dump this pavetext with its attributes.
 
virtual void SaveLines (std::ostream &out, const char *name, Bool_t saved)
 Save lines of this pavetext as C++ statements on output stream out.
 
virtual void SetLabel (const char *label)
 
- Public Member Functions inherited from TPave
 TPave ()
 Pave default constructor.
 
 TPave (const TPave &pave)
 Pave copy constructor.
 
 TPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
 Pave normal constructor.
 
virtual ~TPave ()
 Pave default destructor.
 
virtual void ConvertNDCtoPad ()
 Convert pave coordinates from NDC to Pad coordinates.
 
void Copy (TObject &pave) const
 Copy this pave to pave.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to a pave.
 
virtual void DrawPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
 Draw this pave with new coordinates.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event.
 
Int_t GetBorderSize () const
 
Double_t GetCornerRadius () const
 
Option_tGetName () const
 Returns name of object.
 
Option_tGetOption () const
 
Int_t GetShadowColor () const
 
Double_t GetX1NDC () const
 
Double_t GetX2NDC () const
 
Double_t GetY1NDC () const
 
Double_t GetY2NDC () const
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List this pave with its attributes.
 
TPaveoperator= (const TPave &src)
 Assignment operator.
 
virtual void PaintPave (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
 Draw this pave with new coordinates.
 
virtual void PaintPaveArc (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Int_t bordersize=4, Option_t *option="br")
 Draw this pave with rounded corners.
 
virtual void SetBorderSize (Int_t bordersize=4)
 
virtual void SetCornerRadius (Double_t rad=0.2)
 
virtual void SetName (const char *name="")
 
virtual void SetOption (Option_t *option="br")
 
virtual void SetShadowColor (Int_t color)
 
virtual void SetX1 (Double_t x1)
 Set the X1 value.
 
virtual void SetX1NDC (Double_t x1)
 
virtual void SetX2 (Double_t x2)
 Set the X2 value.
 
virtual void SetX2NDC (Double_t x2)
 
virtual void SetY1 (Double_t y1)
 Set the Y1 value.
 
virtual void SetY1NDC (Double_t y1)
 
virtual void SetY2 (Double_t y2)
 Set the Y2 value.
 
virtual void SetY2NDC (Double_t y2)
 
- Public Member Functions inherited from TBox
 TBox ()
 Box default constructor.
 
 TBox (const TBox &box)
 Box copy constructor.
 
 TBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Box standard constructor.
 
virtual ~TBox ()
 Box destructor.
 
virtual TBoxDrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw this box with new coordinates.
 
virtual Rectangle_t GetBBox ()
 Return the "bounding Box" of the Box.
 
virtual TPoint GetBBoxCenter ()
 Return the center of the Box as TPoint in pixels.
 
Double_t GetX1 () const
 
Double_t GetX2 () const
 
Double_t GetY1 () const
 
Double_t GetY2 () const
 
virtual void HideToolTip (Int_t event)
 Hide tool tip depending on the event type.
 
Bool_t IsBeingResized () const
 
virtual Int_t IsInside (Double_t x, Double_t y) const
 Function which returns 1 if point x,y lies inside the box, 0 otherwise.
 
TBoxoperator= (const TBox &)
 Assignment operator.
 
virtual void PaintBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2, Option_t *option="")
 Draw this box with new coordinates.
 
virtual void SetBBoxCenter (const TPoint &p)
 Set center of the Box.
 
virtual void SetBBoxCenterX (const Int_t x)
 Set X coordinate of the center of the Box.
 
virtual void SetBBoxCenterY (const Int_t y)
 Set Y coordinate of the center of the Box.
 
virtual void SetBBoxX1 (const Int_t x)
 Set left hand side of BoundingBox to a value (resize in x direction on left)
 
virtual void SetBBoxX2 (const Int_t x)
 Set right hand side of BoundingBox to a value (resize in x direction on right)
 
virtual void SetBBoxY1 (const Int_t y)
 Set top of BoundingBox to a value (resize in y direction on top)
 
virtual void SetBBoxY2 (const Int_t y)
 Set bottom of BoundingBox to a value (resize in y direction on bottom)
 
virtual void SetToolTipText (const char *text, Long_t delayms=1000)
 Set tool tip text associated with this box.
 
- 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.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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 TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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 const char * GetTitle () const
 Returns title of object.
 
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.
 
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)
 Operator delete [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
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.
 
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 Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor.
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor.
 
virtual ~TAttLine ()
 AttLine destructor.
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine.
 
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
 Compute distance from point px,py to a line.
 
virtual Color_t GetLineColor () const
 Return the line color.
 
virtual Style_t GetLineStyle () const
 Return the line style.
 
virtual Width_t GetLineWidth () const
 Return the line width.
 
virtual void Modify ()
 Change current line attributes if necessary.
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values.
 
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
 Save line attributes as C++ statement(s) on output stream out.
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes.
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color.
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color.
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style.
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width.
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 AttFill default constructor.
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor.
 
virtual ~TAttFill ()
 AttFill destructor.
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill.
 
virtual Color_t GetFillColor () const
 Return the fill area color.
 
virtual Style_t GetFillStyle () const
 Return the fill area style.
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary.
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values.
 
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
 Save fill attributes as C++ statement(s) on output stream out.
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes.
 
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color.
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color.
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style.
 
- Public Member Functions inherited from TAttBBox2D
virtual ~TAttBBox2D ()
 
- Public Member Functions inherited from TAttText
 TAttText ()
 AttText default constructor.
 
 TAttText (Int_t align, Float_t angle, Color_t color, Style_t font, Float_t tsize)
 AttText normal constructor.
 
virtual ~TAttText ()
 AttText destructor.
 
void Copy (TAttText &atttext) const
 Copy this text attributes to a new TAttText.
 
virtual Short_t GetTextAlign () const
 Return the text alignment.
 
virtual Float_t GetTextAngle () const
 Return the text angle.
 
virtual Color_t GetTextColor () const
 Return the text color.
 
virtual Font_t GetTextFont () const
 Return the text font.
 
virtual Float_t GetTextSize () const
 Return the text size.
 
virtual Float_t GetTextSizePercent (Float_t size)
 Return the text in percent of the pad size.
 
virtual void Modify ()
 Change current text attributes if necessary.
 
virtual void ResetAttText (Option_t *toption="")
 Reset this text attributes to default values.
 
virtual void SaveTextAttributes (std::ostream &out, const char *name, Int_t alidef=12, Float_t angdef=0, Int_t coldef=1, Int_t fondef=61, Float_t sizdef=1)
 Save text attributes as C++ statement(s) on output stream out.
 
virtual void SetTextAlign (Short_t align=11)
 Set the text alignment.
 
virtual void SetTextAngle (Float_t tangle=0)
 Set the text angle.
 
virtual void SetTextAttributes ()
 Invoke the DialogCanvas Text attributes.
 
virtual void SetTextColor (Color_t tcolor=1)
 Set the text color.
 
virtual void SetTextColorAlpha (Color_t tcolor, Float_t talpha)
 Set a transparent marker color.
 
virtual void SetTextFont (Font_t tfont=62)
 Set the text font.
 
virtual void SetTextSize (Float_t tsize=1)
 Set the text size.
 
virtual void SetTextSizePixels (Int_t npixels)
 Set the text size in pixel.
 
- Public Member Functions inherited from TVirtualPaveStats
virtual ~TVirtualPaveStats ()=default
 

Protected Attributes

TString fFitFormat
 Printing format for fit parameters.
 
Int_t fOptFit
 option Fit
 
Int_t fOptStat
 option Stat
 
TObjectfParent
 owner of this TPaveStats
 
TString fStatFormat
 Printing format for stats.
 
- Protected Attributes inherited from TPaveText
TString fLabel
 Label written at the top of the pavetext.
 
TListfLines
 List of labels.
 
Int_t fLongest
 Length of the longest line.
 
Float_t fMargin
 Text margin.
 
- Protected Attributes inherited from TPave
Int_t fBorderSize
 window box bordersize in pixels
 
Double_t fCornerRadius
 Corner radius in case of option arc.
 
Int_t fInit
 (=0 if transformation to NDC not yet done)
 
TString fName
 Pave name.
 
TString fOption
 Pave style.
 
Int_t fShadowColor
 Color of the pave's shadow.
 
Double_t fX1NDC
 X1 point in NDC coordinates.
 
Double_t fX2NDC
 X2 point in NDC coordinates.
 
Double_t fY1NDC
 Y1 point in NDC coordinates.
 
Double_t fY2NDC
 Y2 point in NDC coordinates.
 
- Protected Attributes inherited from TBox
Bool_t fResizing
 ! True if box is being resized
 
Double_t fX1
 X of 1st point.
 
Double_t fX2
 X of 2nd point.
 
Double_t fY1
 Y of 1st point.
 
Double_t fY2
 Y of 2nd point.
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color.
 
Style_t fLineStyle
 Line style.
 
Width_t fLineWidth
 Line width.
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 Fill area color.
 
Style_t fFillStyle
 Fill area style.
 
- Protected Attributes inherited from TAttText
Short_t fTextAlign
 Text alignment.
 
Float_t fTextAngle
 Text angle.
 
Color_t fTextColor
 Text color.
 
Font_t fTextFont
 Text font.
 
Float_t fTextSize
 Text size.
 

Additional Inherited Members

- Public Types inherited from TPave
enum  { kNameIsAction = BIT(11) }
 
- Public Types inherited from TBox
enum  { kCannotMove = BIT(12) }
 
- Public Types inherited from TObject
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 Public Member Functions inherited from TObject
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 Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- 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 ()
 

#include <TPaveStats.h>

Inheritance diagram for TPaveStats:
[legend]

Constructor & Destructor Documentation

◆ TPaveStats() [1/2]

TPaveStats::TPaveStats ( )

TPaveStats default constructor.

Definition at line 229 of file TPaveStats.cxx.

◆ TPaveStats() [2/2]

TPaveStats::TPaveStats ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2,
Option_t option = "br" 
)

TPaveStats normal constructor.

Definition at line 239 of file TPaveStats.cxx.

◆ ~TPaveStats()

TPaveStats::~TPaveStats ( )
virtual

TPaveStats default destructor.

Definition at line 252 of file TPaveStats.cxx.

Member Function Documentation

◆ AddBox()

virtual TBox * TPaveStats::AddBox ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)
inlinevirtual

Add a new graphics box to this pavetext.

Reimplemented from TPaveText.

Definition at line 31 of file TPaveStats.h.

◆ AddLine()

virtual TLine * TPaveStats::AddLine ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)
inlinevirtual

Add a new graphics line to this pavetext.

Reimplemented from TPaveText.

Definition at line 32 of file TPaveStats.h.

◆ DeleteText()

virtual void TPaveStats::DeleteText ( )
inlinevirtual

Delete text at the mouse position.

Reimplemented from TPaveText.

Definition at line 33 of file TPaveStats.h.

◆ EditText()

virtual void TPaveStats::EditText ( )
inlinevirtual

Edit text at the mouse position.

Reimplemented from TPaveText.

Definition at line 34 of file TPaveStats.h.

◆ GetFitFormat()

virtual const char * TPaveStats::GetFitFormat ( ) const
inlinevirtual

Definition at line 35 of file TPaveStats.h.

◆ GetOptFit()

Int_t TPaveStats::GetOptFit ( ) const

Return the fit option.

Definition at line 260 of file TPaveStats.cxx.

◆ GetOptStat()

Int_t TPaveStats::GetOptStat ( ) const

Return the stat option.

Definition at line 269 of file TPaveStats.cxx.

◆ GetParent()

virtual TObject * TPaveStats::GetParent ( ) const
inlinevirtual

Implements TVirtualPaveStats.

Definition at line 39 of file TPaveStats.h.

◆ GetStatFormat()

virtual const char * TPaveStats::GetStatFormat ( ) const
inlinevirtual

Definition at line 36 of file TPaveStats.h.

◆ InsertLine()

virtual void TPaveStats::InsertLine ( )
inlinevirtual

Add a new line at the mouse position.

Reimplemented from TPaveText.

Definition at line 42 of file TPaveStats.h.

◆ InsertText()

virtual void TPaveStats::InsertText ( const char *  label)
inlinevirtual

Add a new Text line at the mouse position.

Reimplemented from TPaveText.

Definition at line 41 of file TPaveStats.h.

◆ Paint()

void TPaveStats::Paint ( Option_t option = "")
virtual

Paint the pave stat.

Reimplemented from TPaveText.

Definition at line 323 of file TPaveStats.cxx.

◆ ReadFile()

virtual void TPaveStats::ReadFile ( const char *  filename,
Option_t option,
Int_t  nlines,
Int_t  fromline 
)
inlinevirtual

Read lines of filename in this pavetext.

Read from line number fromline a total of nlines

Note that this function changes the default text alignment to left/center

Reimplemented from TPaveText.

Definition at line 43 of file TPaveStats.h.

◆ SavePrimitive()

void TPaveStats::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TPaveText.

Definition at line 506 of file TPaveStats.cxx.

◆ SaveStyle()

void TPaveStats::SaveStyle ( )
virtual

Save This TPaveStats options in current style.

Definition at line 278 of file TPaveStats.cxx.

◆ SetAllWith()

virtual void TPaveStats::SetAllWith ( const char *  text,
Option_t option,
Double_t  value 
)
inlinevirtual

Set attribute option for all lines containing string text.

Possible options are all the AttText attributes Align, Color, Font, Size and Angle

Reimplemented from TPaveText.

Definition at line 46 of file TPaveStats.h.

◆ SetFitFormat()

void TPaveStats::SetFitFormat ( const char *  format = "5.4g")
virtual

Change (i.e. set) the format for printing fit parameters in statistics box.

Definition at line 289 of file TPaveStats.cxx.

◆ SetMargin()

virtual void TPaveStats::SetMargin ( Float_t  )
inlinevirtual

Reimplemented from TPaveText.

Definition at line 47 of file TPaveStats.h.

◆ SetOptFit()

void TPaveStats::SetOptFit ( Int_t  fit = 1)

Set the fit option.

Definition at line 297 of file TPaveStats.cxx.

◆ SetOptStat()

void TPaveStats::SetOptStat ( Int_t  stat = 1)

Set the stat option.

Definition at line 306 of file TPaveStats.cxx.

◆ SetParent()

virtual void TPaveStats::SetParent ( TObject obj)
inlinevirtual

Implements TVirtualPaveStats.

Definition at line 52 of file TPaveStats.h.

◆ SetStatFormat()

void TPaveStats::SetStatFormat ( const char *  format = "6.4g")
virtual

Change (i.e. set) the format for printing statistics.

Definition at line 315 of file TPaveStats.cxx.

◆ UseCurrentStyle()

void TPaveStats::UseCurrentStyle ( )
virtual

Replace current attributes by current style.

Reimplemented from TPaveText.

Definition at line 572 of file TPaveStats.cxx.

Member Data Documentation

◆ fFitFormat

TString TPaveStats::fFitFormat
protected

Printing format for fit parameters.

Definition at line 23 of file TPaveStats.h.

◆ fOptFit

Int_t TPaveStats::fOptFit
protected

option Fit

Definition at line 21 of file TPaveStats.h.

◆ fOptStat

Int_t TPaveStats::fOptStat
protected

option Stat

Definition at line 22 of file TPaveStats.h.

◆ fParent

TObject* TPaveStats::fParent
protected

owner of this TPaveStats

Definition at line 25 of file TPaveStats.h.

◆ fStatFormat

TString TPaveStats::fStatFormat
protected

Printing format for stats.

Definition at line 24 of file TPaveStats.h.

Libraries for TPaveStats:

The documentation for this class was generated from the following files: