Definition at line 29 of file ProposalHelper.h.

Public Member Functions
	ProposalHelper ()

	~ProposalHelper () override

virtual ProposalFunction *	GetProposalFunction ()
	Get the ProposalFunction that we've been designing.

TClass *	IsA () 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.

virtual void	SetCluesFraction (double cluesFrac)
	set what fraction of the proposal density function should come from the bank of clues

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

virtual void	SetCovMatrix (const TMatrixDSym &covMatrix)
	set the covariance matrix to use for a multi-variate Gaussian proposal

virtual void	SetPdf (RooAbsPdf &pdf)
	Set the PDF to be the proposal density function.

virtual void	SetUniformFraction (double uniFrac)
	set what fraction of the proposal density function should come from a uniform proposal distribution

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.

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 ()

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

void	MakeZombie ()

Protected Attributes
Int_t	fCacheSize = -1
	for generating proposals from PDFs

RooDataSet *	fClues = nullptr
	data set of clues

double	fCluesFrac = -1
	what fraction of the PDF integral comes from clues

const Option_t *	fCluesOptions = nullptr
	option string for clues RooNDKeysPdf

RooAbsPdf *	fCluesPdf = nullptr
	proposal dens. func. with clues for certain points

TMatrixDSym *	fCovMatrix = nullptr
	covariance matrix for multi var gaussian pdf

bool	fOwnsCluesPdf = false
	whether we created (and own) the clues pdf

bool	fOwnsPdf = false
	whether we created (and own) the main pdf

bool	fOwnsPdfProp = true
	whether we own the PdfProposal; equivalent to: !(whether we have returned it in GetProposalFunction)

bool	fOwnsVars = false
	whether we own fVars

RooAbsPdf *	fPdf = nullptr
	the main proposal density function

PdfProposal *	fPdfProp = nullptr
	the PdfProposal we are (probably) going to return

double	fSigmaRangeDivisor
	range divisor to get sigma for each variable

RooAbsPdf *	fUniformPdf = nullptr
	uniform proposal dens. func.

double	fUniFrac = -1
	what fraction of the PDF integral is uniform

bool	fUseUpdates = false
	whether to set updates for proposal params in PdfProposal

RooArgList *	fVars = nullptr
	the RooRealVars to generate proposals for

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 92 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 constexpr Version_t RooStats::ProposalHelper::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 127 of file ProposalHelper.h.

◆ CreateCluesPdf()

void ProposalHelper::CreateCluesPdf ( )

protected

Definition at line 131 of file ProposalHelper.cxx.

◆ CreateCovMatrix()

void ProposalHelper::CreateCovMatrix ( RooArgList & xVec )

protected

Definition at line 117 of file ProposalHelper.cxx.

◆ CreatePdf()

void ProposalHelper::CreatePdf ( )

protected

Definition at line 91 of file ProposalHelper.cxx.

◆ CreateUniformPdf()

void ProposalHelper::CreateUniformPdf ( )

protected

Definition at line 144 of file ProposalHelper.cxx.

◆ DeclFileName()

static const char * RooStats::ProposalHelper::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 127 of file ProposalHelper.h.

◆ GetProposalFunction()

ProposalFunction * ProposalHelper::GetProposalFunction ( )

virtual

Get the ProposalFunction that we've been designing.

Definition at line 57 of file ProposalHelper.cxx.

◆ IsA()

TClass * RooStats::ProposalHelper::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 127 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 67 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 82 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 70 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 63 of file ProposalHelper.h.

◆ SetUpdateProposalParameters()

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

inlinevirtual

Definition at line 52 of file ProposalHelper.h.

◆ SetVariables() [1/3]

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

inlinevirtual

Definition at line 58 of file ProposalHelper.h.

◆ SetVariables() [2/3]

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

inlinevirtual

Definition at line 55 of file ProposalHelper.h.

◆ SetVariables() [3/3]

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

inlinevirtual

Definition at line 85 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 76 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 127 of file ProposalHelper.h.

Member Data Documentation

◆ fCacheSize

Int_t RooStats::ProposalHelper::fCacheSize = -1

protected

for generating proposals from PDFs

Definition at line 110 of file ProposalHelper.h.

◆ fClues

RooDataSet* RooStats::ProposalHelper::fClues = nullptr

protected

data set of clues

Definition at line 106 of file ProposalHelper.h.

