Class to manage histogram axis.

This class manages histogram axis. It is referenced by TH1 and TGraph. To make a graphical representation of an histogram axis, this class references the TGaxis class. TAxis supports axis with fixed or variable bin sizes. Labels may be associated to individual bins. See examples of various axis representations drawn by class TGaxis.

Definition at line 30 of file TAxis.h.

Public Types
enum	EStatusBits { kDecimals = BIT(7) , kTickPlus = BIT(9) , kTickMinus = BIT(10) , kAxisRange = BIT(11) , kCenterTitle = BIT(12) , kCenterLabels = BIT(14) , kRotateTitle = BIT(15) , kPalette = BIT(16) , kNoExponent = BIT(17) , kLabelsHori = BIT(18) , kLabelsVert = BIT(19) , kLabelsDown = BIT(20) , kLabelsUp = BIT(21) , kIsInteger = BIT(22) , kMoreLogLabels = BIT(23) }

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

Public Member Functions
	TAxis ()
	Default constructor.

	TAxis (const TAxis &axis)
	Copy constructor.

	TAxis (Int_t nbins, const Double_t *xbins)
	Axis constructor for variable bin size.

	TAxis (Int_t nbins, Double_t xmin, Double_t xmax)
	Axis constructor for axis with fix bin size.

virtual	~TAxis ()
	Destructor.

Bool_t	CanBeAlphanumeric ()

Bool_t	CanExtend () const

void	CenterLabels (Bool_t center=kTRUE)
	Center axis labels.

void	CenterTitle (Bool_t center=kTRUE)
	Center axis title.

void	ChangeLabel (Int_t labNum=0, Double_t labAngle=-1., Double_t labSize=-1., Int_t labAlign=-1, Int_t labColor=-1, Int_t labFont=-1, TString labText="")
	Define new text attributes for the label number "labNum".

const char *	ChooseTimeFormat (Double_t axislength=0)
	Choose a reasonable time format from the coordinates in the active pad and the number of divisions in this axis If orientation = "X", the horizontal axis of the pad will be used for ref.

virtual void	Copy (TObject &axis) const
	Copy axis structure to another axis.

