PdfProposal is a concrete implementation of the ProposalFunction interface.
It proposes points across the parameter space in the distribution of the given PDF.
To make Propose(xPrime, x) dependent on x, configure with PdfProposal::AddMapping(varToUpdate, valueToUse). For example, suppose we have:
PdfProposal currently uses a fixed cache size. Adaptive caching methods are in the works for future versions.
Definition at line 30 of file PdfProposal.h.
Public Member Functions | |
PdfProposal () | |
By default, PdfProposal does NOT own the PDF that serves as the proposal density function. | |
PdfProposal (RooAbsPdf &pdf) | |
By default, PdfProposal does NOT own the PDF that serves as the proposal density function. | |
~PdfProposal () override | |
virtual void | AddMapping (RooRealVar &proposalParam, RooAbsReal &update) |
specify a mapping between a parameter of the proposal function and a parameter of interest. | |
virtual const RooAbsPdf * | GetPdf () const |
Get the PDF is the proposal density function. | |
double | GetProposalDensity (RooArgSet &x1, RooArgSet &x2) override |
Return the probability of proposing the point x1 given the starting point x2. | |
TClass * | IsA () const override |
bool | IsSymmetric (RooArgSet &x1, RooArgSet &x2) override |
Determine whether or not the proposal density is symmetric for points x1 and x2 - that is, whether the probability of reaching x2 from x1 is equal to the probability of reaching x1 from x2. | |
virtual void | printMappings () |
void | Propose (RooArgSet &xPrime, RooArgSet &x) override |
Populate xPrime with a new proposed point. | |
virtual void | Reset () |
virtual void | SetCacheSize (Int_t size) |
Set how many points to generate each time we propose from a new point Default (and minimum) is 1. | |
virtual void | SetOwnsPdf (bool ownsPdf) |
set whether we own the PDF that serves as the proposal density function By default, when constructed, PdfProposal does NOT own the PDF. | |
virtual void | SetPdf (RooAbsPdf &pdf) |
Set the PDF to be the proposal density function. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from RooStats::ProposalFunction | |
ProposalFunction () | |
Default constructor. | |
virtual bool | CheckParameters (RooArgSet ¶ms) |
Check the parameters for which the ProposalFunction will propose values to make sure they are all RooRealVars Return true if all objects are RooRealVars, false otherwise. | |
TClass * | IsA () const override |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
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 | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. | |
virtual void | Copy (TObject &object) const |
Copy this to obj. | |
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 with: gROOT->SetSelectedPad(c1) . | |
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=nullptr) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
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 const char * | GetName () const |
Returns 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 const char * | GetTitle () const |
Returns title of object. | |
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. | |
virtual ULong_t | Hash () const |
Return hash value for this object. | |
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 |
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. | |
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 (the base implementation is no-op). | |
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, void *vp) |
Only called by placement new when throwing an exception. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void | operator delete[] (void *ptr, void *vp) |
Only called by placement new[] when throwing an exception. | |
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 void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. | |
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. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
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=nullptr, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
Interface for tools setting limits (producing confidence intervals) | |
static const char * | DeclFileName () |
Static Public Member Functions inherited from RooStats::ProposalFunction | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
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 Member Functions | |
virtual bool | Equals (RooArgSet &x1, RooArgSet &x2) |
whether we own the proposal density function | |
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 | |
std::unique_ptr< RooDataSet > | fCache |
our position in the cached proposal data set | |
Int_t | fCachePosition |
how many points to generate each time | |
Int_t | fCacheSize |
the last point we were at | |
std::map< RooRealVar *, RooAbsReal * >::iterator | fIt |
map of values in pdf to update | |
RooArgSet | fLastX |
pdf iterator | |
std::map< RooRealVar *, RooAbsReal * > | fMap |
the proposal density function | |
RooArgSet | fMaster |
the cached proposal data set | |
bool | fOwnsPdf |
pointers to master variables needed for updates | |
RooAbsPdf * | fPdf |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
#include <RooStats/PdfProposal.h>
PdfProposal::PdfProposal | ( | ) |
By default, PdfProposal does NOT own the PDF that serves as the proposal density function.
Definition at line 74 of file PdfProposal.cxx.
PdfProposal::PdfProposal | ( | RooAbsPdf & | ) |
By default, PdfProposal does NOT own the PDF that serves as the proposal density function.
Definition at line 86 of file PdfProposal.cxx.
|
inlineoverride |
Definition at line 95 of file PdfProposal.h.
|
virtual |
specify a mapping between a parameter of the proposal function and a parameter of interest.
this mapping is used to set the value of proposalParam equal to the value of update to determine the proposal function. proposalParam is a parameter of the proposal function that must be set to the value of update (from the current point) in order to propose a new point.
Definition at line 191 of file PdfProposal.cxx.
|
static |
|
inlinestaticconstexpr |
Interface for tools setting limits (producing confidence intervals)
Definition at line 117 of file PdfProposal.h.
|
inlinestatic |
Definition at line 117 of file PdfProposal.h.
whether we own the proposal density function
determine whether these two RooArgSets represent the same point
Definition at line 97 of file PdfProposal.cxx.
|
inlinevirtual |
Get the PDF is the proposal density function.
Definition at line 52 of file PdfProposal.h.
Return the probability of proposing the point x1 given the starting point x2.
Implements RooStats::ProposalFunction.
Definition at line 172 of file PdfProposal.cxx.
|
inlineoverridevirtual |
Reimplemented from TObject.
Definition at line 117 of file PdfProposal.h.
Determine whether or not the proposal density is symmetric for points x1 and x2 - that is, whether the probability of reaching x2 from x1 is equal to the probability of reaching x1 from x2.
Determine whether or not the proposal density is symmetric for points x1 and x2 - that is, whether the propabilty of reaching x2 from x1 is equal to the probability of reaching x1 from x2.
Implements RooStats::ProposalFunction.
Definition at line 162 of file PdfProposal.cxx.
|
inlinevirtual |
Definition at line 70 of file PdfProposal.h.
Populate xPrime with a new proposed point.
Implements RooStats::ProposalFunction.
Definition at line 112 of file PdfProposal.cxx.
|
inlinevirtual |
Definition at line 63 of file PdfProposal.h.
|
inlinevirtual |
Set how many points to generate each time we propose from a new point Default (and minimum) is 1.
Definition at line 79 of file PdfProposal.h.
|
inlinevirtual |
set whether we own the PDF that serves as the proposal density function By default, when constructed, PdfProposal does NOT own the PDF.
Definition at line 90 of file PdfProposal.h.
|
inlinevirtual |
Set the PDF to be the proposal density function.
Definition at line 49 of file PdfProposal.h.
|
overridevirtual |
|
inline |
Definition at line 117 of file PdfProposal.h.
|
protected |
our position in the cached proposal data set
Definition at line 108 of file PdfProposal.h.
|
protected |
how many points to generate each time
Definition at line 107 of file PdfProposal.h.
|
protected |
the last point we were at
Definition at line 106 of file PdfProposal.h.
|
protected |
map of values in pdf to update
Definition at line 104 of file PdfProposal.h.
|
protected |
pdf iterator
Definition at line 105 of file PdfProposal.h.
|
protected |
the proposal density function
Definition at line 103 of file PdfProposal.h.
|
protected |
the cached proposal data set
Definition at line 109 of file PdfProposal.h.
|
protected |
pointers to master variables needed for updates
Definition at line 110 of file PdfProposal.h.
|
protected |
Definition at line 102 of file PdfProposal.h.