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:

gStyle->SetOptStat(mode);

mode

Option_t Option_t TPoint TPoint const char mode

Definition TGWin32VirtualXProxy.cxx:68

gStyle

R__EXTERN TStyle * gStyle

Definition TStyle.h:436

TStyle::SetOptStat

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:1640

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

For example:

gStyle->SetOptStat(11);

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

gStyle->SetOptStat(1101);

displays the name of histogram, mean value and RMS.

WARNING 1: never do:

gStyle->SetOptStat(0001111);

but instead do:

gStyle->SetOptStat(1111);

because 0001111 will be taken as an octal number!

WARNING 2: for backward compatibility with older versions

gStyle->SetOptStat(1);

is taken as:

gStyle->SetOptStat(1111)

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

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

gStyle->SetOptStat("ne");

To print only the name of the histogram do:

gStyle->SetOptStat("n");

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")

h

#define h(i)

Definition RSha256.hxx:106

TObject::FindObject

virtual TObject * FindObject(const char *name) const

Must be redefined in derived classes.

Definition TObject.cxx:420

TPaveStats

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");

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

To remove the border or shadow of the TPaveStats, use the function TPave::SetBorderSize

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

st->SetOptStat(mode);

TPaveStats::SetOptStat

void SetOptStat(Int_t stat=1)

Set the stat option.

Definition TPaveStats.cxx:308

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

Example:

gStyle->SetOptFit(1011);

TStyle::SetOptFit

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:1593

print fit probability, parameter names/values and errors.

When "v" = 1 is specified, only the non-fixed parameters are shown.
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);
   gStyle->SetOptStat();
   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);
   myt ->SetTextColor(kRed);
   listOfLines->Add(myt);
 
   // the following line is needed to avoid that the automatic redrawing of stats
   h->SetStats(0);
 
   se->Modified();
   return se;
}

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.

	~TPaveStats () override
	TPaveStats default destructor.

TBox *	AddBox (Double_t, Double_t, Double_t, Double_t) override
	Add a new graphics box to this pavetext.

TLine *	AddLine (Double_t, Double_t, Double_t, Double_t) override
	Add a new graphics line to this pavetext.

void	DeleteText () override
	Delete text at the mouse position.

void	EditText () override
	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.

TObject *	GetParent () const override

virtual const char *	GetStatFormat () const

void	InsertLine () override
	Add a new line at the mouse position.

void	InsertText (const char *) override
	Add a new Text line at the mouse position.

TClass *	IsA () const override

void	Paint (Option_t *option="") override
	Paint the pave stat.

void	ReadFile (const char , Option_t , Int_t, Int_t) override
	Read lines of filename in this pavetext.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save primitive as a C++ statement(s) on output stream out.

virtual void	SaveStyle ()
	Save This TPaveStats options in current style.

void	SetAllWith (const char , Option_t , Double_t) override
	Set attribute option for all lines containing string text.

void	SetDrawOption (Option_t *option="") override
	Invalid method to change drawing option for stats box While stats box should never appear in pad list of primitives, this method cannot work Please use SetOption() method insted Redefined here to remove MENU qualifier and exclude it from context menu.

virtual void	SetFitFormat (const char *format="5.4g")
	Change (i.e. set) the format for printing fit parameters in statistics box.

void	SetOptFit (Int_t fit=1)
	Set the fit option.

void	SetOption (Option_t *option="br") override
	Change drawing option for stats box While stats should not appear in pad list of primitives, this is the only way to modify drawing option.

void	SetOptStat (Int_t stat=1)
	Set the stat option.

void	SetParent (TObject *obj) override

virtual void	SetStatFormat (const char *format="6.4g")
	Change (i.e. set) the format for printing statistics.

void	Streamer (TBuffer &) override
	Stream an object of class TPaveStats.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	UseCurrentStyle () override
	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.

	~TPaveText () override
	pavetext default destructor.

virtual TText *	AddText (const char *label)
	Add a new Text line to this pavetext.

virtual TText *	AddText (Double_t x1, Double_t y1, const char *label)
	Add a new Text line to this pavetext at given coordinates.

void	Clear (Option_t *option="") override
	Clear all lines in this pavetext.

void	Draw (Option_t *option="") override
	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 TText *	GetLine (Int_t number) const
	Get Pointer to line number in this pavetext.

virtual TText *	GetLineWith (const char *text) const
	Get Pointer to first containing string text in this pavetext.

virtual TList *	GetListOfLines () const

Float_t	GetMargin () const

virtual TObject *	GetObject (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)

TClass *	IsA () const override

TPaveText &	operator= (const TPaveText &)
	assignment operator

void	Paint (Option_t *option="") override
	Paint this pavetext with its current attributes.