virtual void	Delete (Option_t *="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Compute distance from point px,py to an axis.

virtual TObject *	DrawClone (Option_t *="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

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

virtual Int_t	FindBin (const char *label)
	Find bin number with label.

virtual Int_t	FindBin (Double_t x)
	Find bin number corresponding to abscissa x.

virtual Int_t	FindBin (Double_t x) const

virtual Int_t	FindFixBin (const char *label) const
	Find bin number with label.

virtual Int_t	FindFixBin (Double_t x) const
	Find bin number corresponding to abscissa x.

virtual Double_t	GetBinCenter (Int_t bin) const
	Return center of bin.

virtual Double_t	GetBinCenterLog (Int_t bin) const
	Return center of bin in log With a log-equidistant binning for a bin with low and up edges, the mean is : 0.5*(ln low + ln up) i.e.

const char *	GetBinLabel (Int_t bin) const
	Return label for bin.

virtual Double_t	GetBinLowEdge (Int_t bin) const
	Return low edge of bin.

virtual Double_t	GetBinUpEdge (Int_t bin) const
	Return up edge of bin.

virtual Double_t	GetBinWidth (Int_t bin) const
	Return bin width.

virtual void	GetCenter (Double_t *center) const
	Return an array with the center of all bins.

Bool_t	GetCenterLabels () const

Bool_t	GetCenterTitle () const

Bool_t	GetDecimals () const

Int_t	GetFirst () const
	Return first bin on the axis i.e.

THashList *	GetLabels () const

Int_t	GetLast () const
	Return last bin on the axis i.e.

virtual void	GetLowEdge (Double_t *edge) const
	Return an array with the low edge of all bins.

TList *	GetModifiedLabels () const

Bool_t	GetMoreLogLabels () const

Int_t	GetNbins () const

Bool_t	GetNoExponent () const

virtual TObject *	GetParent () const

Bool_t	GetRotateTitle () const

virtual const char *	GetTicks () const
	Return the ticks option (see SetTicks)

virtual Bool_t	GetTimeDisplay () const

virtual const char *	GetTimeFormat () const

virtual const char *	GetTimeFormatOnly () const
	Return only the time format from the string fTimeFormat.

const char *	GetTitle () const
	Returns title of object.

const TArrayD *	GetXbins () const

Double_t	GetXmax () const

Double_t	GetXmin () const

virtual void	ImportAttributes (const TAxis *axis)
	Copy axis attributes to this.

Bool_t	IsAlphanumeric () const

Bool_t	IsVariableBinSize () const

virtual void	LabelsOption (Option_t *option="h")
	Set option(s) to draw axis with labels option can be:

TAxis &	operator= (const TAxis &)
	Assignment operator.

void	RotateTitle (Bool_t rotate=kTRUE)
	Rotate title by 180 degrees.

virtual void	SaveAttributes (std::ostream &out, const char name, const char subname)
	Save axis attributes as C++ statement(s) on output stream out.

virtual void	Set (Int_t nbins, const Double_t *xbins)
	Initialize axis with variable bins.

virtual void	Set (Int_t nbins, const Float_t *xbins)
	Initialize axis with variable bins.

virtual void	Set (Int_t nbins, Double_t xmin, Double_t xmax)
	Initialize axis with fix bins.

void	SetAlphanumeric (Bool_t alphanumeric=kTRUE)
	Set axis alphanumeric.

virtual void	SetBinLabel (Int_t bin, const char *label)
	Set label for bin.

void	SetCanExtend (Bool_t canExtend)

void	SetDecimals (Bool_t dot=kTRUE)
	Sets the decimals flag By default, blank characters are stripped, and then the label is correctly aligned.

virtual void	SetDefaults ()
	Set axis default values (from TStyle)

virtual void	SetDrawOption (Option_t *="")
	Set drawing option for object.

virtual void	SetLimits (Double_t xmin, Double_t xmax)

void	SetMoreLogLabels (Bool_t more=kTRUE)
	Set the kMoreLogLabels bit flag When this option is selected more labels are drawn when in log scale and there is a small number of decades (<3).

void	SetNoAlphanumeric (Bool_t noalpha=kTRUE)

void	SetNoExponent (Bool_t noExponent=kTRUE)
	Set the NoExponent flag By default, an exponent of the form 10^N is used when the label value are either all very small or very large.

virtual void	SetParent (TObject *obj)

virtual void	SetRange (Int_t first=0, Int_t last=0)
	Set the viewing range for the axis using bin numbers.

virtual void	SetRangeUser (Double_t ufirst, Double_t ulast)
	Set the viewing range for the axis from ufirst to ulast (in user coordinates, that is, the "natural" axis coordinates).

virtual void	SetTicks (Option_t *option="+")
	Set ticks orientation.

virtual void	SetTimeDisplay (Int_t value)

virtual void	SetTimeFormat (const char *format="")
	Change the format used for time plotting.

virtual void	SetTimeOffset (Double_t toffset, Option_t *option="local")
	Change the time offset If option = "gmt", set display mode to GMT.

virtual void	UnZoom ()
	Reset first & last bin to the full range.

virtual void	ZoomOut (Double_t factor=0, Double_t offset=0)
	Zoom out by a factor of 'factor' (default =2) uses previous zoom factor by default Keep center defined by 'offset' fixed ie.

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.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

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 two TNamed objects.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

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

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

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

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

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 void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

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

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

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	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

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.

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

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.

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

virtual	~TAttAxis ()
	Destructor.

void	Copy (TAttAxis &attaxis) const
	Copy of the object.

virtual Color_t	GetAxisColor () const

virtual Color_t	GetLabelColor () const

virtual Style_t	GetLabelFont () const

virtual Float_t	GetLabelOffset () const

virtual Float_t	GetLabelSize () const

virtual Int_t	GetMaxDigits () const

virtual Int_t	GetNdivisions () const

virtual Float_t	GetTickLength () const

virtual Color_t	GetTitleColor () const

virtual Style_t	GetTitleFont () const

virtual Float_t	GetTitleOffset () const

virtual Float_t	GetTitleSize () const

virtual void	ResetAttAxis (Option_t *option="")
	Reset axis attributes.

virtual void	SetAxisColor (Color_t color=1, Float_t alpha=1.)
	Set color of the line axis and tick marks.

virtual void	SetLabelColor (Color_t color=1, Float_t alpha=1.)
	Set color of labels.

virtual void	SetLabelFont (Style_t font=62)
	Set labels' font.

virtual void	SetLabelOffset (Float_t offset=0.005)
	Set distance between the axis and the labels.

virtual void	SetLabelSize (Float_t size=0.04)
	Set size of axis labels.

virtual void	SetMaxDigits (Int_t maxDigits=5)
	This function sets the maximum number of digits permitted for the axis labels above which the notation with 10^N is used.

virtual void	SetNdivisions (Int_t n1, Int_t n2, Int_t n3, Bool_t optim=kTRUE)
	Set the number of divisions for this axis using one `int` per division level.

virtual void	SetNdivisions (Int_t n=510, Bool_t optim=kTRUE)
	Set the number of divisions for this axis.

virtual void	SetTickLength (Float_t length=0.03)
	Set tick mark length.

virtual void	SetTickSize (Float_t size=0.03)

virtual void	SetTitleColor (Color_t color=1)
	Set color of axis title.

virtual void	SetTitleFont (Style_t font=62)
	Set the title font.

virtual void	SetTitleOffset (Float_t offset=1)
	Set distance between the axis and the axis title.

virtual void	SetTitleSize (Float_t size=0.04)
	Set size of axis title.

Private Types
enum	{ kAlphanumeric = BIT(0) , kCanExtend = BIT(1) , kNotAlpha = BIT(2) }

Private Member Functions
Bool_t	HasBinWithoutLabel () const
	this helper function checks if there is a bin without a label if all bins have labels, the axis can / will become alphanumeric

Private Attributes
UShort_t	fBits2

Int_t	fFirst

THashList *	fLabels
	Object owning this axis.

Int_t	fLast

TList *	fModLabs

Int_t	fNbins

TObject *	fParent

Bool_t	fTimeDisplay

TString	fTimeFormat

TArrayD	fXbins

Double_t	fXmax

Double_t	fXmin

Additional Inherited Members
Static Public Member Functions inherited from TObject
static Long_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 ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TAttAxis
Color_t	fAxisColor
	Color of the line axis.

Color_t	fLabelColor
	Color of labels.

Style_t	fLabelFont
	Font for labels.

Float_t	fLabelOffset
	Offset of labels.

Float_t	fLabelSize
	Size of labels.

Int_t	fNdivisions
	Number of divisions(10000n3 + 100n2 + n1)

Float_t	fTickLength
	Length of tick marks.

Color_t	fTitleColor
	Color of axis title.

Style_t	fTitleFont
	Font for axis title.

Float_t	fTitleOffset
	Offset of axis title.

Float_t	fTitleSize
	Size of axis title.

#include <TAxis.h>

Inheritance diagram for TAxis:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
kAlphanumeric
kCanExtend
kNotAlpha

Definition at line 47 of file TAxis.h.

◆ EStatusBits

enum TAxis::EStatusBits

Enumerator
kDecimals
kTickPlus
kTickMinus
kAxisRange
kCenterTitle
kCenterLabels
kRotateTitle
kPalette
kNoExponent
kLabelsHori
kLabelsVert
kLabelsDown
kLabelsUp
kIsInteger
kMoreLogLabels

Definition at line 57 of file TAxis.h.

Constructor & Destructor Documentation

◆ TAxis() [1/4]

TAxis::TAxis ( )

Default constructor.

Definition at line 49 of file TAxis.cxx.

◆ TAxis() [2/4]

TAxis::TAxis	(	Int_t	nbins,
		Double_t	xmin,
		Double_t	xmax
	)

Axis constructor for axis with fix bin size.

Definition at line 66 of file TAxis.cxx.

◆ TAxis() [3/4]

TAxis::TAxis	(	Int_t	nbins,
		const Double_t *	xbins
	)

Axis constructor for variable bin size.

Definition at line 77 of file TAxis.cxx.

◆ TAxis() [4/4]

TAxis::TAxis ( const TAxis & axis )

Copy constructor.

Definition at line 105 of file TAxis.cxx.

◆ ~TAxis()

TAxis::~TAxis ( )

virtual

Destructor.

Definition at line 88 of file TAxis.cxx.

Member Function Documentation

◆ CanBeAlphanumeric()

Bool_t TAxis::CanBeAlphanumeric ( )

inline

Definition at line 83 of file TAxis.h.

◆ CanExtend()

Bool_t TAxis::CanExtend ( ) const

inline

Definition at line 82 of file TAxis.h.

◆ CenterLabels()

void TAxis::CenterLabels ( Bool_t center = kTRUE )

inline

Center axis labels.

If center = kTRUE axis labels will be centered (horizontal axes only) on the bin center. Default is to center on the primary tick marks This option does not make sense if there are more bins than tick marks

Definition at line 175 of file TAxis.h.

◆ CenterTitle()

void TAxis::CenterTitle ( Bool_t center = kTRUE )

inline

Center axis title.

If center = kTRUE axis title will be centered default is right adjusted

Definition at line 184 of file TAxis.h.

◆ ChangeLabel()

void TAxis::ChangeLabel	(	Int_t	labNum = `0`,
		Double_t	labAngle = `-1.`,
		Double_t	labSize = `-1.`,
		Int_t	labAlign = `-1`,
		Int_t	labColor = `-1`,
		Int_t	labFont = `-1`,
		TString	labText = `""`
	)

Define new text attributes for the label number "labNum".

It allows to do a fine tuning of the labels. All the attributes can be changed, even the label text itself.

Parameters

[in]	labNum	Number of the label to be changed, negative numbers start from the end
[in]	labAngle	New angle value
[in]	labSize	New size (0 erase the label)
[in]	labAlign	New alignment value
[in]	labColor	New label color
[in]	labFont	New label font
[in]	labText	New label text

If an attribute should not be changed just give the value "-1".

If labnum=0 the list of modified labels is reset.

Definition at line 873 of file TAxis.cxx.

◆ ChooseTimeFormat()

const char * TAxis::ChooseTimeFormat ( Double_t axislength = 0 )

Choose a reasonable time format from the coordinates in the active pad and the number of divisions in this axis If orientation = "X", the horizontal axis of the pad will be used for ref.

If orientation = "Y", the vertical axis of the pad will be used for ref.

Definition at line 126 of file TAxis.cxx.

◆ Copy()

void TAxis::Copy ( TObject & axis ) const

virtual

Copy axis structure to another axis.

Reimplemented from TNamed.

Definition at line 210 of file TAxis.cxx.

◆ Delete()

virtual void TAxis::Delete ( Option_t * option = "" )

inlinevirtual

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented from TObject.

Definition at line 98 of file TAxis.h.

◆ DistancetoPrimitive()

Int_t TAxis::DistancetoPrimitive	(	Int_t	px,
		Int_t	py
	)

virtual

Compute distance from point px,py to an axis.

Reimplemented from TObject.

Definition at line 265 of file TAxis.cxx.

◆ DrawClone()

virtual TObject * TAxis::DrawClone ( Option_t * option = "" ) const

inlinevirtual

Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).

Reimplemented from TObject.

Definition at line 100 of file TAxis.h.

◆ ExecuteEvent()

void TAxis::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py
	)

