Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooParamBinning Class Reference

Class RooParamBinning is an implementation of RooAbsBinning that constructs a binning with a range definition that depends on external RooAbsReal objects.

The external RooAbsReal definitions are explicitly allowed to depend on other observables and parameters, and make it possible to define non-rectangular range definitions in RooFit. Objects of class RooParamBinning are made by the RooRealVar::setRange() that takes RooAbsReal references as arguments

Definition at line 25 of file RooParamBinning.h.

Public Member Functions

 RooParamBinning (const char *name=0)
 Default constructor cout << "RooParamBinning(" << this << ") default ctor" << endl ;.
 
 RooParamBinning (const RooParamBinning &other, const char *name=0)
 Copy constructor cout << "RooParamBinning::cctor(" << this << ") orig = " << &other << endl ;.
 
 RooParamBinning (RooAbsReal &xlo, RooAbsReal &xhi, Int_t nBins, const char *name=0)
 Construct binning with 'nBins' bins and with a range parameterized by external RooAbsReals xloIn and xhiIn.
 
virtual ~RooParamBinning ()
 Destructor.
 
virtual Double_tarray () const
 Return array of bin boundaries.
 
virtual Double_t averageBinWidth () const
 
virtual Double_t binCenter (Int_t bin) const
 Return the central value of the 'i'-th fit bin.
 
virtual Double_t binHigh (Int_t bin) const
 Return the high edge of the 'i'-th fit bin.
 
virtual Double_t binLow (Int_t bin) const
 Return the low edge of the 'i'-th fit bin.
 
virtual Int_t binNumber (Double_t x) const
 Return the fit bin index for the current value.
 
virtual Double_t binWidth (Int_t bin) const
 Return average bin width.
 
RooAbsBinningclone (const char *name=0) const
 
virtual Double_t highBound () const
 
virtual RooAbsRealhighBoundFunc () const
 Return pointer to RooAbsReal parameterized upper bound, if any.
 
virtual void insertHook (RooAbsRealLValue &) const
 Hook function called by RooAbsRealLValue when this binning is inserted as binning for into given owner.
 
virtual Bool_t isParameterized () const
 Interface function.
 
virtual Bool_t isShareable () const
 If true (default), the range definition can be shared across clones of a RooRealVar.
 
virtual Double_t lowBound () const
 
virtual RooAbsReallowBoundFunc () const
 Return pointer to RooAbsReal parameterized lower bound, if any.
 
virtual Int_t numBoundaries () const
 
void printMultiline (std::ostream &os, Int_t content, Bool_t verbose=kFALSE, TString indent="") const
 Print details of binning.
 
virtual void removeHook (RooAbsRealLValue &) const
 Hook function called by RooAbsRealLValue when this binning is removed as binning for into given owner.
 
virtual void setRange (Double_t xlo, Double_t xhi)
 Adjust range by adjusting values of external RooAbsReal values Only functional when external representations are lvalues.
 
- Public Member Functions inherited from RooAbsBinning
 RooAbsBinning (const char *name=0)
 Constructor.
 
 RooAbsBinning (const RooAbsBinning &other, const char *name=0)
 
virtual ~RooAbsBinning ()
 Destructor.
 
virtual TObjectClone (const char *newname=0) const
 Make a clone of an object using the Streamer facility.
 
virtual Bool_t isUniform () const
 
Int_t numBins () const
 Return number of bins.
 
virtual void Print (Option_t *options=0) const
 Print TNamed name and title.
 
