Logo ROOT  
Reference Guide
RooStats::ProposalHelper Class Reference

Definition at line 29 of file ProposalHelper.h.

Public Member Functions

 ProposalHelper ()
 
 ~ProposalHelper () override
 
virtual ProposalFunctionGetProposalFunction ()
 Get the ProposalFunction that we've been designing. More...
 
TClassIsA () const override
 
virtual void SetCacheSize (Int_t size)
 
virtual void SetClues (RooDataSet &clues)
 Set the bank of clues to add to the current proposal density function. More...
 
virtual void SetCluesFraction (double cluesFrac)
 set what fraction of the proposal density function should come from the bank of clues More...
 
virtual void SetCluesOptions (const Option_t *options)
 set the option string to pass to the RooNDKeysPdf constructor if the bank of clues pdf is being automatically generated by this ProposalHelper More...
 
virtual void SetCovMatrix (const TMatrixDSym &covMatrix)
 set the covariance matrix to use for a multi-variate Gaussian proposal More...
 
virtual void SetPdf (RooAbsPdf &pdf)
 Set the PDF to be the proposal density function. More...
 
virtual void SetUniformFraction (double uniFrac)
 set what fraction of the proposal density function should come from a uniform proposal distribution More...
 
virtual void SetUpdateProposalParameters (bool updateParams)
 
virtual void SetVariables (const RooArgList &vars)
 
virtual void SetVariables (RooArgList &vars)
 
virtual void SetVariables (RooArgSet &vars)
 
virtual void SetWidthRangeDivisor (double divisor)
 set what divisor we will use when dividing the range of a variable to determine the width of the proposal function for each dimension e.g. More...
 
void Streamer (TBuffer &) override
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
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. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. 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...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
virtual TClassIsA () const
 
Bool_t IsDestructed () const
 IsDestructed. 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 IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
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...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 Streamer (TBuffer &)
 Stream an object of class TObject. More...
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

void CreateCluesPdf ()
 
void CreateCovMatrix (RooArgList &xVec)
 
void CreatePdf ()
 
void CreateUniformPdf ()
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

Int_t fCacheSize
 for generating proposals from PDFs More...
 
RooDataSetfClues
 data set of clues More...
 
double fCluesFrac
 what fraction of the PDF integral comes from clues More...
 
const Option_tfCluesOptions
 option string for clues RooNDKeysPdf More...
 
RooAbsPdffCluesPdf
 proposal dens. func. with clues for certain points More...
 
TMatrixDSymfCovMatrix
 covariance matrix for multi var gaussian pdf More...
 
bool fOwnsCluesPdf
 whether we created (and own) the clues pdf More...
 
bool fOwnsPdf
 whether we created (and own) the main pdf More...
 
bool fOwnsPdfProp
 whether we own the PdfProposal; equivalent to: More...
 
bool fOwnsVars
 whether we own fVars More...
 
RooAbsPdffPdf
 the main proposal density function More...
 
PdfProposalfPdfProp
 the PdfProposal we are (probably) going to return More...
 
double fSigmaRangeDivisor
 range divisor to get sigma for each variable More...
 
RooAbsPdffUniformPdf
 uniform proposal dens. func. More...
 
double fUniFrac
 what fraction of the PDF integral is uniform More...
 
bool fUseUpdates
 whether to set updates for proposal params in PdfProposal More...
 
RooArgListfVars
 the RooRealVars to generate proposals for More...
 

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

Inheritance diagram for RooStats::ProposalHelper:
[legend]

Constructor & Destructor Documentation

◆ ProposalHelper()

ProposalHelper::ProposalHelper ( )

Definition at line 53 of file ProposalHelper.cxx.

◆ ~ProposalHelper()

RooStats::ProposalHelper::~ProposalHelper ( )
inlineoverride

Definition at line 91 of file ProposalHelper.h.

Member Function Documentation

◆ Class()

static TClass * RooStats::ProposalHelper::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * RooStats::ProposalHelper::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static Version_t RooStats::ProposalHelper::Class_Version ( )
inlinestatic
Returns
Version of this class

Definition at line 126 of file ProposalHelper.h.

◆ CreateCluesPdf()

void ProposalHelper::CreateCluesPdf ( )
protected

Definition at line 157 of file ProposalHelper.cxx.

◆ CreateCovMatrix()

void ProposalHelper::CreateCovMatrix ( RooArgList xVec)
protected

Definition at line 143 of file ProposalHelper.cxx.

◆ CreatePdf()

void ProposalHelper::CreatePdf ( )
protected

Definition at line 112 of file ProposalHelper.cxx.

◆ CreateUniformPdf()

void ProposalHelper::CreateUniformPdf ( )
protected

Definition at line 170 of file ProposalHelper.cxx.

◆ DeclFileName()

static const char * RooStats::ProposalHelper::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 126 of file ProposalHelper.h.

◆ GetProposalFunction()

ProposalFunction * ProposalHelper::GetProposalFunction ( )
virtual

Get the ProposalFunction that we've been designing.

Definition at line 76 of file ProposalHelper.cxx.

◆ IsA()

TClass * RooStats::ProposalHelper::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 126 of file ProposalHelper.h.

◆ SetCacheSize()

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

Definition at line 42 of file ProposalHelper.h.

◆ SetClues()

virtual void RooStats::ProposalHelper::SetClues ( RooDataSet clues)
inlinevirtual

Set the bank of clues to add to the current proposal density function.

Definition at line 37 of file ProposalHelper.h.

◆ SetCluesFraction()

virtual void RooStats::ProposalHelper::SetCluesFraction ( double  cluesFrac)
inlinevirtual

set what fraction of the proposal density function should come from the bank of clues