virtual

Execute action corresponding to one event.

This member function is called when an axis is clicked with the locator. The axis range is set between the position where the mouse is pressed and the position where it is released. If the mouse position is outside the current axis range when it is released the axis is unzoomed with the corresponding proportions. Note that the mouse does not need to be in the pad or even canvas when it is released.

Reimplemented from TObject.

Definition at line 281 of file TAxis.cxx.

◆ FindBin() [1/3]

Int_t TAxis::FindBin ( const char * label )

virtual

Find bin number with label.

If the List of labels does not exist create it and make the axis alphanumeric If one wants just to add a single label- just call TAxis::SetBinLabel If label is not in the list of labels do the following depending on the bit TAxis::kCanExtend; of the axis.

if the bit is set add the new label and if the number of labels exceeds the number of bins, double the number of bins via TH1::LabelsInflate
if the bit is not set and the histogram has labels in each bin set the bit automatically and consider the histogram as alphanumeric if histogram has only some bins with labels then the histogram is not consider alphanumeric and return -1

-1 is returned only when the Axis has no parent histogram

Definition at line 338 of file TAxis.cxx.

◆ FindBin() [2/3]

Int_t TAxis::FindBin ( Double_t x )

virtual

Find bin number corresponding to abscissa x.

NOTE: this method does not work with alphanumeric bins !!!