virtual void	PaintPrimitives (Int_t mode)
	Paint list of primitives in this pavetext.

void	Print (Option_t *option="") const override
	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.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save primitive as a C++ statement(s) on output stream out.

virtual void	SetLabel (const char *label)

virtual void	SetMargin (Float_t margin=0.05)

void	Streamer (TBuffer &) override
	Stream an object of class TPaveText.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	UseCurrentStyle () override
	Replace current attributes by current style.

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.

	~TPave () override
	Pave default destructor.

virtual void	ConvertNDCtoPad ()
	Convert pave coordinates from NDC to Pad coordinates.

void	Copy (TObject &pave) const override
	Copy this pave to pave.

Int_t	DistancetoPrimitive (Int_t px, Int_t py) override
	Compute distance from point px,py to a pave.

virtual TPave *	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.

void	ExecuteEvent (Int_t event, Int_t px, Int_t py) override
	Execute action corresponding to one event.

Int_t	GetBorderSize () const

Double_t	GetCornerRadius () const

const char *	GetName () const override
	Returns name of object.

Option_t *	GetOption () const override

Int_t	GetShadowColor () const

Double_t	GetX1NDC () const

Double_t	GetX2NDC () const

Double_t	GetY1NDC () const

Double_t	GetY2NDC () const

ULong_t	Hash () const override
	Return hash value for this object.

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List this pave with its attributes.

TPave &	operator= (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)
	Sets the border size of the TPave box and shadow.

virtual void	SetCornerRadius (Double_t rad=0.2)

virtual void	SetName (const char *name="")

virtual void	SetShadowColor (Int_t color)

void	SetX1 (Double_t x1) override
	Set the X1 value.

virtual void	SetX1NDC (Double_t x1)

void	SetX2 (Double_t x2) override
	Set the X2 value.

virtual void	SetX2NDC (Double_t x2)

void	SetY1 (Double_t y1) override
	Set the Y1 value.

virtual void	SetY1NDC (Double_t y1)

void	SetY2 (Double_t y2) override
	Set the Y2 value.

virtual void	SetY2NDC (Double_t y2)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

	~TBox () override
	Box destructor.

virtual TBox *	DrawBox (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
	Draw this box with new coordinates.

Rectangle_t	GetBBox () override
	Return the "bounding Box" of the Box.

TPoint	GetBBoxCenter () override
	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.

TBox &	operator= (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.

void	SetBBoxCenter (const TPoint &p) override
	Set center of the Box.

void	SetBBoxCenterX (const Int_t x) override
	Set X coordinate of the center of the Box.

void	SetBBoxCenterY (const Int_t y) override
	Set Y coordinate of the center of the Box.

void	SetBBoxX1 (const Int_t x) override
	Set left hand side of BoundingBox to a value (resize in x direction on left)

void	SetBBoxX2 (const Int_t x) override
	Set right hand side of BoundingBox to a value (resize in x direction on right)

void	SetBBoxY1 (const Int_t y) override
	Set top of BoundingBox to a value (resize in y direction on top)

void	SetBBoxY2 (const Int_t y) override
	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.

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.

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 TObject *	Clone (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 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	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 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 (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.

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	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	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.

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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TAttBBox2D
virtual	~TAttBBox2D ()

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 text 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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TVirtualPaveStats
virtual	~TVirtualPaveStats ()=default

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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 TPaveText
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TPave
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TBox
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.

Static Public Member Functions inherited from TAttLine
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttFill
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttBBox2D
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TAttText
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TVirtualPaveStats
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Protected Attributes
TString	fFitFormat
	Printing format for fit parameters.

Int_t	fOptFit
	option Fit

Int_t	fOptStat
	option Stat

TObject *	fParent {nullptr}
	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.

TList *	fLines {nullptr}
	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 = (1ULL << ( 11 )) }

Public Types inherited from TBox
enum	{ kCannotMove = (1ULL << ( 12 )) }

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 )) }

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 231 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 241 of file TPaveStats.cxx.

◆ ~TPaveStats()

TPaveStats::~TPaveStats ( )

override

TPaveStats default destructor.

Definition at line 254 of file TPaveStats.cxx.

Member Function Documentation

◆ AddBox()

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

inlineoverridevirtual

Add a new graphics box to this pavetext.

Reimplemented from TPaveText.

Definition at line 31 of file TPaveStats.h.

◆ AddLine()

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

inlineoverridevirtual

Add a new graphics line to this pavetext.

Reimplemented from TPaveText.

Definition at line 32 of file TPaveStats.h.

◆ Class()

static TClass * TPaveStats::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TPaveStats::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TPaveStats::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 56 of file TPaveStats.h.

◆ DeclFileName()

static const char * TPaveStats::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 56 of file TPaveStats.h.