virtual void printArgs (std::ostream &os) const
 Print binning arguments (the RooAbsReal objects represening the variable bin boundaries for parameterized binning implementations.
 
virtual void printClassName (std::ostream &os) const
 Print binning class name.
 
virtual void printName (std::ostream &os) const
 Print binning name.
 
virtual void printTitle (std::ostream &os) const
 Print binning title.
 
virtual void printValue (std::ostream &os) const
 Print binning value, i.e the bin boundary positions.
 
virtual Int_t rawBinNumber (Double_t x) const
 
virtual void setMax (Double_t xhi)
 Change upper bound to xhi.
 
virtual void setMin (Double_t xlo)
 Change lower bound to xlo.
 
- 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 Int_t Compare (const TObject *obj) const
 Compare two TNamed objects.
 
virtual void Copy (TObject &named) const
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual const char * GetTitle () const
 Returns title 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.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
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 Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
 
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 ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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 [].
 
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.
 
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 SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
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 RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Default choice of contents to be printed (name and value)
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 
virtual void printAddress (std::ostream &os) const
 Print class name of object.
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object.
 
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'.
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object.
 

Protected Member Functions

RooAbsRealxhi () const
 
RooAbsRealxlo () const
 
- 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

Double_t_array
 
Double_t _binw
 
RooListProxy_lp
 
Int_t _nbins
 
RooAbsArg_owner
 
RooAbsReal_xhi
 
RooAbsReal_xlo
 do not persist
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

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)
}
 
- 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.
 
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 RooPrintable
static std::ostream & defaultPrintStream (std::ostream *os=0)
 Return a reference to the current default stream to use in Print().
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooParamBinning.h>

Inheritance diagram for RooParamBinning:
[legend]

Constructor & Destructor Documentation

◆ RooParamBinning() [1/3]

RooParamBinning::RooParamBinning ( const char *  name = 0)

Default constructor cout << "RooParamBinning(" << this << ") default ctor" << endl ;.

Definition at line 48 of file RooParamBinning.cxx.

◆ RooParamBinning() [2/3]

RooParamBinning::RooParamBinning ( RooAbsReal xlo,
RooAbsReal xhi,
Int_t  nBins,
const char *  name = 0 
)

Construct binning with 'nBins' bins and with a range parameterized by external RooAbsReals xloIn and xhiIn.

Definition at line 59 of file RooParamBinning.cxx.

◆ RooParamBinning() [3/3]

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

Copy constructor cout << "RooParamBinning::cctor(" << this << ") orig = " << &other << endl ;.

Definition at line 88 of file RooParamBinning.cxx.

◆ ~RooParamBinning()

RooParamBinning::~RooParamBinning ( )
virtual

Destructor.

Definition at line 76 of file RooParamBinning.cxx.

Member Function Documentation

◆ array()

Double_t * RooParamBinning::array ( ) const
virtual

Return array of bin boundaries.

Implements RooAbsBinning.

Definition at line 269 of file RooParamBinning.cxx.

◆ averageBinWidth()

virtual Double_t RooParamBinning::averageBinWidth ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 47 of file RooParamBinning.h.

◆ binCenter()

Double_t RooParamBinning::binCenter ( Int_t  bin) const
virtual

Return the central value of the 'i'-th fit bin.

Implements RooAbsBinning.

Definition at line 210 of file RooParamBinning.cxx.

◆ binHigh()

Double_t RooParamBinning::binHigh ( Int_t  bin) const
virtual

Return the high edge of the 'i'-th fit bin.

Implements RooAbsBinning.

Definition at line 253 of file RooParamBinning.cxx.

◆ binLow()

Double_t RooParamBinning::binLow ( Int_t  bin) const
virtual

Return the low edge of the 'i'-th fit bin.

Implements RooAbsBinning.

Definition at line 237 of file RooParamBinning.cxx.

◆ binNumber()

Int_t RooParamBinning::binNumber ( Double_t  x) const
virtual

Return the fit bin index for the current value.

Implements RooAbsBinning.

Definition at line 197 of file RooParamBinning.cxx.

◆ binWidth()

Double_t RooParamBinning::binWidth ( Int_t  bin) const
virtual

Return average bin width.

Implements RooAbsBinning.

Definition at line 227 of file RooParamBinning.cxx.

◆ clone()

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

Implements RooAbsBinning.

Definition at line 31 of file RooParamBinning.h.

◆ highBound()

virtual Double_t RooParamBinning::highBound ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 40 of file RooParamBinning.h.

◆ highBoundFunc()

