ROOT  6.07/01
Reference Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RooStats::PdfProposal Class Reference

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:

````{.cpp} our parameter RooRealVar p("p", "p", 5, 0, 10);

create mean and sigma for gaussian proposal function RooRealVar meanP("meanP", "meanP", 0, 10); RooRealVar sigma("sigma", "sigma", 1, 0, 5); RooGaussian pGaussian("pGaussian", "pGaussian", p, meanP, sigma);

configure proposal function PdfProposal pdfProposal(pGaussian); pdfProposal.AddMapping(meanP, p); // each call of Propose(xPrime, x), meanP in the proposal function will be updated to the value of p in x. this will center the proposal function about x's p when proposing for xPrime

To improve performance, PdfProposal has the ability to cache a specified number of proposals. If you don't call this function, the default cache size is 1, which can be slow. pdfProposal.SetCacheSize(desiredCacheSize); ````

PdfProposal currently uses a fixed cache size. Adaptive caching methods are in the works for future versions.

Definition at line 85 of file PdfProposal.h.

Public Member Functions

 PdfProposal ()
 
 PdfProposal (RooAbsPdf &pdf)
 
virtual void Propose (RooArgSet &xPrime, RooArgSet &x)
 Populate xPrime with a new proposed point. More...
 
virtual Bool_t IsSymmetric (RooArgSet &x1, RooArgSet &x2)
 Determine whether or not the proposal density is symmetric for points x1 and x2 - that is, whether the probabilty of reaching x2 from x1 is equal to the probability of reaching x1 from x2. More...
 
virtual Double_t GetProposalDensity (RooArgSet &x1, RooArgSet &x2)
 Return the probability of proposing the point x1 given the starting point x2. More...
 
virtual void SetPdf (RooAbsPdf &pdf)
 Set the PDF to be the proposal density function. More...
 
virtual const RooAbsPdfGetPdf () const
 Get the PDF is the proposal density function. More...
 
virtual void AddMapping (RooRealVar &proposalParam, RooAbsReal &update)
 specify a mapping between a parameter of the proposal function and a parameter of interest. More...
 
virtual void Reset ()
 
virtual void printMappings ()
 
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. More...
 
virtual void SetOwnsPdf (Bool_t ownsPdf)
 set whether we own the PDF that serves as the proposal density function By default, when constructed, PdfProposal does NOT own the PDF. More...
 
virtual ~PdfProposal ()
 
- Public Member Functions inherited from RooStats::ProposalFunction
 ProposalFunction ()
 Default constructor. More...
 
virtual ~ProposalFunction ()
 
virtual bool CheckParameters (RooArgSet &params)
 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. 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 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 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 * GetName () const
 Returns name of object. 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 const char * GetTitle () const
 Returns title of object. 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...
 
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...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. 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...
 

Protected Member Functions

virtual Bool_t Equals (RooArgSet &x1, RooArgSet &x2)
 whether we own the proposal density function 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

RooAbsPdffPdf
 
std::map< RooRealVar
*, RooAbsReal * > 
fMap
 the proposal density function More...
 
std::map< RooRealVar
*, RooAbsReal * >::iterator 
fIt
 map of values in pdf to update More...
 
RooArgSet fLastX
 pdf iterator More...
 
Int_t fCacheSize
 the last point we were at More...
 
Int_t fCachePosition
 how many points to generate each time More...
 
RooDataSetfCache
 our position in the cached proposal data set More...
 
RooArgSet fMaster
 the cached proposal data set More...
 
Bool_t fOwnsPdf
 pointers to master variables needed for updates More...
 

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) }
 
- 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...
 

#include <RooStats/PdfProposal.h>

Inheritance diagram for RooStats::PdfProposal:
[legend]

Constructor & Destructor Documentation

PdfProposal::PdfProposal ( )

Definition at line 55 of file PdfProposal.cxx.

PdfProposal::PdfProposal ( RooAbsPdf pdf)

Definition at line 66 of file PdfProposal.cxx.

virtual RooStats::PdfProposal::~PdfProposal ( )
inlinevirtual

Definition at line 151 of file PdfProposal.h.

Member Function Documentation

void PdfProposal::AddMapping ( RooRealVar proposalParam,
RooAbsReal update 
)
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 160 of file PdfProposal.cxx.

