ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RooBinning Class Reference

Definition at line 29 of file RooBinning.h.

Public Member Functions

 RooBinning (Double_t xlo=-RooNumber::infinity(), Double_t xhi=RooNumber::infinity(), const char *name=0)
 Constructor for an initially empty binning defining the range [xlo,xhi]. More...
 
 RooBinning (Int_t nBins, Double_t xlo, Double_t xhi, const char *name=0)
 Constructor for a uniform binning in 'nbins' bins in the range [xlo,xhi]. More...
 
 RooBinning (Int_t nBins, const Double_t *boundaries, const char *name=0)
 Constructor for a binning in the range[xlo,xhi] with 'nbins' bin boundaries listed array 'boundaries'. More...
 
 RooBinning (const RooBinning &other, const char *name=0)
 Copy constructor. More...
 
RooAbsBinningclone (const char *name=0) const
 
 ~RooBinning ()
 Destructor. More...
 
virtual Int_t numBoundaries () const
 
virtual Int_t binNumber (Double_t x) const
 Return sequential bin number that contains value x where bin zero is the first bin with an upper boundary above the lower bound of the range. More...
 
virtual Int_t rawBinNumber (Double_t x) const
 Return sequential bin number that contains value x where bin zero is the first bin that is defined, regardless if that bin is outside the current defined range. More...
 
virtual Double_t nearestBoundary (Double_t x) const
 Return the value of the nearest boundary to x. More...
 
virtual void setRange (Double_t xlo, Double_t xhi)
 Change the defined range associated with this binning. More...
 
virtual Double_t lowBound () const
 
virtual Double_t highBound () const
 
virtual Double_t averageBinWidth () const
 
virtual Double_tarray () const
 Return array of boundary values. More...
 
virtual Double_t binCenter (Int_t bin) const
 Return the position of the center of bin 'bin'. More...
 
virtual Double_t binWidth (Int_t bin) const
 Return the width of the requested bin. More...
 
virtual Double_t binLow (Int_t bin) const
 Return the lower bound of the requested bin. More...
 
virtual Double_t binHigh (Int_t bin) const
 Return the upper bound of the requested bin. More...
 
Bool_t addBoundary (Double_t boundary)
 Add bin boundary at given value. More...
 
void addBoundaryPair (Double_t boundary, Double_t mirrorPoint=0)
 Add pair of boundaries: one at 'boundary' and one at 2*mirrorPoint-boundary. More...
 
void addUniform (Int_t nBins, Double_t xlo, Double_t xhi)
 Add array of nbins uniformly sized bins in range [xlo,xhi]. More...
 
Bool_t removeBoundary (Double_t boundary)
 Remove boundary at given value. More...
 
Bool_t hasBoundary (Double_t boundary)
 Check if boundary exists at given value. More...
 
- Public Member Functions inherited from RooAbsBinning
 RooAbsBinning (const char *name=0)
 Constructor. More...
 
 RooAbsBinning (const RooAbsBinning &other, const char *name=0)
 
virtual TObjectClone (const char *newname=0) const
 Make a clone of an object using the Streamer facility. More...
 
virtual ~RooAbsBinning ()
 Destructor. More...
 
Int_t numBins () const
 
virtual Bool_t isUniform () const
 
virtual void setMin (Double_t xlo)
 
virtual void setMax (Double_t xhi)
 
virtual void Print (Option_t *options=0) const
 Print TNamed name and title. More...
 
virtual void printName (std::ostream &os) const
 Print binning name. More...
 
virtual void printTitle (std::ostream &os) const
 Print binning title. More...
 
virtual void printClassName (std::ostream &os) const
 Print binning class name. More...
 
virtual void printArgs (std::ostream &os) const
 Print binning arguments (the RooAbsReal objects represening the variable bin boundaries for parameterized binning implementations. More...
 
virtual void printValue (std::ostream &os) const
 Print binning value, i.e the bin boundary positions. More...
 
virtual Bool_t isParameterized () const
 
virtual RooAbsReallowBoundFunc () const
 
virtual RooAbsRealhighBoundFunc () const
 
virtual Bool_t isShareable () const
 
virtual void insertHook (RooAbsRealLValue &) const
 
virtual void removeHook (RooAbsRealLValue &) const
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. 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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. 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)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual void printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
 Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. More...
 