If x is underflow or overflow, attempt to extend the axis if TAxis::kCanExtend is true. Otherwise, return 0 or fNbins+1.

Definition at line 293 of file TAxis.cxx.

◆ FindBin() [3/3]

virtual Int_t TAxis::FindBin ( Double_t x ) const

inlinevirtual

Definition at line 103 of file TAxis.h.

◆ FindFixBin() [1/2]

Int_t TAxis::FindFixBin ( const char * label ) const

virtual

Find bin number with label.

If the List of labels does not exist or the label does not exist just return -1 . Do not attempt to modify the axis. This is different than FindBin

Definition at line 401 of file TAxis.cxx.

◆ FindFixBin() [2/2]

Int_t TAxis::FindFixBin ( Double_t x ) const

virtual

Find bin number corresponding to abscissa x.

Identical to TAxis::FindBin except that if x is an underflow/overflow no attempt is made to extend the axis.

Definition at line 419 of file TAxis.cxx.

◆ GetBinCenter()

Double_t TAxis::GetBinCenter ( Int_t bin ) const

virtual

Return center of bin.

Definition at line 478 of file TAxis.cxx.

◆ GetBinCenterLog()

Double_t TAxis::GetBinCenterLog ( Int_t bin ) const

virtual

Return center of bin in log With a log-equidistant binning for a bin with low and up edges, the mean is : 0.5*(ln low + ln up) i.e.

