A RooTemplateProxy is used to hold references to other RooFit objects in an expression tree. A RooGaussian(..., x, mean, sigma)
can e.g. store references to x, mean, sigma
as
Now, the values of these three can be accessed, and the template argument ensures that only objects that evaluate to real numbers (RooAbsReal) can be stored in such a proxy. These can e.g. be variables, PDFs and functions. To store an object that's a RooCategory
, one would, for example, use
Since ROOT 6.22, the proxy can be used like a pointer to an instance of the template argument. For this, it provides operator*
and operator->
, e.g.
RooTemplateProxy's base class RooArgProxy registers the proxied objects as "servers" of the object that holds the proxy. When the value of the proxied object is changed, the owner is notified, and can recalculate its own value. Renaming or exchanging objects that serve values to the owner of the proxy is handled automatically.
In ROOT 6.22, the classes RooRealProxy and RooCategoryProxy were replaced by RooTemplateProxy<class T>.
Two typedefs have been defined for backward compatibility:
RooRealProxy = RooTemplateProxy<RooAbsReal>
. Any generic object that converts to a real value.RooCategoryProxy = RooTemplateProxy<RooAbsCategory>
. Any category object.To modernise a class, one can change the template argument of the proxy to the most appropriate type, and increment the class version of the owner.
RooFit before ROOT 6.22 | RooFit starting with ROOT 6.22 |
---|---|
// In .h: Declare member
RooRealProxy pdfProxy;
ClassDef(MyPdf, 1)
};
// In .cxx: Initialise proxy in constructor
// The proxy will accept any RooAbsArg, so the type of
// "thePdf" has to be checked manually.
MyPdf::MyPdf(name, title, ...) :
pdfProxy("pdfProxy", "Proxy holding a PDF", this, thePdf) {
[ Extra checking here ... ]
}
// In .cxx: Accessing the proxy
assert(pdf); // Manual type checking ...
pdf->fitTo(...);
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi... Definition RooAbsArg.h:69 Definition RooAbsPdf.h:43 virtual RooFitResult * fitTo(RooAbsData &data, const RooCmdArg &arg1=RooCmdArg::none(), const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none(), const RooCmdArg &arg7=RooCmdArg::none(), const RooCmdArg &arg8=RooCmdArg::none()) Fit PDF to given dataset. Definition RooAbsPdf.cxx:1465 | // In .h: Declare member
RooTemplateProxy<RooAbsPdf> pdfProxy;
ClassDef(MyPdf, 2)
};
// In .cxx: Initialise proxy in constructor
// The program will not compile if "thePdf" is not a
// type deriving from RooAbsPdf
MyPdf::MyPdf(name, title, ...) :
pdfProxy("pdfProxy", "Proxy holding a PDF", this, thePdf) {
}
// In .cxx: Accessing the proxy
pdfProxy->fitTo(...);
|
RooTemplateProxy<RooAbsPdf>
.RooTemplateProxy<RooAbsReal>
.RooTemplateProxy<RooCategory>
.RooTemplateProxy<RooRealVar>
Other template arguments are possible, as long as they derive from RooAbsArg.proxy->
and *proxy
to work with the stored object. No need to cast.Only if necessary If errors about missing symbols connected to RooTemplateProxy appear at link time, a specific template instantiation for RooTemplateProxy is not yet in ROOT's dictionaries. These two lines should be added to the LinkDef.h of the project:
Replace RooMultiCategory
by the proper type. If the proxy was holding a real-valued object, use sourceClass="RooRealProxy"
.
The first line adds the proxy class to the dictionary, the second line enables reading a legacy RooCategoryProxy
from a file, and converting it to the new type-safe proxy. If no old proxies have to be read from files, this line can be omitted.
If the template instantiation that triggered the missing symbols seems to be a very common instantiation, request for it to be added to RooFit by creating a pull request for ROOT. If it is rather uncommon, it is sufficient to add it to the LinkDef.h of the local project only.
Definition at line 149 of file RooTemplateProxy.h.
Public Member Functions | |
RooTemplateProxy () | |
RooTemplateProxy (const char *theName, const char *desc, RooAbsArg *owner, Bool_t valueServer=true, Bool_t shapeServer=false, Bool_t proxyOwnsArg=false) | |
Constructor with owner. | |
RooTemplateProxy (const char *theName, const char *desc, RooAbsArg *owner, T &ref, Bool_t valueServer=true, Bool_t shapeServer=false, Bool_t proxyOwnsArg=false) | |
Constructor with owner and proxied object. | |
template<typename U > | |
RooTemplateProxy (const char *theName, RooAbsArg *owner, const RooTemplateProxy< U > &other, bool allowWrongTypes=false) | |
Copy from an existing proxy. | |
virtual TObject * | Clone (const char *newName=0) const |
Make a clone of an object using the Streamer facility. | |
template<class U , class... ConstructorArgs> | |
U & | emplaceOwnedArg (ConstructorArgs &&... constructorArgs) |
Create a new object held and owned by proxy. | |
operator typename T::value_type () const | |
Convert the proxy into a number. | |
T & | operator* () const |
Return reference to the proxied object. | |
T * | operator-> () const |
Member access operator to proxied object. | |
template<class U > | |
U & | putOwnedArg (std::unique_ptr< U > ownedArg) |
Move a new object held and owned by proxy. | |
bool | setArg (T &newRef) |
Change object held in proxy into newRef. | |
Legacy interface | |
In ROOT versions before 6.22, RooFit didn't have this typed proxy. Therefore, a number of functions for forwarding calls to the proxied objects were necessary. The functions in this group can all be replaced by directly accessing the proxied objects using e.g. the member access operator like | |
const char * | label () const |
Get the label of the current category state. This function only makes sense for category proxies. | |
bool | hasRange (const char *rangeName) const |
Check if the stored object has a range with the given name. | |
const T & | arg () const |
Return reference to object held in proxy. | |
RooTemplateProxy< T > & | operator= (typename T::value_type value) |
Assign a new value to the object pointed to by the proxy. | |
RooTemplateProxy< T > & | operator= (const std::string &newState) |
Set a category state using its state name. This function can only work for category-type proxies. | |
double | min (const char *rname=0) const |
Query lower limit of range. This requires the payload to be RooAbsRealLValue or derived. | |
double | max (const char *rname=0) const |
Query upper limit of range. This requires the payload to be RooAbsRealLValue or derived. | |
bool | hasMin (const char *rname=0) const |
Check if the range has a lower bound. This requires the payload to be RooAbsRealLValue or derived. | |
bool | hasMax (const char *rname=0) const |
Check if the range has a upper bound. This requires the payload to be RooAbsRealLValue or derived. | |
Public Member Functions inherited from RooArgProxy | |
RooArgProxy () | |
RooArgProxy (const char *name, const char *desc, RooAbsArg *owner, Bool_t valueServer, Bool_t shapeServer, Bool_t proxyOwnsArg=kFALSE) | |
Constructor with owner and proxied variable. | |
RooArgProxy (const char *name, const char *desc, RooAbsArg *owner, RooAbsArg &arg, Bool_t valueServer, Bool_t shapeServer, Bool_t proxyOwnsArg=kFALSE) | |
Constructor with owner and proxied variable. | |
RooArgProxy (const char *name, RooAbsArg *owner, const RooArgProxy &other) | |
Copy constructor. | |
virtual | ~RooArgProxy () |
Destructor. | |
RooAbsArg * | absArg () const |
Bool_t | isShapeServer () const |
Bool_t | isValueServer () const |
virtual const char * | name () const |
RooAbsArg * | owner () const |
Returns the owner of this proxy. | |
virtual void | print (std::ostream &os, Bool_t addContents=kFALSE) const |
Print the name of the proxy on ostream. | |
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. | |
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 | 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 TObject * | DrawClone (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 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) |
Bool_t | IsDestructed () const |
IsDestructed. | |
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 | 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 RooAbsProxy | |
RooAbsProxy () | |
Constructor. | |
RooAbsProxy (const char *name, const RooAbsProxy &other) | |
Copy constructor. | |
virtual | ~RooAbsProxy () |
const RooArgSet * | nset () const |
Private Types | |
using | LValue_t = typename std::conditional< std::is_base_of< RooAbsReal, T >::value, RooAbsRealLValue, RooAbsCategoryLValue >::type |
Are we a real-valued proxy or a category proxy? | |
Private Member Functions | |
const LValue_t * | lvptr (const LValue_t *) const |
Return l-value pointer to contents. | |
const LValue_t * | lvptr (const RooAbsArg *) const |
Return l-value pointer to contents. | |
LValue_t * | lvptr (LValue_t *) |
Return l-value pointer to contents. | |
LValue_t * | lvptr (RooAbsArg *) |
Return l-value pointer to contents. | |
T::value_type | retrieveValue (const RooAbsCategory &cat) const |
Retrieve index state from a category. | |
T::value_type | retrieveValue (const RooAbsReal &real) const |
Retrieve value from a real-valued object. | |
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 Longptr_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 RooArgProxy | |
virtual void | changeDataSet (const RooArgSet *newNormSet) |
Change the normalization set that should be offered to the content objects getVal() when evaluated. | |
virtual Bool_t | changePointer (const RooAbsCollection &newServerSet, Bool_t nameChange=kFALSE, Bool_t factoryInitMode=kFALSE) |
Change proxied object to object of same name in given list. | |
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 Member Functions inherited from RooAbsProxy | |
virtual void | changeNormSet (const RooArgSet *newNormSet) |
Destructor. | |
Protected Attributes inherited from RooArgProxy | |
RooAbsArg * | _arg |
Bool_t | _isFund |
Bool_t | _ownArg |
RooAbsArg * | _owner |
Bool_t | _shapeServer |
Bool_t | _valueServer |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Protected Attributes inherited from RooAbsProxy | |
RooArgSet * | _nset = nullptr |
! Normalization set to be used for evaluation of RooAbsPdf contents | |
#include <RooTemplateProxy.h>
|
private |
Are we a real-valued proxy or a category proxy?
Definition at line 319 of file RooTemplateProxy.h.
|
inline |
Definition at line 152 of file RooTemplateProxy.h.
|
inline |
Constructor with owner.
[in] | theName | Name of this proxy (for printing). |
[in] | desc | Description what this proxy should act as. |
[in] | owner | The object that owns the proxy. This is important for tracking of client-server dependencies. |
[in] | valueServer | Notify the owner if value changes. |
[in] | shapeServer | Notify the owner if shape (e.g. binning) changes. |
[in] | proxyOwnsArg | Proxy will delete the payload if owning. |
Definition at line 163 of file RooTemplateProxy.h.
|
inline |
Constructor with owner and proxied object.
[in] | theName | Name of this proxy (for printing). |
[in] | desc | Description what this proxy should act as. |
[in] | owner | The object that owns the proxy. This is important for tracking of client-server dependencies. |
[in] | ref | Reference to the object that the proxy should hold. |
[in] | valueServer | Notify the owner if value changes. |
[in] | shapeServer | Notify the owner if shape (e.g. binning) changes. |
[in] | proxyOwnsArg | Proxy will delete the payload if owning. |
Definition at line 177 of file RooTemplateProxy.h.
|
inline |
Copy from an existing proxy.
It will accept any RooTemplateProxy instance, and attempt a dynamic_cast on its payload.
[in] | theName | Name of this proxy. |
[in] | owner | Pointer to the owner this proxy should be registered to. |
[in] | other | Instance of a differen proxy whose payload should be copied. |
[in] | allowWrongTypes | Instead of throwing a std::invalid_argument, only issue an error message when payload with wrong type is found. This is unsafe, but may be necessary when reading back legacy types. Defaults to false. |
std::invalid_argument | if the types of the payloads are incompatible. |
Definition at line 193 of file RooTemplateProxy.h.
|
inline |
Return reference to object held in proxy.
Definition at line 290 of file RooTemplateProxy.h.
|
inlinevirtual |
Make a clone of an object using the Streamer facility.
If newname is specified, this will be the name of the new object.
Reimplemented from TNamed.
Definition at line 204 of file RooTemplateProxy.h.
|
inline |
Create a new object held and owned by proxy.
Can only be done if the proxy was non-owning before.
Definition at line 243 of file RooTemplateProxy.h.
|
inline |
Check if the range has a upper bound. This requires the payload to be RooAbsRealLValue or derived.
Definition at line 312 of file RooTemplateProxy.h.
|
inline |
Check if the range has a lower bound. This requires the payload to be RooAbsRealLValue or derived.
Definition at line 310 of file RooTemplateProxy.h.
|
inline |
Check if the stored object has a range with the given name.
Definition at line 285 of file RooTemplateProxy.h.
|
inline |
Get the label of the current category state. This function only makes sense for category proxies.
Definition at line 280 of file RooTemplateProxy.h.
|
inlineprivate |
Return l-value pointer to contents.
If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then
Definition at line 331 of file RooTemplateProxy.h.
|
inlineprivate |
Return l-value pointer to contents.
If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then
Definition at line 339 of file RooTemplateProxy.h.
|
inlineprivate |
Return l-value pointer to contents.
If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then
Definition at line 335 of file RooTemplateProxy.h.
|
inlineprivate |
Return l-value pointer to contents.
If the contents derive from RooAbsLValue or RooAbsCategoryLValue, the conversion is safe, and the function directly returns the pointer using a static_cast. If the template parameter of this proxy is not an LValue type, then
Definition at line 350 of file RooTemplateProxy.h.
|
inline |
Query upper limit of range. This requires the payload to be RooAbsRealLValue or derived.
Definition at line 308 of file RooTemplateProxy.h.
|
inline |
Query lower limit of range. This requires the payload to be RooAbsRealLValue or derived.
Definition at line 306 of file RooTemplateProxy.h.
|
inline |
Convert the proxy into a number.
Definition at line 220 of file RooTemplateProxy.h.
|
inline |
Return reference to the proxied object.
Definition at line 208 of file RooTemplateProxy.h.
|
inline |
Member access operator to proxied object.
Definition at line 213 of file RooTemplateProxy.h.
|
inline |
Set a category state using its state name. This function can only work for category-type proxies.
Definition at line 299 of file RooTemplateProxy.h.
|
inline |
Assign a new value to the object pointed to by the proxy.
This requires the payload to be assignable (RooAbsRealLValue or derived, RooAbsCategoryLValue).
Definition at line 294 of file RooTemplateProxy.h.
|
inline |
Move a new object held and owned by proxy.
Can only be done if the proxy was non-owning before.
Definition at line 259 of file RooTemplateProxy.h.
|
inlineprivate |
Retrieve index state from a category.
Definition at line 363 of file RooTemplateProxy.h.
|
inlineprivate |
Retrieve value from a real-valued object.
Definition at line 368 of file RooTemplateProxy.h.
|
inline |
Change object held in proxy into newRef.
Definition at line 227 of file RooTemplateProxy.h.