Bool_t PdfProposal::Equals ( RooArgSet x1,
RooArgSet x2 
)
protectedvirtual

whether we own the proposal density function

determine whether these two RooArgSets represent the same point

Definition at line 75 of file PdfProposal.cxx.

Referenced by Propose().

virtual const RooAbsPdf* RooStats::PdfProposal::GetPdf ( ) const
inlinevirtual

Get the PDF is the proposal density function.

Definition at line 107 of file PdfProposal.h.

Double_t PdfProposal::GetProposalDensity ( RooArgSet x1,
RooArgSet x2 
)
virtual

Return the probability of proposing the point x1 given the starting point x2.

Implements RooStats::ProposalFunction.

Definition at line 149 of file PdfProposal.cxx.

Bool_t PdfProposal::IsSymmetric ( RooArgSet x1,
RooArgSet x2 
)
virtual

Determine whether or not the proposal density is symmetric for points x1 and x2 - that is, whether the probabilty of reaching x2 from x1 is equal to the probability of reaching x1 from x2.

Implements RooStats::ProposalFunction.

Definition at line 141 of file PdfProposal.cxx.

virtual void RooStats::PdfProposal::printMappings ( )
inlinevirtual

Definition at line 126 of file PdfProposal.h.

void PdfProposal::Propose ( RooArgSet xPrime,
RooArgSet x 
)
virtual

Populate xPrime with a new proposed point.

Implements RooStats::ProposalFunction.

Definition at line 92 of file PdfProposal.cxx.

virtual void RooStats::PdfProposal::Reset ( void  )
inlinevirtual

Definition at line 118 of file PdfProposal.h.

virtual void RooStats::PdfProposal::SetCacheSize ( Int_t  size)
inlinevirtual

Set how many points to generate each time we propose from a new point Default (and minimum) is 1.

Definition at line 135 of file PdfProposal.h.

virtual void RooStats::PdfProposal::SetOwnsPdf ( Bool_t  ownsPdf)
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 146 of file PdfProposal.h.

virtual void RooStats::PdfProposal::SetPdf ( RooAbsPdf pdf)
inlinevirtual

Set the PDF to be the proposal density function.

Definition at line 104 of file PdfProposal.h.

Member Data Documentation

RooDataSet* RooStats::PdfProposal::fCache
protected

our position in the cached proposal data set

Definition at line 165 of file PdfProposal.h.

Referenced by PdfProposal(), Propose(), Reset(), and ~PdfProposal().

Int_t RooStats::PdfProposal::fCachePosition
protected

how many points to generate each time

Definition at line 164 of file PdfProposal.h.

Referenced by PdfProposal(), Propose(), and Reset().

Int_t RooStats::PdfProposal::fCacheSize
protected

the last point we were at

Definition at line 163 of file PdfProposal.h.

Referenced by PdfProposal(), Propose(), and SetCacheSize().

std::map<RooRealVar*, RooAbsReal*>::iterator RooStats::PdfProposal::fIt
protected

map of values in pdf to update

Definition at line 161 of file PdfProposal.h.

Referenced by GetProposalDensity(), and Propose().

RooArgSet RooStats::PdfProposal::fLastX
protected

pdf iterator

Definition at line 162 of file PdfProposal.h.

Referenced by Propose(), and Reset().

std::map<RooRealVar*, RooAbsReal*> RooStats::PdfProposal::fMap
protected

the proposal density function

Definition at line 160 of file PdfProposal.h.

Referenced by AddMapping(), GetProposalDensity(), printMappings(), and Propose().

RooArgSet RooStats::PdfProposal::fMaster
protected

the cached proposal data set

Definition at line 166 of file PdfProposal.h.

Referenced by AddMapping(), GetProposalDensity(), and Propose().

Bool_t RooStats::PdfProposal::fOwnsPdf
protected

pointers to master variables needed for updates

Definition at line 167 of file PdfProposal.h.

Referenced by PdfProposal(), SetOwnsPdf(), and ~PdfProposal().

RooAbsPdf* RooStats::PdfProposal::fPdf
protected

Definition at line 159 of file PdfProposal.h.

Referenced by GetPdf(), GetProposalDensity(), PdfProposal(), Propose(), SetPdf(), and ~PdfProposal().

Collaboration diagram for RooStats::PdfProposal:
[legend]

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