Definition at line 66 of file ProposalHelper.h.

◆ SetCluesOptions()

virtual void RooStats::ProposalHelper::SetCluesOptions ( const Option_t options)
inlinevirtual

set the option string to pass to the RooNDKeysPdf constructor if the bank of clues pdf is being automatically generated by this ProposalHelper

Definition at line 81 of file ProposalHelper.h.

◆ SetCovMatrix()

virtual void RooStats::ProposalHelper::SetCovMatrix ( const TMatrixDSym covMatrix)
inlinevirtual

set the covariance matrix to use for a multi-variate Gaussian proposal

Definition at line 69 of file ProposalHelper.h.

◆ SetPdf()

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

Set the PDF to be the proposal density function.

Definition at line 35 of file ProposalHelper.h.

◆ SetUniformFraction()

virtual void RooStats::ProposalHelper::SetUniformFraction ( double  uniFrac)
inlinevirtual

set what fraction of the proposal density function should come from a uniform proposal distribution

Definition at line 62 of file ProposalHelper.h.

◆ SetUpdateProposalParameters()

virtual void RooStats::ProposalHelper::SetUpdateProposalParameters ( bool  updateParams)
inlinevirtual

Definition at line 51 of file ProposalHelper.h.

◆ SetVariables() [1/3]

virtual void RooStats::ProposalHelper::SetVariables ( const RooArgList vars)
inlinevirtual

Definition at line 57 of file ProposalHelper.h.

◆ SetVariables() [2/3]

virtual void RooStats::ProposalHelper::SetVariables ( RooArgList vars)
inlinevirtual

Definition at line 54 of file ProposalHelper.h.

◆ SetVariables() [3/3]

virtual void RooStats::ProposalHelper::SetVariables ( RooArgSet vars)
inlinevirtual

Definition at line 84 of file ProposalHelper.h.

◆ SetWidthRangeDivisor()

virtual void RooStats::ProposalHelper::SetWidthRangeDivisor ( double  divisor)
inlinevirtual

set what divisor we will use when dividing the range of a variable to determine the width of the proposal function for each dimension e.g.

divisor = 6 for sigma = 1/6th

Definition at line 75 of file ProposalHelper.h.

◆ Streamer()

void RooStats::ProposalHelper::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void RooStats::ProposalHelper::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 126 of file ProposalHelper.h.

Member Data Documentation

◆ fCacheSize

Int_t RooStats::ProposalHelper::fCacheSize
protected

for generating proposals from PDFs

Definition at line 109 of file ProposalHelper.h.

◆ fClues

RooDataSet* RooStats::ProposalHelper::fClues
protected

data set of clues

Definition at line 105 of file ProposalHelper.h.

◆ fCluesFrac

double RooStats::ProposalHelper::fCluesFrac
protected

what fraction of the PDF integral comes from clues

Definition at line 112 of file ProposalHelper.h.

◆ fCluesOptions

const Option_t* RooStats::ProposalHelper::fCluesOptions
protected

option string for clues RooNDKeysPdf

Definition at line 119 of file ProposalHelper.h.

◆ fCluesPdf

RooAbsPdf* RooStats::ProposalHelper::fCluesPdf
protected

proposal dens. func. with clues for certain points

Definition at line 103 of file ProposalHelper.h.

◆ fCovMatrix

TMatrixDSym* RooStats::ProposalHelper::fCovMatrix
protected

covariance matrix for multi var gaussian pdf

Definition at line 106 of file ProposalHelper.h.

◆ fOwnsCluesPdf

bool RooStats::ProposalHelper::fOwnsCluesPdf
protected

whether we created (and own) the clues pdf

Definition at line 116 of file ProposalHelper.h.

◆ fOwnsPdf

bool RooStats::ProposalHelper::fOwnsPdf
protected

whether we created (and own) the main pdf

Definition at line 115 of file ProposalHelper.h.

◆ fOwnsPdfProp

bool RooStats::ProposalHelper::fOwnsPdfProp
protected

whether we own the PdfProposal; equivalent to:

!(whether we have returned it in GetProposalFunction)

Definition at line 113 of file ProposalHelper.h.

◆ fOwnsVars

bool RooStats::ProposalHelper::fOwnsVars
protected

whether we own fVars

Definition at line 117 of file ProposalHelper.h.

◆ fPdf

RooAbsPdf* RooStats::ProposalHelper::fPdf
protected

the main proposal density function

Definition at line 102 of file ProposalHelper.h.

◆ fPdfProp

PdfProposal* RooStats::ProposalHelper::fPdfProp
protected

the PdfProposal we are (probably) going to return

Definition at line 107 of file ProposalHelper.h.

◆ fSigmaRangeDivisor

double RooStats::ProposalHelper::fSigmaRangeDivisor
protected

range divisor to get sigma for each variable

Definition at line 110 of file ProposalHelper.h.

◆ fUniformPdf

RooAbsPdf* RooStats::ProposalHelper::fUniformPdf
protected

uniform proposal dens. func.

Definition at line 104 of file ProposalHelper.h.

◆ fUniFrac

double RooStats::ProposalHelper::fUniFrac
protected

what fraction of the PDF integral is uniform

Definition at line 111 of file ProposalHelper.h.

◆ fUseUpdates

bool RooStats::ProposalHelper::fUseUpdates
protected

whether to set updates for proposal params in PdfProposal

Definition at line 118 of file ProposalHelper.h.

◆ fVars

RooArgList* RooStats::ProposalHelper::fVars
protected

the RooRealVars to generate proposals for

Definition at line 108 of file ProposalHelper.h.

Libraries for RooStats::ProposalHelper:
[legend]

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