◆ fCluesFrac

double RooStats::ProposalHelper::fCluesFrac = -1

protected

what fraction of the PDF integral comes from clues

Definition at line 113 of file ProposalHelper.h.

◆ fCluesOptions

const Option_t* RooStats::ProposalHelper::fCluesOptions = nullptr

protected

option string for clues RooNDKeysPdf

Definition at line 120 of file ProposalHelper.h.

◆ fCluesPdf

RooAbsPdf* RooStats::ProposalHelper::fCluesPdf = nullptr

protected

proposal dens. func. with clues for certain points

Definition at line 104 of file ProposalHelper.h.

◆ fCovMatrix

TMatrixDSym* RooStats::ProposalHelper::fCovMatrix = nullptr

protected

covariance matrix for multi var gaussian pdf

Definition at line 107 of file ProposalHelper.h.

◆ fOwnsCluesPdf

bool RooStats::ProposalHelper::fOwnsCluesPdf = false

protected

whether we created (and own) the clues pdf

Definition at line 117 of file ProposalHelper.h.

◆ fOwnsPdf

bool RooStats::ProposalHelper::fOwnsPdf = false

protected

whether we created (and own) the main pdf

Definition at line 116 of file ProposalHelper.h.

◆ fOwnsPdfProp

bool RooStats::ProposalHelper::fOwnsPdfProp = true

protected

whether we own the PdfProposal; equivalent to: !(whether we have returned it in GetProposalFunction)

Definition at line 114 of file ProposalHelper.h.

◆ fOwnsVars

bool RooStats::ProposalHelper::fOwnsVars = false

protected

whether we own fVars

Definition at line 118 of file ProposalHelper.h.

◆ fPdf

RooAbsPdf* RooStats::ProposalHelper::fPdf = nullptr

protected

the main proposal density function

Definition at line 103 of file ProposalHelper.h.

◆ fPdfProp

PdfProposal* RooStats::ProposalHelper::fPdfProp = nullptr

protected

the PdfProposal we are (probably) going to return

Definition at line 108 of file ProposalHelper.h.

◆ fSigmaRangeDivisor

double RooStats::ProposalHelper::fSigmaRangeDivisor

protected

range divisor to get sigma for each variable

Definition at line 111 of file ProposalHelper.h.

◆ fUniformPdf

RooAbsPdf* RooStats::ProposalHelper::fUniformPdf = nullptr

protected

uniform proposal dens. func.

Definition at line 105 of file ProposalHelper.h.

◆ fUniFrac

double RooStats::ProposalHelper::fUniFrac = -1

protected

what fraction of the PDF integral is uniform

Definition at line 112 of file ProposalHelper.h.

◆ fUseUpdates

bool RooStats::ProposalHelper::fUseUpdates = false

protected

whether to set updates for proposal params in PdfProposal

Definition at line 119 of file ProposalHelper.h.

◆ fVars

RooArgList* RooStats::ProposalHelper::fVars = nullptr

protected

the RooRealVars to generate proposals for

Definition at line 109 of file ProposalHelper.h.

Libraries for RooStats::ProposalHelper:

[legend]

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

roofit/roostats/inc/RooStats/ProposalHelper.h
roofit/roostats/src/ProposalHelper.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ProposalHelper()

◆ ~ProposalHelper()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ CreateCluesPdf()

◆ CreateCovMatrix()

◆ CreatePdf()

◆ CreateUniformPdf()

◆ DeclFileName()

◆ GetProposalFunction()

◆ IsA()

◆ SetCacheSize()

◆ SetClues()

◆ SetCluesFraction()

◆ SetCluesOptions()

◆ SetCovMatrix()

◆ SetPdf()

◆ SetUniformFraction()

◆ SetUpdateProposalParameters()

◆ SetVariables() [1/3]

◆ SetVariables() [2/3]

◆ SetVariables() [3/3]

◆ SetWidthRangeDivisor()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fCacheSize

◆ fClues

◆ fCluesFrac

◆ fCluesOptions

◆ fCluesPdf

◆ fCovMatrix

◆ fOwnsCluesPdf

◆ fOwnsPdf

◆ fOwnsPdfProp

◆ fOwnsVars

◆ fPdf

◆ fPdfProp

◆ fSigmaRangeDivisor

◆ fUniformPdf

◆ fUniFrac

◆ fUseUpdates

◆ fVars