virtual RooAbsReal * RooParamBinning::highBoundFunc ( ) const
inlinevirtual

Return pointer to RooAbsReal parameterized upper bound, if any.

Reimplemented from RooAbsBinning.

Definition at line 58 of file RooParamBinning.h.

◆ insertHook()

void RooParamBinning::insertHook ( RooAbsRealLValue owner) const
virtual

Hook function called by RooAbsRealLValue when this binning is inserted as binning for into given owner.

Create list proxy registered with owner that will track and implement server directs to external RooAbsReals of this binning

Reimplemented from RooAbsBinning.

Definition at line 120 of file RooParamBinning.cxx.

◆ isParameterized()

virtual Bool_t RooParamBinning::isParameterized ( ) const
inlinevirtual

Interface function.

If true, min/max of binning is parameterized by external RooAbsReals. Default to false, unless overridden by a sub class.

Reimplemented from RooAbsBinning.

Definition at line 56 of file RooParamBinning.h.

◆ isShareable()

virtual Bool_t RooParamBinning::isShareable ( ) const
inlinevirtual

If true (default), the range definition can be shared across clones of a RooRealVar.

Reimplemented from RooAbsBinning.

Definition at line 55 of file RooParamBinning.h.

◆ lowBound()

virtual Double_t RooParamBinning::lowBound ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 39 of file RooParamBinning.h.

◆ lowBoundFunc()

virtual RooAbsReal * RooParamBinning::lowBoundFunc ( ) const
inlinevirtual

Return pointer to RooAbsReal parameterized lower bound, if any.

Reimplemented from RooAbsBinning.

Definition at line 57 of file RooParamBinning.h.

◆ numBoundaries()

virtual Int_t RooParamBinning::numBoundaries ( ) const
inlinevirtual

Implements RooAbsBinning.

Definition at line 36 of file RooParamBinning.h.

◆ printMultiline()

void RooParamBinning::printMultiline ( std::ostream &  os,
Int_t  content,
Bool_t  verbose = kFALSE,
TString  indent = "" 
) const
virtual

Print details of binning.

Reimplemented from RooPrintable.

Definition at line 286 of file RooParamBinning.cxx.

◆ removeHook()

void RooParamBinning::removeHook ( RooAbsRealLValue ) const
virtual

Hook function called by RooAbsRealLValue when this binning is removed as binning for into given owner.

Delete list proxy that was inserted in owner

Reimplemented from RooAbsBinning.

Definition at line 150 of file RooParamBinning.cxx.

◆ setRange()

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

Adjust range by adjusting values of external RooAbsReal values Only functional when external representations are lvalues.

Implements RooAbsBinning.

Definition at line 169 of file RooParamBinning.cxx.

◆ xhi()

RooAbsReal * RooParamBinning::xhi ( ) const
inlineprotected

Definition at line 71 of file RooParamBinning.h.

◆ xlo()

RooAbsReal * RooParamBinning::xlo ( ) const
inlineprotected

Definition at line 70 of file RooParamBinning.h.

Member Data Documentation

◆ _array

Double_t* RooParamBinning::_array
mutableprotected

Definition at line 62 of file RooParamBinning.h.

◆ _binw

Double_t RooParamBinning::_binw
protected

Definition at line 66 of file RooParamBinning.h.

◆ _lp

RooListProxy* RooParamBinning::_lp
mutableprotected

Definition at line 67 of file RooParamBinning.h.

◆ _nbins

Int_t RooParamBinning::_nbins
protected

Definition at line 65 of file RooParamBinning.h.

◆ _owner

RooAbsArg* RooParamBinning::_owner
mutableprotected

Definition at line 68 of file RooParamBinning.h.

◆ _xhi

RooAbsReal* RooParamBinning::_xhi
mutableprotected

Definition at line 64 of file RooParamBinning.h.

◆ _xlo

RooAbsReal* RooParamBinning::_xlo
mutableprotected

do not persist

Definition at line 63 of file RooParamBinning.h.

Libraries for RooParamBinning:

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