ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 53 of file MarkovChain.h.

Public Member Functions

 MarkovChain ()
 
 MarkovChain (RooArgSet &parameters)
 
 MarkovChain (const char *name, const char *title, RooArgSet &parameters)
 
virtual void Add (RooArgSet &entry, Double_t nllValue, Double_t weight=1.0)
 safely add an entry to the chain More...
 
virtual void AddFast (RooArgSet &entry, Double_t nllValue, Double_t weight=1.0)
 add an entry to the chain ONLY IF you have constructed with parameters or called SetParameters More...
 
virtual void AddWithBurnIn (MarkovChain &otherChain, Int_t burnIn=0)
 add another markov chain More...
 
virtual void Add (MarkovChain &otherChain, Double_t discardEntries=0.0)
 add another markov chain More...
 
virtual void SetParameters (RooArgSet &parameters)
 set which of your parameters this chain should store More...
 
virtual Int_t Size () const
 get the number of steps in the chain More...
 
virtual const RooArgSetGet (Int_t i) const
 get the entry at position i More...
 
virtual const RooArgSetGet () const
 get the entry at the current position More...
 
virtual Double_t Weight () const
 get the weight of the current (last indexed) entry More...
 
virtual Double_t Weight (Int_t i) const
 get the weight of entry at position i More...
 
virtual Double_t NLL (Int_t i) const
 get the NLL value of entry at position i More...
 
virtual Double_t NLL () const
 get the NLL value of the current (last indexed) entry More...
 
virtual RooDataSetGetAsDataSet (RooArgSet *whichVars=NULL) const
 get this MarkovChain as a RooDataSet whose entries contain the values of whichVars. More...
 
virtual RooDataSetGetAsDataSet (const RooCmdArg &arg1, const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none(), const RooCmdArg &arg7=RooCmdArg::none(), const RooCmdArg &arg8=RooCmdArg::none()) const
 Get a clone of the markov chain on which this interval is based as a RooDataSet. More...
 
virtual const RooDataSetGetAsConstDataSet () const
 
virtual RooDataHistGetAsDataHist (RooArgSet *whichVars=NULL) const
 get this MarkovChain as a RooDataHist whose entries contain the values of whichVars. More...
 
virtual RooDataHistGetAsDataHist (const RooCmdArg &arg1, const RooCmdArg &arg2=RooCmdArg::none(), const RooCmdArg &arg3=RooCmdArg::none(), const RooCmdArg &arg4=RooCmdArg::none(), const RooCmdArg &arg5=RooCmdArg::none(), const RooCmdArg &arg6=RooCmdArg::none(), const RooCmdArg &arg7=RooCmdArg::none(), const RooCmdArg &arg8=RooCmdArg::none()) const
 Get a clone of the markov chain on which this interval is based as a RooDataHist. More...
 
virtual THnSparseGetAsSparseHist (RooAbsCollection *whichVars=NULL) const
 Get a clone of the markov chain on which this interval is based as a sparse histogram. More...
 
virtual THnSparseGetAsSparseHist (RooAbsCollection &whichVars) const
 
virtual RooRealVarGetNLLVar () const
 get a clone of the NLL variable More...
 
virtual RooRealVarGetWeightVar () const
 get a clone of the weight variable More...
 
virtual ~MarkovChain ()
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
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 two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. 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 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 * 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 Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. 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 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

 ClassDef (MarkovChain, 1)
 
- 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

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

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

+ Inheritance diagram for RooStats::MarkovChain:
+ Collaboration diagram for RooStats::MarkovChain:

Constructor & Destructor Documentation

MarkovChain::MarkovChain ( )

Definition at line 58 of file MarkovChain.cxx.

MarkovChain::MarkovChain ( RooArgSet parameters)

Definition at line 68 of file MarkovChain.cxx.

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

Definition at line 79 of file MarkovChain.cxx.

virtual RooStats::MarkovChain::~MarkovChain ( )
inlinevirtual

Definition at line 130 of file MarkovChain.h.

Member Function Documentation

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

safely add an entry to the chain

Definition at line 115 of file MarkovChain.cxx.

Referenced by RooStats::MetropolisHastings::ConstructChain().

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

add another markov chain