sqrt(low*up) in logx (e.g. sqrt(10^0*10^2) = 10). Imagine a bin with low=1 and up=100 :

the center in lin is (100-1)/2=50.5
the center in log would be sqrt(1*100)=10 (!=log(50.5))

NB: if the low edge of the bin is negative, the function returns the bin center as computed by TAxis::GetBinCenter

Definition at line 501 of file TAxis.cxx.

◆ GetBinLabel()

const char * TAxis::GetBinLabel ( Int_t bin ) const

Return label for bin.

Definition at line 440 of file TAxis.cxx.

◆ GetBinLowEdge()

Double_t TAxis::GetBinLowEdge ( Int_t bin ) const

virtual

Return low edge of bin.

Definition at line 518 of file TAxis.cxx.

◆ GetBinUpEdge()

Double_t TAxis::GetBinUpEdge ( Int_t bin ) const

virtual

Return up edge of bin.

Definition at line 528 of file TAxis.cxx.

◆ GetBinWidth()

Double_t TAxis::GetBinWidth ( Int_t bin ) const

virtual

Return bin width.

Definition at line 540 of file TAxis.cxx.

◆ GetCenter()

void TAxis::GetCenter ( Double_t * center ) const

virtual

Return an array with the center of all bins.

Definition at line 553 of file TAxis.cxx.

◆ GetCenterLabels()

Bool_t TAxis::GetCenterLabels ( ) const

inline

Definition at line 114 of file TAxis.h.

◆ GetCenterTitle()

Bool_t TAxis::GetCenterTitle ( ) const

inline

Definition at line 115 of file TAxis.h.

◆ GetDecimals()

Bool_t TAxis::GetDecimals ( ) const

inline

Definition at line 116 of file TAxis.h.

◆ GetFirst()

Int_t TAxis::GetFirst ( ) const

Return first bin on the axis i.e.

1 if no range defined NOTE: in some cases a zero is returned (see TAxis::SetRange)

Definition at line 458 of file TAxis.cxx.

◆ GetLabels()

THashList * TAxis::GetLabels ( ) const

inline

Definition at line 117 of file TAxis.h.

◆ GetLast()

Int_t TAxis::GetLast ( ) const

Return last bin on the axis i.e.

fNbins if no range defined NOTE: in some cases a zero is returned (see TAxis::SetRange)

Definition at line 469 of file TAxis.cxx.

◆ GetLowEdge()

void TAxis::GetLowEdge ( Double_t * edge ) const

virtual

Return an array with the low edge of all bins.

Definition at line 562 of file TAxis.cxx.

◆ GetModifiedLabels()

TList * TAxis::GetModifiedLabels ( ) const

inline

Definition at line 118 of file TAxis.h.

◆ GetMoreLogLabels()

Bool_t TAxis::GetMoreLogLabels ( ) const

inline

Definition at line 120 of file TAxis.h.

◆ GetNbins()

Int_t TAxis::GetNbins ( ) const

inline

Definition at line 121 of file TAxis.h.

◆ GetNoExponent()

Bool_t TAxis::GetNoExponent ( ) const

inline

Definition at line 122 of file TAxis.h.

◆ GetParent()

virtual TObject * TAxis::GetParent ( ) const

inlinevirtual

Definition at line 123 of file TAxis.h.

◆ GetRotateTitle()

Bool_t TAxis::GetRotateTitle ( ) const

inline

Definition at line 124 of file TAxis.h.

◆ GetTicks()

const char * TAxis::GetTicks ( ) const

virtual

Return the ticks option (see SetTicks)

Definition at line 586 of file TAxis.cxx.

◆ GetTimeDisplay()

virtual Bool_t TAxis::GetTimeDisplay ( ) const

inlinevirtual

Definition at line 126 of file TAxis.h.

◆ GetTimeFormat()

virtual const char * TAxis::GetTimeFormat ( ) const

inlinevirtual

Definition at line 127 of file TAxis.h.

◆ GetTimeFormatOnly()

const char * TAxis::GetTimeFormatOnly ( ) const

virtual

