Logo ROOT  
Reference Guide
THLimitsFinder Class Reference

Class to compute nice axis limits.

This class is called by default by the histogramming system and also by TTree::Draw, TTreePlayer::DrawSelect. TGaxis use it also to optimize axis labels.

A different finder may be specified via THLimitsFinder::SetFinder.

Definition at line 28 of file THLimitsFinder.h.

Public Member Functions

 THLimitsFinder ()
 Pointer to hist limits finder. More...
 
virtual ~THLimitsFinder ()
 
virtual Int_t FindGoodLimits (TH1 *h, Double_t xmin, Double_t xmax)
 Compute the best axis limits for the X axis. More...
 
virtual Int_t FindGoodLimits (TH1 *h, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax)
 Compute the best axis limits for the X and Y axis. More...
 
virtual Int_t FindGoodLimits (TH1 *h, Double_t xmin, Double_t xmax, Double_t ymin, Double_t ymax, Double_t zmin, Double_t zmax)
 Compute the best axis limits for the X, Y and Z axis. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
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. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static THLimitsFinderGetLimitsFinder ()
 Return pointer to the current finder. More...
 
static void Optimize (Double_t A1, Double_t A2, Int_t nold, Double_t &BinLow, Double_t &BinHigh, Int_t &nbins, Double_t &BWID, Option_t *option="")
 Static function to compute reasonable axis limits. More...
 
static void OptimizeLimits (Int_t nbins, Int_t &newbins, Double_t &xmin, Double_t &xmax, Bool_t isInteger)
 Optimize axis limits. More...
 
static void SetLimitsFinder (THLimitsFinder *finder)
 This static function can be used to specify a finder derived from THLimitsFinder. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Static Protected Attributes

static THLimitsFinderfgLimitsFinder = 0
 

Additional Inherited Members

- 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)
}
 
- 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). More...
 
void MakeZombie ()
 

#include <THLimitsFinder.h>

Inheritance diagram for THLimitsFinder:
[legend]

Constructor & Destructor Documentation

◆ THLimitsFinder()

THLimitsFinder::THLimitsFinder ( )

Pointer to hist limits finder.

Definition at line 32 of file THLimitsFinder.cxx.

◆ ~THLimitsFinder()

THLimitsFinder::~THLimitsFinder ( )
virtual

Definition at line 38 of file THLimitsFinder.cxx.

Member Function Documentation

◆ FindGoodLimits() [1/3]

Int_t THLimitsFinder::FindGoodLimits ( TH1 h,
Double_t  xmin,
Double_t  xmax 
)
virtual

Compute the best axis limits for the X axis.

If the bit kIsInteger is set, the number of channels is also recomputed. The axis parameters are replaced by the optimized parameters.

Example: With the input parameters xmin=-1.467 and xmax=2.344, the function will compute better limits -1.8 and 2.7 and store them in the axis.

Reimplemented in TProofLimitsFinder.

Definition at line 53 of file THLimitsFinder.cxx.

◆ FindGoodLimits() [2/3]

Int_t THLimitsFinder::FindGoodLimits ( TH1 h,
Double_t  xmin,
Double_t  xmax,
Double_t  ymin,
Double_t  ymax 
)
virtual

Compute the best axis limits for the X and Y axis.

If the bit kIsInteger is set, the number of channels is also recomputed. The axis parameters are replaced by the optimized parameters

Reimplemented in TProofLimitsFinder.

Definition at line 78 of file THLimitsFinder.cxx.

◆ FindGoodLimits() [3/3]

Int_t THLimitsFinder::FindGoodLimits ( TH1 h,
Double_t  xmin,
Double_t  xmax,
Double_t  ymin,
Double_t  ymax,
Double_t  zmin,
Double_t  zmax 
)
virtual

Compute the best axis limits for the X, Y and Z axis.

If the bit kIsInteger is set, the number of channels is also recomputed. The axis parameters are replaced by the optimized parameters

Reimplemented in TProofLimitsFinder.

Definition at line 111 of file THLimitsFinder.cxx.

◆ GetLimitsFinder()

THLimitsFinder * THLimitsFinder::GetLimitsFinder ( )
static

Return pointer to the current finder.

Create one if none exists Use SetLimitsFinder to set a user defined finder.

Definition at line 153 of file THLimitsFinder.cxx.

◆ Optimize()

void THLimitsFinder::Optimize ( Double_t  A1,
Double_t  A2,
Int_t  nold,
Double_t BinLow,
Double_t BinHigh,
Int_t nbins,
Double_t BinWidth,
Option_t option = "" 
)
static

Static function to compute reasonable axis limits.

Input parameters:

Parameters
[in]A1,A2: Original axis limits
[in]BinLow,BinHigh: Optimized axis limits. They should be initialized by the calling method for instance to 0.
[out]nold: Original number of divisions.
[out]nbins: Optimized number of divisions.
[out]BinWidth: Optimized bin width. It should be initialized by the calling method for instance to 0.
[in]option: "T" means Time axis.

Definition at line 184 of file THLimitsFinder.cxx.

◆ OptimizeLimits()

void THLimitsFinder::OptimizeLimits ( Int_t  nbins,
Int_t newbins,
Double_t xmin,
Double_t xmax,
Bool_t  isInteger 
)
static

Optimize axis limits.

When isInter=kTRUE, the function makes an integer binwidth and recompute the number of bins accordingly.

Definition at line 367 of file THLimitsFinder.cxx.

◆ SetLimitsFinder()

void THLimitsFinder::SetLimitsFinder ( THLimitsFinder finder)
static

This static function can be used to specify a finder derived from THLimitsFinder.

The finder may redefine the functions FindGoodLimits. Note that the redefined functions may call THLimitsFinder::FindGoodLimits.

Definition at line 165 of file THLimitsFinder.cxx.

Member Data Documentation

◆ fgLimitsFinder

THLimitsFinder * THLimitsFinder::fgLimitsFinder = 0
staticprotected

Definition at line 31 of file THLimitsFinder.h.

Libraries for THLimitsFinder:
[legend]

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