Logo ROOT   master
Reference Guide
TMVA::Timer Class Reference

Timing information for training and evaluation of MVA methods.

Usage:

TMVA::Timer timer( Nloops, "MyClassName" );
for (Int_t i=0; i<Nloops; i++) {
... // some code
// now, print progress bar:
timer.DrawProgressBar( i );
// **OR** text output of left time (never both !)
fLogger << " time left: " << timer.GetLeftTime( i ) << Endl;
}
fLogger << "MyClassName" << ": elapsed time: " << timer.GetElapsedTime()
<< Endl;

Remark: in batch mode, the progress bar is quite ugly; you may want to use the text output then

Note that by default in TMVA::Config the drawing of the progress bar is switched off. To have the progress bar visible you need to enable it by calling TMVA::gConfig().SetDrawProgressBar(true)

Definition at line 58 of file Timer.h.

Public Member Functions

 Timer (const char *prefix="", Bool_t colourfulOutput=kTRUE)
 constructor More...
 
 Timer (Int_t ncounts, const char *prefix="", Bool_t colourfulOutput=kTRUE)
 standard constructor: ncounts gives the total number of counts that the loop will iterate through. More...
 
virtual ~Timer (void)
 destructor More...
 
void DrawProgressBar (Int_t, const TString &comment="")
 draws progress bar in color or B&W caution: More...
 
void DrawProgressBar (TString)
 draws a string in the progress bar More...
 
void DrawProgressBar (void)
 draws the progressbar More...
 
Double_t ElapsedSeconds (void)
 computes elapsed tim in seconds More...
 
TString GetElapsedTime (Bool_t Scientific=kTRUE)
 returns pretty string with elapsed time More...
 
TString GetLeftTime (Int_t icounts)
 returns pretty string with time left More...
 
void Init (Int_t ncounts)
 
void Reset (void)
 resets timer More...
 
- Public Member Functions inherited from TStopwatch
 TStopwatch ()
 Create a stopwatch and start it. More...
 
void Continue ()
 Resume a stopped stopwatch. More...
 
Int_t Counter () const
 
Double_t CpuTime ()
 Stop the stopwatch (if it is running) and return the cputime (in seconds) passed between the start and stop events. More...
 
void Print (Option_t *option="") const
 Print the real and cpu time passed between the start and stop events. More...
 
Double_t RealTime ()
 Stop the stopwatch (if it is running) and return the realtime (in seconds) passed between the start and stop events. More...
 
void Reset ()
 
void ResetCpuTime (Double_t time=0)
 
void ResetRealTime (Double_t time=0)
 
void Start (Bool_t reset=kTRUE)
 Start the stopwatch. More...
 
void Stop ()
 Stop the stopwatch. 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 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, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
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...
 

Private Member Functions

MsgLoggerLog () const
 
TString SecToText (Double_t, Bool_t) const
 pretty string output More...
 

Private Attributes

Bool_t fColourfulOutput
 
MsgLoggerfLogger
 
Int_t fNcounts
 
Bool_t fOutputToFile
 
TString fPrefix
 
Int_t fPreviousProgress
 
TString fPreviousTimeEstimate
 
Int_t fProgressBarStringLength
 

Static Private Attributes

static const TString fgClassName = "Timer"
 
static const Int_t fgNbins = 16
 

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)
}
 
- 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...
 
- 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 <TMVA/Timer.h>

Inheritance diagram for TMVA::Timer:
[legend]

Constructor & Destructor Documentation

◆ Timer() [1/2]

TMVA::Timer::Timer ( const char *  prefix = "",
Bool_t  colourfulOutput = kTRUE 
)

constructor

Definition at line 86 of file Timer.cxx.

◆ Timer() [2/2]

TMVA::Timer::Timer ( Int_t  ncounts,
const char *  prefix = "",
Bool_t  colourfulOutput = kTRUE 
)

standard constructor: ncounts gives the total number of counts that the loop will iterate through.

At each call of the timer, the current number of counts is provided by the user, so that the timer can obtain the due time from linearly interpolating the spent time.

Definition at line 97 of file Timer.cxx.

◆ ~Timer()

TMVA::Timer::~Timer ( void  )
virtual

destructor

Definition at line 113 of file Timer.cxx.

Member Function Documentation

◆ DrawProgressBar() [1/3]

void TMVA::Timer::DrawProgressBar ( Int_t  icounts,
const TString comment = "" 
)

draws progress bar in color or B&W caution:

Definition at line 203 of file Timer.cxx.

◆ DrawProgressBar() [2/3]

void TMVA::Timer::DrawProgressBar ( TString  theString)

draws a string in the progress bar

Definition at line 182 of file Timer.cxx.

◆ DrawProgressBar() [3/3]

void TMVA::Timer::DrawProgressBar ( void  )

draws the progressbar

Definition at line 167 of file Timer.cxx.

◆ ElapsedSeconds()

Double_t TMVA::Timer::ElapsedSeconds ( void  )

computes elapsed tim in seconds

Definition at line 138 of file Timer.cxx.

◆ GetElapsedTime()

TString TMVA::Timer::GetElapsedTime ( Bool_t  Scientific = kTRUE)

returns pretty string with elapsed time

Definition at line 147 of file Timer.cxx.

◆ GetLeftTime()

TString TMVA::Timer::GetLeftTime ( Int_t  icounts)

returns pretty string with time left

Definition at line 155 of file Timer.cxx.

◆ Init()

void TMVA::Timer::Init ( Int_t  ncounts)

Definition at line 118 of file Timer.cxx.

◆ Log()

MsgLogger& TMVA::Timer::Log ( ) const
inlineprivate

Definition at line 97 of file Timer.h.

◆ Reset()

void TMVA::Timer::Reset ( void  )

resets timer

Definition at line 128 of file Timer.cxx.

◆ SecToText()

TString TMVA::Timer::SecToText ( Double_t  seconds,
Bool_t  Scientific 
) const
private

pretty string output

Definition at line 263 of file Timer.cxx.

Member Data Documentation

◆ fColourfulOutput

Bool_t TMVA::Timer::fColourfulOutput
private

Definition at line 84 of file Timer.h.

◆ fgClassName

const TString TMVA::Timer::fgClassName = "Timer"
staticprivate

Definition at line 93 of file Timer.h.

◆ fgNbins

const Int_t TMVA::Timer::fgNbins = 16
staticprivate

Definition at line 94 of file Timer.h.

◆ fLogger

MsgLogger* TMVA::Timer::fLogger
mutableprivate

Definition at line 96 of file Timer.h.

◆ fNcounts

Int_t TMVA::Timer::fNcounts
private

Definition at line 82 of file Timer.h.

◆ fOutputToFile

Bool_t TMVA::Timer::fOutputToFile
private

Definition at line 89 of file Timer.h.

◆ fPrefix

TString TMVA::Timer::fPrefix
private

Definition at line 83 of file Timer.h.

◆ fPreviousProgress

Int_t TMVA::Timer::fPreviousProgress
private

Definition at line 87 of file Timer.h.

◆ fPreviousTimeEstimate

TString TMVA::Timer::fPreviousTimeEstimate
private

Definition at line 88 of file Timer.h.

◆ fProgressBarStringLength

Int_t TMVA::Timer::fProgressBarStringLength
private

Definition at line 91 of file Timer.h.

Libraries for TMVA::Timer:
[legend]

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