Return only the time format from the string fTimeFormat.

Definition at line 571 of file TAxis.cxx.

◆ GetTitle()

const char * TAxis::GetTitle ( ) const

inlinevirtual

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TNamed.

Definition at line 129 of file TAxis.h.

◆ GetXbins()

const TArrayD * TAxis::GetXbins ( ) const

inline

Definition at line 130 of file TAxis.h.

◆ GetXmax()

Double_t TAxis::GetXmax ( ) const

inline

Definition at line 134 of file TAxis.h.

◆ GetXmin()

Double_t TAxis::GetXmin ( ) const

inline

Definition at line 133 of file TAxis.h.

◆ HasBinWithoutLabel()

Bool_t TAxis::HasBinWithoutLabel ( ) const

private

this helper function checks if there is a bin without a label if all bins have labels, the axis can / will become alphanumeric

Definition at line 597 of file TAxis.cxx.

◆ ImportAttributes()

void TAxis::ImportAttributes ( const TAxis * axis )

virtual

Copy axis attributes to this.

Definition at line 631 of file TAxis.cxx.

◆ IsAlphanumeric()

Bool_t TAxis::IsAlphanumeric ( ) const

inline

Definition at line 84 of file TAxis.h.

◆ IsVariableBinSize()

Bool_t TAxis::IsVariableBinSize ( ) const

inline

Definition at line 136 of file TAxis.h.

◆ LabelsOption()

void TAxis::LabelsOption ( Option_t * option = "h" )

virtual

Set option(s) to draw axis with labels option can be:

"a" sort by alphabetic order
">" sort by decreasing values
"<" sort by increasing values
"h" draw labels horizontal
"v" draw labels vertical
"u" draw labels up (end of label right adjusted)
"d" draw labels down (start of label left adjusted)

Definition at line 613 of file TAxis.cxx.

◆ operator=()

TAxis & TAxis::operator= ( const TAxis & orig )

Assignment operator.

Definition at line 113 of file TAxis.cxx.

◆ RotateTitle()

void TAxis::RotateTitle ( Bool_t rotate = kTRUE )

inline

Rotate title by 180 degrees.

By default the title is drawn right adjusted. If rotate is TRUE, the title is left adjusted at the end of the axis and rotated by 180 degrees

Definition at line 193 of file TAxis.h.

◆ SaveAttributes()

void TAxis::SaveAttributes	(	std::ostream &	out,
		const char *	name,
		const char *	subname
	)

virtual

Save axis attributes as C++ statement(s) on output stream out.

Reimplemented from TAttAxis.

Definition at line 661 of file TAxis.cxx.

◆ Set() [1/3]

void TAxis::Set	(	Int_t	nbins,
		const Double_t *	xbins
	)

virtual

Initialize axis with variable bins.

Definition at line 761 of file TAxis.cxx.

◆ Set() [2/3]

void TAxis::Set	(	Int_t	nbins,
		const Float_t *	xbins
	)

virtual

Initialize axis with variable bins.

Definition at line 743 of file TAxis.cxx.

◆ Set() [3/3]

void TAxis::Set	(	Int_t	nbins,
		Double_t	xmin,
		Double_t	xmax
	)

virtual

Initialize axis with fix bins.

Definition at line 731 of file TAxis.cxx.

◆ SetAlphanumeric()

void TAxis::SetAlphanumeric ( Bool_t alphanumeric = kTRUE )

Set axis alphanumeric.

Definition at line 779 of file TAxis.cxx.

◆ SetBinLabel()

void TAxis::SetBinLabel	(	Int_t	bin,
		const char *	label
	)

virtual

Set label for bin.

If no label list exists, it is created. If all the bins have labels, the axis becomes alphanumeric and extendable. New labels will not be added with the Fill method but will end-up in the underflow bin. See documentation of TAxis::FindBin(const char*)

Definition at line 823 of file TAxis.cxx.

◆ SetCanExtend()

void TAxis::SetCanExtend ( Bool_t canExtend )

inline

Definition at line 86 of file TAxis.h.

◆ SetDecimals()

void TAxis::SetDecimals ( Bool_t dot = kTRUE )

inline

Sets the decimals flag By default, blank characters are stripped, and then the label is correctly aligned.

If the dot is the last character of the string, it is also stripped, unless this option is specified.

Definition at line 203 of file TAxis.h.

◆ SetDefaults()

void TAxis::SetDefaults ( )

virtual

Set axis default values (from TStyle)

Definition at line 803 of file TAxis.cxx.

◆ SetDrawOption()