Definition at line 141 of file MarkovChain.cxx.

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

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

Definition at line 158 of file MarkovChain.cxx.

Referenced by Add(), and AddWithBurnIn().

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

add another markov chain

Definition at line 127 of file MarkovChain.cxx.

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

get the entry at the current position

Definition at line 76 of file MarkovChain.h.

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

Definition at line 100 of file MarkovChain.h.

RooDataHist * MarkovChain::GetAsDataHist ( RooArgSet whichVars = NULL) const
virtual

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

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

Definition at line 195 of file MarkovChain.cxx.

RooDataHist * MarkovChain::GetAsDataHist ( const RooCmdArg arg1,
const RooCmdArg arg2 = RooCmdArg::none(),
const RooCmdArg arg3 = RooCmdArg::none(),
const RooCmdArg arg4 = RooCmdArg::none(),
const RooCmdArg arg5 = RooCmdArg::none(),
const RooCmdArg arg6 = RooCmdArg::none(),
const RooCmdArg arg7 = RooCmdArg::none(),
const RooCmdArg arg8 = RooCmdArg::none() 
) 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 213 of file MarkovChain.cxx.

RooDataSet * MarkovChain::GetAsDataSet ( RooArgSet whichVars = NULL) const
virtual

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

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

Definition at line 168 of file MarkovChain.cxx.

RooDataSet * MarkovChain::GetAsDataSet ( const RooCmdArg arg1,
const RooCmdArg arg2 = RooCmdArg::none(),
const RooCmdArg arg3 = RooCmdArg::none(),
const RooCmdArg arg4 = RooCmdArg::none(),
const RooCmdArg arg5 = RooCmdArg::none(),
const RooCmdArg arg6 = RooCmdArg::none(),
const RooCmdArg arg7 = RooCmdArg::none(),
const RooCmdArg arg8 = RooCmdArg::none() 
) 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 186 of file MarkovChain.cxx.

THnSparse * MarkovChain::GetAsSparseHist ( RooAbsCollection whichVars = NULL) 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 226 of file MarkovChain.cxx.

Referenced by GetAsSparseHist().

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

Definition at line 119 of file MarkovChain.h.

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

get a clone of the NLL variable

Definition at line 123 of file MarkovChain.h.

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

get a clone of the weight variable

Definition at line 127 of file MarkovChain.h.

Double_t MarkovChain::NLL ( Int_t  i) const
virtual

get the NLL value of entry at position i

Definition at line 276 of file MarkovChain.cxx.

Referenced by Add(), AddWithBurnIn(), RooStats::MCMCIntervalPlot::DrawNLLHist(), and RooStats::MCMCIntervalPlot::DrawNLLVsTime().

Double_t MarkovChain::NLL ( ) const
virtual

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

Definition at line 284 of file MarkovChain.cxx.

void MarkovChain::SetParameters ( RooArgSet parameters)
virtual

set which of your parameters this chain should store

Definition at line 90 of file MarkovChain.cxx.

Referenced by Add(), AddWithBurnIn(), RooStats::MetropolisHastings::ConstructChain(), and MarkovChain().

virtual Int_t RooStats::MarkovChain::Size ( ) const
inlinevirtual
Double_t MarkovChain::Weight ( ) const
virtual
Double_t MarkovChain::Weight ( Int_t  i) const
virtual

get the weight of entry at position i

Definition at line 297 of file MarkovChain.cxx.

Member Data Documentation

RooDataSet* RooStats::MarkovChain::fChain
protected
RooArgSet* RooStats::MarkovChain::fDataEntry
protected

Definition at line 139 of file MarkovChain.h.

Referenced by Add(), AddFast(), GetAsDataSet(), MarkovChain(), SetParameters(), and ~MarkovChain().

RooRealVar* RooStats::MarkovChain::fNLL
protected

Definition at line 141 of file MarkovChain.h.

Referenced by Add(), AddFast(), GetNLLVar(), MarkovChain(), and SetParameters().

RooArgSet* RooStats::MarkovChain::fParameters
protected
RooRealVar* RooStats::MarkovChain::fWeight
protected

Definition at line 142 of file MarkovChain.h.

Referenced by Add(), AddFast(), GetWeightVar(), MarkovChain(), and SetParameters().


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