Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooStats::MarkovChain Class Reference

Stores the steps in a Markov Chain of points.

Allows user to access the weight and NLL value (if applicable) with which a point was added to the MarkovChain.

Definition at line 30 of file MarkovChain.h.

Public Member Functions

 MarkovChain ()
 
 MarkovChain (const char *name, const char *title, RooArgSet &parameters)
 
 MarkovChain (RooArgSet &parameters)
 
 ~MarkovChain () override
 
virtual void Add (MarkovChain &otherChain, double discardEntries=0.0)
 add another markov chain
 
virtual void Add (RooArgSet &entry, double nllValue, double weight=1.0)
 safely add an entry to the chain
 
virtual void AddFast (RooArgSet &entry, double nllValue, double weight=1.0)
 add an entry to the chain ONLY IF you have constructed with parameters or called SetParameters
 
virtual void AddWithBurnIn (MarkovChain &otherChain, Int_t burnIn=0)
 add another markov chain
 
virtual const RooArgSetGet () const
 get the entry at the current position
 
virtual const RooArgSetGet (Int_t i) const
 get the entry at position i
 
virtual const RooDataSetGetAsConstDataSet () const
 
virtual RooFit::OwningPtr< RooDataHistGetAsDataHist (const RooCmdArg &arg1, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={}) const
 Get a clone of the markov chain on which this interval is based as a RooDataHist.
 
virtual RooFit::OwningPtr< RooDataHistGetAsDataHist (RooArgSet *whichVars=nullptr) const
 get this MarkovChain as a RooDataHist whose entries contain the values of whichVars.
 
virtual RooFit::OwningPtr< RooDataSetGetAsDataSet (const RooCmdArg &arg1, const RooCmdArg &arg2={}, const RooCmdArg &arg3={}, const RooCmdArg &arg4={}, const RooCmdArg &arg5={}, const RooCmdArg &arg6={}, const RooCmdArg &arg7={}, const RooCmdArg &arg8={}) const
 Get a clone of the markov chain on which this interval is based as a RooDataSet.
 
virtual RooFit::OwningPtr< RooDataSetGetAsDataSet (RooArgSet *whichVars=nullptr) const
 get this MarkovChain as a RooDataSet whose entries contain the values of whichVars.
 
virtual THnSparseGetAsSparseHist (RooAbsCollection &whichVars) const
 
virtual THnSparseGetAsSparseHist (RooAbsCollection *whichVars=nullptr) const
 Get a clone of the markov chain on which this interval is based as a sparse histogram.
 
virtual RooRealVarGetNLLVar () const
 get a clone of the NLL variable
 
virtual RooRealVarGetWeightVar () const
 get a clone of the weight variable
 
TClassIsA () const override
 
virtual double NLL () const
 get the NLL value of the current (last indexed) entry
 
virtual double NLL (Int_t i) const
 get the NLL value of entry at position i
 
virtual void SetParameters (RooArgSet &parameters)
 set which of your parameters this chain should store
 
virtual Int_t Size () const
 get the number of steps in the chain
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual double Weight () const
 get the weight of the current (last indexed) entry
 
virtual double Weight (Int_t i) const
 get the weight of entry at position i
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
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 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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type 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_tGetOption () const
 
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.
 
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
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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)
 Operator delete [].
 
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.
 
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 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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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 Attributes

RooDataSetfChain = nullptr
 
RooArgSetfDataEntry = nullptr
 
RooRealVarfNLL = nullptr
 
RooArgSetfParameters = nullptr
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

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

#include <RooStats/MarkovChain.h>

Inheritance diagram for RooStats::MarkovChain:
[legend]

Constructor & Destructor Documentation

◆ MarkovChain() [1/3]

MarkovChain::MarkovChain ( )

Definition at line 45 of file MarkovChain.cxx.

◆ MarkovChain() [2/3]

MarkovChain::MarkovChain ( RooArgSet parameters)

Definition at line 47 of file MarkovChain.cxx.

◆ MarkovChain() [3/3]

MarkovChain::MarkovChain ( const char *  name,
const char *  title,
RooArgSet parameters 
)

Definition at line 52 of file MarkovChain.cxx.

◆ ~MarkovChain()

RooStats::MarkovChain::~MarkovChain ( )
inlineoverride

Definition at line 107 of file MarkovChain.h.

Member Function Documentation

◆ Add() [1/2]

void MarkovChain::Add ( MarkovChain otherChain,
double  discardEntries = 0.0 
)
virtual

add another markov chain

Definition at line 104 of file MarkovChain.cxx.

◆ Add() [2/2]

void MarkovChain::Add ( RooArgSet entry,
double  nllValue,
double  weight = 1.0 
)
virtual

safely add an entry to the chain

Definition at line 79 of file MarkovChain.cxx.

◆ AddFast()

void MarkovChain::AddFast ( RooArgSet entry,
double  nllValue,
double  weight = 1.0 
)
virtual

add an entry to the chain ONLY IF you have constructed with parameters or called SetParameters

Definition at line 121 of file MarkovChain.cxx.

◆ AddWithBurnIn()

void MarkovChain::AddWithBurnIn ( MarkovChain otherChain,
Int_t  burnIn = 0 
)
virtual

add another markov chain

Definition at line 90 of file MarkovChain.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

static constexpr Version_t RooStats::MarkovChain::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 120 of file MarkovChain.h.

◆ DeclFileName()

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

Definition at line 120 of file MarkovChain.h.

◆ Get() [1/2]

virtual const RooArgSet * RooStats::MarkovChain::Get ( ) const
inlinevirtual