virtual void TAxis::SetDrawOption ( Option_t * option = "" )

inlinevirtual

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented from TObject.

Definition at line 149 of file TAxis.h.

◆ SetLimits()

virtual void TAxis::SetLimits	(	Double_t	xmin,
		Double_t	xmax
	)

inlinevirtual

Definition at line 154 of file TAxis.h.

◆ SetMoreLogLabels()

void TAxis::SetMoreLogLabels ( Bool_t more = kTRUE )

inline

Set the kMoreLogLabels bit flag When this option is selected more labels are drawn when in log scale and there is a small number of decades (<3).

The flag (in fBits) is passed to the drawing function TGaxis::PaintAxis

Definition at line 213 of file TAxis.h.

◆ SetNoAlphanumeric()

void TAxis::SetNoAlphanumeric ( Bool_t noalpha = kTRUE )

inline

Definition at line 87 of file TAxis.h.

◆ SetNoExponent()

void TAxis::SetNoExponent ( Bool_t noExponent = kTRUE )

inline

Set the NoExponent flag By default, an exponent of the form 10^N is used when the label value are either all very small or very large.

The flag (in fBits) is passed to the drawing function TGaxis::PaintAxis

Definition at line 223 of file TAxis.h.

◆ SetParent()

virtual void TAxis::SetParent ( TObject * obj )

inlinevirtual

Definition at line 157 of file TAxis.h.

◆ SetRange()

void TAxis::SetRange	(	Int_t	first = `0`,
		Int_t	last = `0`
	)

virtual

Set the viewing range for the axis using bin numbers.

Parameters

first	First bin of the range.
last	Last bin of the range. To set a range using the axis coordinates, use TAxis::SetRangeUser.

If first == last == 0 or if first > last or if the range specified does not intersect at all with the maximum available range [0, fNbins + 1], then the viewing range is reset by removing the bit TAxis::kAxisRange. In this case, the functions TAxis::GetFirst() and TAxis::GetLast() will return 1 and fNbins.

If the range specified partially intersects with [0, fNbins + 1], then the intersection range is accepted. For instance, if first == -2 and last == fNbins, the accepted range will be [0, fNbins] (fFirst = 0 and fLast = fNbins).

Note: For historical reasons, SetRange(0,0) resets the range even though bin 0 is technically reserved for the underflow; in order to set the range of the axis so that it only includes the underflow, use SetRange(-1,0).

Definition at line 920 of file TAxis.cxx.

◆ SetRangeUser()

void TAxis::SetRangeUser	(	Double_t	ufirst,
		Double_t	ulast
	)

virtual

Set the viewing range for the axis from ufirst to ulast (in user coordinates, that is, the "natural" axis coordinates).

To set a range using the axis bin numbers, use TAxis::SetRange.

Definition at line 946 of file TAxis.cxx.

◆ SetTicks()

void TAxis::SetTicks ( Option_t * option = "+" )

virtual

Set ticks orientation.

option = "+" ticks drawn on the "positive side" (default) option = "-" ticks drawn on the "negative side" option = "+-" ticks drawn on both sides

Definition at line 972 of file TAxis.cxx.

◆ SetTimeDisplay()

virtual void TAxis::SetTimeDisplay ( Int_t value )

inlinevirtual

Definition at line 161 of file TAxis.h.

◆ SetTimeFormat()

void TAxis::SetTimeFormat ( const char * tformat = "" )

virtual

Change the format used for time plotting.

The format string for date and time use the same options as the one used in the standard strftime C function, i.e. : for date :

     %a abbreviated weekday name
     %b abbreviated month name
     %d day of the month (01-31)
     %m month (01-12)
     %y year without century

for time :

     %H hour (24-hour clock)
     %I hour (12-hour clock)
     %p local equivalent of AM or PM
     %M minute (00-59)
     %S seconds (00-61)
     %% %

This function allows also to define the time offset. It is done via F which should be appended at the end of the format string. The time offset has the following format: 'yyyy-mm-dd hh:mm:ss' Example:

     h = new TH1F("Test","h",3000,0.,200000.);
     h->GetXaxis()->SetTimeDisplay(1);
     h->GetXaxis()->SetTimeFormat("%d\/%m\/%y%F2000-02-28 13:00:01");

This defines the time format being "dd/mm/yy" and the time offset as the February 28th 2003 at 13:00:01

If F is not specified, the time offset used will be the one defined by: gStyle->SetTimeOffset. For example like that:

     TDatime da(2003,02,28,12,00,00);
     gStyle->SetTimeOffset(da.Convert());

