Logo ROOT  
Reference Guide
RooSimGenContext Class Reference

RooSimGenContext is an efficient implementation of the generator context specific for RooSimultaneous PDFs when generating more than one of the component pdfs.

It runs in two modes:

  • Proto data with category entries are given: An event from the same category as in the proto data is created.
  • No proto data: A category is chosen randomly.
    Note
    This requires that the PDFs are extended, to determine the relative probabilities that an event originates from a certain category.

Definition at line 27 of file RooSimGenContext.h.

Public Member Functions

 RooSimGenContext (const RooSimultaneous &model, const RooArgSet &vars, const RooDataSet *prototype=0, const RooArgSet *auxProto=0, Bool_t _verbose=kFALSE)
 Constructor of specialized generator context for RooSimultaneous p.d.f.s. More...
 
virtual ~RooSimGenContext ()
 Destructor. Delete all owned subgenerator contexts. More...
 
virtual void attach (const RooArgSet &params)
 Attach the index category clone to the given event buffer. More...
 
virtual void printMultiline (std::ostream &os, Int_t content, Bool_t verbose=kFALSE, TString indent="") const
 Detailed printing interface. More...
 
virtual void setProtoDataOrder (Int_t *lut)
 Set the traversal order of the prototype data to that in the given lookup table. More...
 
- Public Member Functions inherited from RooAbsGenContext
 RooAbsGenContext (const RooAbsPdf &model, const RooArgSet &vars, const RooDataSet *prototype=0, const RooArgSet *auxProto=0, Bool_t _verbose=kFALSE)
 Constructor. More...
 
virtual ~RooAbsGenContext ()
 Destructor. More...
 
virtual Int_t defaultPrintContents (Option_t *opt) const
 Define default contents when printing. More...
 
virtual StyleOption defaultPrintStyle (Option_t *opt) const
 Define default print style. More...
 
virtual RooDataSetgenerate (Double_t nEvents=0, Bool_t skipInit=kFALSE, Bool_t extendedMode=kFALSE)
 Generate the specified number of events with nEvents>0 and and return a dataset containing the generated events. More...
 
Bool_t isValid () const
 
Bool_t isVerbose () const
 
virtual void Print (Option_t *options=0) const
 Print TNamed name and title. More...
 
virtual void printArgs (std::ostream &os) const
 Print arguments of context, i.e. the observables being generated in this context. More...
 
virtual void printClassName (std::ostream &os) const
 Print class name of context. More...
 
virtual void printName (std::ostream &os) const
 Print name of context. More...
 
virtual void printTitle (std::ostream &os) const
 Print title of context. More...
 
virtual void setExpectedData (Bool_t)
 
void setVerbose (Bool_t verbose=kTRUE)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
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 ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- 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 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=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 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 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 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...
 
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 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
 
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). 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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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 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 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=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...
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual void printAddress (std::ostream &os) const
 Print class name of object. More...
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object. More...
 
virtual void printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
 Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'. More...
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object. More...
 
virtual void printValue (std::ostream &os) const
 Interface to print value of object. More...
 

Protected Member Functions

 RooSimGenContext (const RooSimGenContext &other)
 
RooDataSetcreateDataSet (const char *name, const char *title, const RooArgSet &obs)
 Create an empty dataset to hold the events that will be generated. More...
 
virtual void generateEvent (RooArgSet &theEvent, Int_t remaining)
 Generate event appropriate for current index state. More...
 
virtual void initGenerator (const RooArgSet &theEvent)
 Perform one-time initialization of generator context. More...
 
void updateFractions ()
 No action needed if we have a proto index. More...
 
- Protected Member Functions inherited from RooAbsGenContext
void resampleData (Double_t &ratio)
 Rescale existing output buffer with given ratio. More...
 
- 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

RooArgSet _allVarsPdf {}
 Prototype dataset. More...
 
Double_t_fracThresh {nullptr}
 
std::vector< int_gcIndex
 
std::vector< RooAbsGenContext * > _gcList
 
Bool_t _haveIdxProto {false}
 
RooAbsCategoryLValue_idxCat {nullptr}
 
TString _idxCatName {}
 
RooArgSet_idxCatSet {nullptr}
 
Int_t _numPdf {0}
 
const RooSimultaneous_pdf {nullptr}
 
RooDataSet_protoData {nullptr}
 
const RooDataSet_prototype {nullptr}
 
TIterator_proxyIter {nullptr}
 
- Protected Attributes inherited from RooAbsGenContext
UInt_t _expectedEvents
 
RooAbsPdf::ExtendMode _extendMode
 
RooDataSet_genData
 
Bool_t _isValid
 
Int_t _nextProtoIndex
 
TString _normRange
 
Int_t_protoOrder
 
const RooDataSet_prototype
 
RooArgSet _protoVars
 
RooArgSet_theEvent
 
Bool_t _verbose
 
- 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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Public Types inherited from RooPrintable
enum  ContentsOption {
  kName =1, kClassName =2, kValue =4, kArgs =8,
  kExtras =16, kAddress =32, kTitle =64, kCollectionHeader =128
}
 
enum  StyleOption {
  kInline =1, kSingleLine =2, kStandard =3, kVerbose =4,
  kTreeStructure =5
}
 
- Static Public Member Functions inherited from TObject
static Long_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...
 