virtual void printAddress (std::ostream &os) const
 Print class name of object. More...
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
virtual void printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
 Interface for detailed printing of object. More...
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object. More...
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Default choice of contents to be printed (name and value) More...
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 

Protected Member Functions

Bool_t binEdges (Int_t bin, Double_t &xlo, Double_t &xhi) const
 Return upper and lower bound of bin 'bin'. More...
 
void updateBinCount ()
 Update the internal bin counter. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

Double_t _xlo
 
Double_t _xhi
 
Bool_t _ownBoundLo
 
Bool_t _ownBoundHi
 
Int_t _nbins
 
std::vector< Double_t_boundaries
 
Double_t_array
 
Int_t _blo
 Array of boundaries. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Public Types inherited from RooPrintable
enum  ContentsOption {
  kName =1, kClassName =2, kValue =4, kArgs =8,
  kExtras =16, kAddress =32, kTitle =64, kCollectionHeader =128
}
 
enum  StyleOption {
  kInline =1, kSingleLine =2, kStandard =3, kVerbose =4,
  kTreeStructure =5
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from RooPrintable
static std::ostream & defaultPrintStream (std::ostream *os=0)
 Return a reference to the current default stream to use in Print(). More...
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. More...
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooBinning.h>

+ Inheritance diagram for RooBinning:
+ Collaboration diagram for RooBinning:

Constructor & Destructor Documentation

RooBinning::RooBinning ( Double_t  xlo = -RooNumber::infinity(),
Double_t  xhi = RooNumber::infinity(),
const char *  name = 0 
)

Constructor for an initially empty binning defining the range [xlo,xhi].

Definition at line 51 of file RooBinning.cxx.

Referenced by clone().

RooBinning::RooBinning ( Int_t  nBins,
Double_t  xlo,
Double_t  xhi,
const char *  name = 0 
)

Constructor for a uniform binning in 'nbins' bins in the range [xlo,xhi].

Definition at line 62 of file RooBinning.cxx.

RooBinning::RooBinning ( Int_t  nBins,
const Double_t boundaries,
const char *  name = 0 
)

Constructor for a binning in the range[xlo,xhi] with 'nbins' bin boundaries listed array 'boundaries'.

Definition at line 76 of file RooBinning.cxx.

RooBinning::RooBinning ( const RooBinning other,
const char *  name = 0 
)

Copy constructor.

Definition at line 90 of file RooBinning.cxx.

RooBinning::~RooBinning ( )

Destructor.

Definition at line 101 of file RooBinning.cxx.

Member Function Documentation

Bool_t RooBinning::addBoundary ( Double_t  boundary)

Add bin boundary at given value.

Definition at line 109 of file RooBinning.cxx.

Referenced by addBoundaryPair(), addUniform(), RooBinning(), and setRange().

void RooBinning::addBoundaryPair ( Double_t  boundary,
Double_t  mirrorPoint = 0 
)

Add pair of boundaries: one at 'boundary' and one at 2*mirrorPoint-boundary.

Definition at line 129 of file RooBinning.cxx.

void RooBinning::addUniform ( Int_t  nBins,
Double_t  xlo,
Double_t  xhi 
)

Add array of nbins uniformly sized bins in range [xlo,xhi].

Definition at line 171 of file RooBinning.cxx.

Referenced by RooDataHist::adjustBinning(), and RooBinning().

Double_t * RooBinning::array ( ) const
virtual

Return array of boundary values.

Implements RooAbsBinning.

Definition at line 217 of file RooBinning.cxx.

virtual Double_t RooBinning::averageBinWidth ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 57 of file RooBinning.h.

Referenced by RooDataHist::adjustBinning().

Double_t RooBinning::binCenter ( Int_t  bin) const
virtual

Return the position of the center of bin 'bin'.

Implements RooAbsBinning.

Definition at line 282 of file RooBinning.cxx.

Bool_t RooBinning::binEdges ( Int_t  bin,
Double_t xlo,
Double_t xhi 
) const
protected

Return upper and lower bound of bin 'bin'.

If the return value is true an error occurred

Definition at line 269 of file RooBinning.cxx.

Referenced by binCenter(), binHigh(), binLow(), binWidth(), and nearestBoundary().

Double_t RooBinning::binHigh ( Int_t  bin) const
virtual

Return the upper bound of the requested bin.

Implements RooAbsBinning.

Definition at line 312 of file RooBinning.cxx.

Double_t RooBinning::binLow ( Int_t  bin) const
virtual

Return the lower bound of the requested bin.

Implements RooAbsBinning.

Definition at line 302 of file RooBinning.cxx.

Int_t RooBinning::binNumber ( Double_t  x) const
virtual

Return sequential bin number that contains value x where bin zero is the first bin with an upper boundary above the lower bound of the range.

Implements RooAbsBinning.

Definition at line 184 of file RooBinning.cxx.

Referenced by nearestBoundary().

Double_t RooBinning::binWidth ( Int_t  bin) const
virtual

Return the width of the requested bin.

Implements RooAbsBinning.

Definition at line 292 of file RooBinning.cxx.

RooAbsBinning* RooBinning::clone ( const char *  name = 0) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 36 of file RooBinning.h.

Bool_t RooBinning::hasBoundary ( Double_t  boundary)

Check if boundary exists at given value.

Definition at line 163 of file RooBinning.cxx.

virtual Double_t RooBinning::highBound ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 53 of file RooBinning.h.

Referenced by averageBinWidth().

virtual Double_t RooBinning::lowBound ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 49 of file RooBinning.h.

Referenced by averageBinWidth().

Double_t RooBinning::nearestBoundary ( Double_t  x) const
virtual

Return the value of the nearest boundary to x.

Definition at line 207 of file RooBinning.cxx.

virtual Int_t RooBinning::numBoundaries ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 39 of file RooBinning.h.

Referenced by array().

Int_t RooBinning::rawBinNumber ( Double_t  x) const
virtual

Return sequential bin number that contains value x where bin zero is the first bin that is defined, regardless if that bin is outside the current defined range.

Reimplemented from RooAbsBinning.

Definition at line 194 of file RooBinning.cxx.

Referenced by binNumber(), and updateBinCount().

Bool_t RooBinning::removeBoundary ( Double_t  boundary)

Remove boundary at given value.

Definition at line 138 of file RooBinning.cxx.

Referenced by setRange().

void RooBinning::setRange ( Double_t  xlo,
Double_t  xhi 
)
virtual

Change the defined range associated with this binning.

Bins that lie outside the new range [xlo,xhi] will not be removed, but will be 'inactive', i.e. the new 0 bin will be the first bin with an upper boundarie > xlo

Implements RooAbsBinning.

Definition at line 231 of file RooBinning.cxx.

Referenced by RooBinning().

void RooBinning::updateBinCount ( )
protected

Update the internal bin counter.

Definition at line 251 of file RooBinning.cxx.

Referenced by addBoundary(), removeBoundary(), and setRange().

Member Data Documentation

Double_t* RooBinning::_array
mutableprotected

Definition at line 87 of file RooBinning.h.

Referenced by array(), and ~RooBinning().

Int_t RooBinning::_blo
mutableprotected

Array of boundaries.

Definition at line 88 of file RooBinning.h.

Referenced by array(), binEdges(), binNumber(), and updateBinCount().

std::vector<Double_t> RooBinning::_boundaries
protected
Int_t RooBinning::_nbins
protected

Definition at line 84 of file RooBinning.h.

Referenced by array(), binEdges(), binNumber(), numBoundaries(), and updateBinCount().

Bool_t RooBinning::_ownBoundHi
protected

Definition at line 83 of file RooBinning.h.

Referenced by addBoundary(), and setRange().

Bool_t RooBinning::_ownBoundLo
protected

Definition at line 82 of file RooBinning.h.

Referenced by addBoundary(), and setRange().

Double_t RooBinning::_xhi
protected

Definition at line 81 of file RooBinning.h.

Referenced by addBoundary(), highBound(), removeBoundary(), setRange(), and updateBinCount().

Double_t RooBinning::_xlo
protected

Definition at line 80 of file RooBinning.h.

Referenced by addBoundary(), lowBound(), removeBoundary(), setRange(), and updateBinCount().


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