get the entry at the current position

Definition at line 53 of file MarkovChain.h.

◆ Get() [2/2]

virtual const RooArgSet * RooStats::MarkovChain::Get ( Int_t  i) const
inlinevirtual

get the entry at position i

Definition at line 51 of file MarkovChain.h.

◆ GetAsConstDataSet()

virtual const RooDataSet * RooStats::MarkovChain::GetAsConstDataSet ( ) const
inlinevirtual

Definition at line 77 of file MarkovChain.h.

◆ GetAsDataHist() [1/2]

RooFit::OwningPtr< RooDataHist > MarkovChain::GetAsDataHist ( const RooCmdArg arg1,
const RooCmdArg arg2 = {},
const RooCmdArg arg3 = {},
const RooCmdArg arg4 = {},
const RooCmdArg arg5 = {},
const RooCmdArg arg6 = {},
const RooCmdArg arg7 = {},
const RooCmdArg arg8 = {} 
) const
virtual

Get a clone of the markov chain on which this interval is based as a RooDataHist.

You own the returned RooDataHist*

Definition at line 168 of file MarkovChain.cxx.

◆ GetAsDataHist() [2/2]

RooFit::OwningPtr< RooDataHist > MarkovChain::GetAsDataHist ( RooArgSet whichVars = nullptr) const
virtual

get this MarkovChain as a RooDataHist whose entries contain the values of whichVars.

Call with whichVars = nullptr (default) to get values of all variables (including NLL value and weight); Note: caller owns the returned data hist

Definition at line 153 of file MarkovChain.cxx.

◆ GetAsDataSet() [1/2]

RooFit::OwningPtr< RooDataSet > MarkovChain::GetAsDataSet ( const RooCmdArg arg1,
const RooCmdArg arg2 = {},
const RooCmdArg arg3 = {},
const RooCmdArg arg4 = {},
const RooCmdArg arg5 = {},
const RooCmdArg arg6 = {},
const RooCmdArg arg7 = {},
const RooCmdArg arg8 = {} 
) const
virtual

Get a clone of the markov chain on which this interval is based as a RooDataSet.

You own the returned RooDataSet*

Definition at line 144 of file MarkovChain.cxx.

◆ GetAsDataSet() [2/2]

RooFit::OwningPtr< RooDataSet > MarkovChain::GetAsDataSet ( RooArgSet whichVars = nullptr) const
virtual

get this MarkovChain as a RooDataSet whose entries contain the values of whichVars.

Call with whichVars = nullptr (default) to get values of all variables (including NLL value and weight); Note: caller owns the returned data set

Definition at line 130 of file MarkovChain.cxx.

◆ GetAsSparseHist() [1/2]

virtual THnSparse * RooStats::MarkovChain::GetAsSparseHist ( RooAbsCollection whichVars) const
inlinevirtual

Definition at line 96 of file MarkovChain.h.

◆ GetAsSparseHist() [2/2]

THnSparse * MarkovChain::GetAsSparseHist ( RooAbsCollection whichVars = nullptr) const
virtual

Get a clone of the markov chain on which this interval is based as a sparse histogram.

You own the returned THnSparse*

Definition at line 177 of file MarkovChain.cxx.

◆ GetNLLVar()

virtual RooRealVar * RooStats::MarkovChain::GetNLLVar ( ) const
inlinevirtual

get a clone of the NLL variable

Definition at line 100 of file MarkovChain.h.

◆ GetWeightVar()

virtual RooRealVar * RooStats::MarkovChain::GetWeightVar ( ) const
inlinevirtual

get a clone of the weight variable

Definition at line 104 of file MarkovChain.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 120 of file MarkovChain.h.

◆ NLL() [1/2]

double MarkovChain::NLL ( ) const
virtual

get the NLL value of the current (last indexed) entry

Definition at line 233 of file MarkovChain.cxx.

◆ NLL() [2/2]

double MarkovChain::NLL ( Int_t  i) const
virtual

get the NLL value of entry at position i

Definition at line 225 of file MarkovChain.cxx.

◆ SetParameters()

void MarkovChain::SetParameters ( RooArgSet parameters)
virtual

set which of your parameters this chain should store

Definition at line 57 of file MarkovChain.cxx.

◆ Size()

virtual Int_t RooStats::MarkovChain::Size ( ) const
inlinevirtual

get the number of steps in the chain

Definition at line 49 of file MarkovChain.h.

◆ Streamer()

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

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

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

Definition at line 120 of file MarkovChain.h.

◆ Weight() [1/2]

double MarkovChain::Weight ( ) const
virtual

get the weight of the current (last indexed) entry

Definition at line 241 of file MarkovChain.cxx.

◆ Weight() [2/2]

double MarkovChain::Weight ( Int_t  i) const
virtual

get the weight of entry at position i

Definition at line 246 of file MarkovChain.cxx.

Member Data Documentation

◆ fChain

RooDataSet* RooStats::MarkovChain::fChain = nullptr
protected

Definition at line 117 of file MarkovChain.h.

◆ fDataEntry

RooArgSet* RooStats::MarkovChain::fDataEntry = nullptr
protected

Definition at line 116 of file MarkovChain.h.

◆ fNLL

RooRealVar* RooStats::MarkovChain::fNLL = nullptr
protected

Definition at line 118 of file MarkovChain.h.

◆ fParameters

RooArgSet* RooStats::MarkovChain::fParameters = nullptr
protected

Definition at line 115 of file MarkovChain.h.

Libraries for RooStats::MarkovChain:

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