◆ DeleteText()

void TPaveStats::DeleteText ( )

inlineoverridevirtual

Delete text at the mouse position.

Reimplemented from TPaveText.

Definition at line 33 of file TPaveStats.h.

◆ EditText()

void TPaveStats::EditText ( )

inlineoverridevirtual

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 262 of file TPaveStats.cxx.

◆ GetOptStat()

Int_t TPaveStats::GetOptStat ( ) const

Return the stat option.

Definition at line 271 of file TPaveStats.cxx.

◆ GetParent()

TObject * TPaveStats::GetParent ( ) const

inlineoverridevirtual

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()

void TPaveStats::InsertLine ( )

inlineoverridevirtual

Add a new line at the mouse position.

Reimplemented from TPaveText.

Definition at line 42 of file TPaveStats.h.

◆ InsertText()

void TPaveStats::InsertText ( const char * label )

inlineoverridevirtual

Add a new Text line at the mouse position.

Reimplemented from TPaveText.

Definition at line 41 of file TPaveStats.h.

◆ IsA()

TClass * TPaveStats::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TPave.

Definition at line 56 of file TPaveStats.h.

◆ Paint()

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

overridevirtual

Paint the pave stat.

Reimplemented from TPave.

Definition at line 348 of file TPaveStats.cxx.

◆ ReadFile()

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

inlineoverridevirtual

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 = `""`
	)

overridevirtual

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

Reimplemented from TPave.

Definition at line 527 of file TPaveStats.cxx.

◆ SaveStyle()

void TPaveStats::SaveStyle ( )

virtual

Save This TPaveStats options in current style.

Definition at line 280 of file TPaveStats.cxx.

◆ SetAllWith()

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

inlineoverridevirtual

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.

◆ SetDrawOption()

void TPaveStats::SetDrawOption ( Option_t * option = "" )

overridevirtual

Invalid method to change drawing option for stats box While stats box should never appear in pad list of primitives, this method cannot work Please use SetOption() method insted Redefined here to remove MENU qualifier and exclude it from context menu.

Reimplemented from TObject.

Definition at line 340 of file TPaveStats.cxx.

◆ 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 291 of file TPaveStats.cxx.

◆ SetOptFit()

void TPaveStats::SetOptFit ( Int_t fit = 1 )

Set the fit option.

Definition at line 299 of file TPaveStats.cxx.

◆ SetOption()

void TPaveStats::SetOption ( Option_t * option = "br" )

overridevirtual

Change drawing option for stats box While stats should not appear in pad list of primitives, this is the only way to modify drawing option.

SetDrawOption will not have effect Redefined here to add MENU qualifier to show it in context menu

Reimplemented from TPave.

Definition at line 329 of file TPaveStats.cxx.

◆ SetOptStat()

void TPaveStats::SetOptStat ( Int_t stat = 1 )

Set the stat option.

Definition at line 308 of file TPaveStats.cxx.

◆ SetParent()

void TPaveStats::SetParent ( TObject * obj )

inlineoverridevirtual

Implements TVirtualPaveStats.

Definition at line 53 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 317 of file TPaveStats.cxx.

◆ Streamer()

void TPaveStats::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TPaveStats.

Reimplemented from TPave.

Definition at line 562 of file TPaveStats.cxx.

◆ StreamerNVirtual()

void TPaveStats::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 56 of file TPaveStats.h.

◆ UseCurrentStyle()

void TPaveStats::UseCurrentStyle ( )

overridevirtual

Replace current attributes by current style.

Reimplemented from TObject.

Definition at line 593 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 {nullptr}

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:

[legend]

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

graf2d/graf/inc/TPaveStats.h
graf2d/graf/src/TPaveStats.cxx

Statistics Display

Fit Statistics

Statistics box editing

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TPaveStats() [1/2]

◆ TPaveStats() [2/2]

◆ ~TPaveStats()

Member Function Documentation

◆ AddBox()

◆ AddLine()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ DeleteText()

◆ EditText()

◆ GetFitFormat()

◆ GetOptFit()

◆ GetOptStat()

◆ GetParent()

◆ GetStatFormat()

◆ InsertLine()

◆ InsertText()

◆ IsA()

◆ Paint()

◆ ReadFile()

◆ SavePrimitive()

◆ SaveStyle()

◆ SetAllWith()

◆ SetDrawOption()

◆ SetFitFormat()

◆ SetOptFit()

◆ SetOption()

◆ SetOptStat()

◆ SetParent()

◆ SetStatFormat()

◆ Streamer()

◆ StreamerNVirtual()

◆ UseCurrentStyle()

Member Data Documentation

◆ fFitFormat

◆ fOptFit

◆ fOptStat

◆ fParent

◆ fStatFormat