ROOT logo
ROOT » ROOFIT » ROOSTATS » RooStats::PdfProposal

class RooStats::PdfProposal: public RooStats::ProposalFunction

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:

// 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.

Function Members (Methods)

voidTObject::AbstractMethod(const char* method) const
virtual voidAddMapping(RooRealVar& proposalParam, RooAbsReal& update)
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
virtual boolRooStats::ProposalFunction::CheckParameters(RooArgSet& params)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
virtual const char*TObject::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
virtual const RooAbsPdf*GetPdf() const
virtual Double_tGetProposalDensity(RooArgSet& x1, RooArgSet& x2)
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
virtual Bool_tIsSymmetric(RooArgSet& x1, RooArgSet& x2)
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
RooStats::PdfProposal&operator=(const RooStats::PdfProposal&)
virtual voidTObject::Paint(Option_t* option = "")
RooStats::PdfProposalPdfProposal(RooAbsPdf& pdf)
RooStats::PdfProposalPdfProposal(const RooStats::PdfProposal&)
virtual voidTObject::Pop()
virtual voidTObject::Print(Option_t* option = "") const
virtual voidprintMappings()
virtual voidPropose(RooArgSet& xPrime, RooArgSet& x)
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
virtual voidReset()
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidSetCacheSize(Int_t size)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
static voidTObject::SetObjectStat(Bool_t stat)
virtual voidSetOwnsPdf(Bool_t ownsPdf)
virtual voidSetPdf(RooAbsPdf& pdf)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
virtual Bool_tEquals(RooArgSet& x1, RooArgSet& x2)

Data Members

RooDataSet*fCachethe cached proposal data set
Int_tfCachePositionour position in the cached proposal data set
Int_tfCacheSizehow many points to generate each time
map<RooRealVar*,RooAbsReal*,less<RooRealVar*>,allocator<pair<RooRealVar* const,RooAbsReal*> > >::iteratorfItpdf iterator
RooArgSetfLastXthe last point we were at
map<RooRealVar*,RooAbsReal*>fMapmap of values in pdf to update
RooArgSetfMasterpointers to master variables needed for updates
Bool_tfOwnsPdfwhether we own the proposal density function
RooAbsPdf*fPdfthe proposal density function

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

PdfProposal(RooAbsPdf& pdf)
Bool_t Equals(RooArgSet& x1, RooArgSet& x2)
void Propose(RooArgSet& xPrime, RooArgSet& x)
Bool_t IsSymmetric(RooArgSet& x1, RooArgSet& x2)
 kbelasco: is there a better way to do this?
Double_t GetProposalDensity(RooArgSet& x1, RooArgSet& x2)
void AddMapping(RooRealVar& proposalParam, RooAbsReal& update)
void SetPdf(RooAbsPdf& pdf)
 Set the PDF to be the proposal density function
{ fPdf = &pdf; }
const RooAbsPdf* GetPdf() const
 Get the PDF is the proposal density function
{ return fPdf; }
void Reset()
void printMappings()
void SetCacheSize(Int_t size)
 Set how many points to generate each time we propose from a new point
 Default (and minimum) is 1
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.
{ fOwnsPdf = ownsPdf; }
virtual ~PdfProposal()
virtual void SetIsAlwaysSymmetric(Bool_t isAlwaysSymmetric)
{ fIsAlwaysSymmetric = isAlwaysSymmetric; }