- Static Public Member Functions inherited from RooPrintable
static std::ostream & defaultPrintStream (std::ostream *os=0)
 Return a reference to the current default stream to use in Print(). More...
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount. More...
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooSimGenContext.h>

Inheritance diagram for RooSimGenContext:
[legend]

Constructor & Destructor Documentation

◆ RooSimGenContext() [1/2]

RooSimGenContext::RooSimGenContext ( const RooSimultaneous model,
const RooArgSet vars,
const RooDataSet prototype = 0,
const RooArgSet auxProto = 0,
Bool_t  verbose = kFALSE 
)

Constructor of specialized generator context for RooSimultaneous p.d.f.s.

This context creates a dedicated context for each component p.d.f.s and delegates generation of events to the appropriate component generator context

Definition at line 61 of file RooSimGenContext.cxx.

◆ ~RooSimGenContext()

RooSimGenContext::~RooSimGenContext ( )
virtual

Destructor. Delete all owned subgenerator contexts.

Definition at line 169 of file RooSimGenContext.cxx.

◆ RooSimGenContext() [2/2]

RooSimGenContext::RooSimGenContext ( const RooSimGenContext other)
protected

Member Function Documentation

◆ attach()

void RooSimGenContext::attach ( const RooArgSet params)
virtual

Attach the index category clone to the given event buffer.

Reimplemented from RooAbsGenContext.

Definition at line 185 of file RooSimGenContext.cxx.

◆ createDataSet()

RooDataSet * RooSimGenContext::createDataSet ( const char *  name,
const char *  title,
const RooArgSet obs 
)
protectedvirtual

Create an empty dataset to hold the events that will be generated.

Reimplemented from RooAbsGenContext.

Definition at line 225 of file RooSimGenContext.cxx.

◆ generateEvent()

void RooSimGenContext::generateEvent ( RooArgSet theEvent,
Int_t  remaining 
)
protectedvirtual

Generate event appropriate for current index state.

The index state is taken either from the prototype or is generated from the fraction threshold table.

Implements RooAbsGenContext.

Definition at line 261 of file RooSimGenContext.cxx.

◆ initGenerator()

void RooSimGenContext::initGenerator ( const RooArgSet theEvent)
protectedvirtual

Perform one-time initialization of generator context.

Reimplemented from RooAbsGenContext.

Definition at line 202 of file RooSimGenContext.cxx.

◆ printMultiline()

void RooSimGenContext::printMultiline ( std::ostream &  os,
Int_t  content,
Bool_t  verbose = kFALSE,
TString  indent = "" 
) const
virtual

Detailed printing interface.

Reimplemented from RooAbsGenContext.

Definition at line 346 of file RooSimGenContext.cxx.

◆ setProtoDataOrder()

void RooSimGenContext::setProtoDataOrder ( Int_t lut)
virtual

Set the traversal order of the prototype data to that in the given lookup table.

This information is passed to all component generator contexts

Reimplemented from RooAbsGenContext.

Definition at line 333 of file RooSimGenContext.cxx.

◆ updateFractions()

void RooSimGenContext::updateFractions ( )
protected

No action needed if we have a proto index.

Definition at line 301 of file RooSimGenContext.cxx.

Member Data Documentation

◆ _allVarsPdf

RooArgSet RooSimGenContext::_allVarsPdf {}
protected

Prototype dataset.

Definition at line 61 of file RooSimGenContext.h.

◆ _fracThresh

Double_t* RooSimGenContext::_fracThresh {nullptr}
protected

Definition at line 58 of file RooSimGenContext.h.

◆ _gcIndex

std::vector<int> RooSimGenContext::_gcIndex
protected

Definition at line 54 of file RooSimGenContext.h.

◆ _gcList

std::vector<RooAbsGenContext*> RooSimGenContext::_gcList
protected

Definition at line 53 of file RooSimGenContext.h.

◆ _haveIdxProto

Bool_t RooSimGenContext::_haveIdxProto {false}
protected

Definition at line 55 of file RooSimGenContext.h.

◆ _idxCat

RooAbsCategoryLValue* RooSimGenContext::_idxCat {nullptr}
protected

Definition at line 49 of file RooSimGenContext.h.

◆ _idxCatName

TString RooSimGenContext::_idxCatName {}
protected

Definition at line 56 of file RooSimGenContext.h.

◆ _idxCatSet

RooArgSet* RooSimGenContext::_idxCatSet {nullptr}
protected

Definition at line 50 of file RooSimGenContext.h.

◆ _numPdf

Int_t RooSimGenContext::_numPdf {0}
protected

Definition at line 57 of file RooSimGenContext.h.

◆ _pdf

const RooSimultaneous* RooSimGenContext::_pdf {nullptr}
protected

Definition at line 52 of file RooSimGenContext.h.

◆ _protoData

RooDataSet* RooSimGenContext::_protoData {nullptr}
protected

Definition at line 59 of file RooSimGenContext.h.

◆ _prototype

const RooDataSet* RooSimGenContext::_prototype {nullptr}
protected

Definition at line 51 of file RooSimGenContext.h.

◆ _proxyIter

TIterator* RooSimGenContext::_proxyIter {nullptr}
protected

Definition at line 62 of file RooSimGenContext.h.

Libraries for RooSimGenContext:
[legend]

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