Definition at line 1020 of file TAxis.cxx.

◆ SetTimeOffset()

void TAxis::SetTimeOffset	(	Double_t	toffset,
		Option_t *	option = `"local"`
	)

virtual

Change the time offset If option = "gmt", set display mode to GMT.

Definition at line 1046 of file TAxis.cxx.

◆ UnZoom()

void TAxis::UnZoom ( )

virtual

Reset first & last bin to the full range.

Definition at line 1132 of file TAxis.cxx.

◆ ZoomOut()

void TAxis::ZoomOut	(	Double_t	factor = `0`,
		Double_t	offset = `0`
	)

virtual

Zoom out by a factor of 'factor' (default =2) uses previous zoom factor by default Keep center defined by 'offset' fixed ie.

-1 at left of current range, 0 in center, +1 at right

Definition at line 1207 of file TAxis.cxx.

Member Data Documentation

◆ fBits2

UShort_t TAxis::fBits2

private

Definition at line 39 of file TAxis.h.

◆ fFirst

Int_t TAxis::fFirst

private

Definition at line 37 of file TAxis.h.

◆ fLabels

THashList* TAxis::fLabels

private

Object owning this axis.

Definition at line 43 of file TAxis.h.

◆ fLast

Int_t TAxis::fLast

private

Definition at line 38 of file TAxis.h.

◆ fModLabs

TList* TAxis::fModLabs

private

Definition at line 44 of file TAxis.h.

◆ fNbins

Int_t TAxis::fNbins

private

Definition at line 33 of file TAxis.h.

◆ fParent

TObject* TAxis::fParent

private

Definition at line 42 of file TAxis.h.

◆ fTimeDisplay

Bool_t TAxis::fTimeDisplay

private

Definition at line 40 of file TAxis.h.

◆ fTimeFormat

TString TAxis::fTimeFormat

private

Definition at line 41 of file TAxis.h.

◆ fXbins

TArrayD TAxis::fXbins

private

Definition at line 36 of file TAxis.h.

◆ fXmax

Double_t TAxis::fXmax

private

Definition at line 35 of file TAxis.h.

◆ fXmin

Double_t TAxis::fXmin

private

Definition at line 34 of file TAxis.h.

Libraries for TAxis:

[legend]

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

hist/hist/inc/TAxis.h
hist/hist/src/TAxis.cxx

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

◆ EStatusBits

Constructor & Destructor Documentation

◆ TAxis() [1/4]

◆ TAxis() [2/4]

◆ TAxis() [3/4]

◆ TAxis() [4/4]

◆ ~TAxis()

Member Function Documentation

◆ CanBeAlphanumeric()

◆ CanExtend()

◆ CenterLabels()

◆ CenterTitle()

◆ ChangeLabel()

◆ ChooseTimeFormat()

◆ Copy()

◆ Delete()

◆ DistancetoPrimitive()

◆ DrawClone()

◆ ExecuteEvent()

◆ FindBin() [1/3]

◆ FindBin() [2/3]

◆ FindBin() [3/3]

◆ FindFixBin() [1/2]

◆ FindFixBin() [2/2]

◆ GetBinCenter()

◆ GetBinCenterLog()

◆ GetBinLabel()

◆ GetBinLowEdge()

◆ GetBinUpEdge()

◆ GetBinWidth()

◆ GetCenter()

◆ GetCenterLabels()

◆ GetCenterTitle()

◆ GetDecimals()

◆ GetFirst()

◆ GetLabels()

◆ GetLast()

◆ GetLowEdge()

◆ GetModifiedLabels()

◆ GetMoreLogLabels()

◆ GetNbins()

◆ GetNoExponent()

◆ GetParent()

◆ GetRotateTitle()

◆ GetTicks()

◆ GetTimeDisplay()

◆ GetTimeFormat()

◆ GetTimeFormatOnly()

◆ GetTitle()

◆ GetXbins()

◆ GetXmax()

◆ GetXmin()

◆ HasBinWithoutLabel()

◆ ImportAttributes()

◆ IsAlphanumeric()

◆ IsVariableBinSize()

◆ LabelsOption()

◆ operator=()

◆ RotateTitle()

◆ SaveAttributes()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetAlphanumeric()

◆ SetBinLabel()

◆ SetCanExtend()

◆ SetDecimals()

◆ SetDefaults()

◆ SetDrawOption()

◆ SetLimits()

◆ SetMoreLogLabels()

◆ SetNoAlphanumeric()