Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
RooAbsGenContext Class Referenceabstract

Abstract base class for generator contexts of RooAbsPdf objects.

A generator context is an object that controls the generation of events from a given p.d.f in one or more sessions. This class defines the common interface for all such contexts and organizes storage of common components, such as the observables definition, the prototype data etc..

Definition at line 26 of file RooAbsGenContext.h.

Public Member Functions

 RooAbsGenContext (const RooAbsPdf &model, const RooArgSet &vars, const RooDataSet *prototype=nullptr, const RooArgSet *auxProto=nullptr, bool _verbose=false)
 Constructor.
 
virtual void attach (const RooArgSet &params)
 Interface to attach given parameters to object in this context.
 
Int_t defaultPrintContents (Option_t *opt) const override
 Define default contents when printing.
 
StyleOption defaultPrintStyle (Option_t *opt) const override
 Define default print style.
 
virtual RooDataSetgenerate (double nEvents=0, bool skipInit=false, bool extendedMode=false)
 Generate the specified number of events with nEvents>0 and and return a dataset containing the generated events.
 
virtual void generateEvent (RooArgSet &theEvent, Int_t remaining)=0
 
virtual void initGenerator (const RooArgSet &theEvent)
 Interface function to initialize context for generation for given set of observables.
 
TClassIsA () const override
 
bool isValid () const
 
bool isVerbose () const
 
void Print (Option_t *options=nullptr) const override
 This method must be overridden when a class wants to print itself.
 
void printArgs (std::ostream &os) const override
 Print arguments of context, i.e. the observables being generated in this context.
 
void printClassName (std::ostream &os) const override
 Print class name of context.
 
void printMultiline (std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
 Interface for multi-line printing.
 
void printName (std::ostream &os) const override
 Print name of context.
 
void printTitle (std::ostream &os) const override
 Print title of context.
 
virtual void setExpectedData (bool)
 
virtual void setProtoDataOrder (Int_t *lut)
 Set the traversal order of prototype data to that in the lookup tables passed as argument.
 
void setVerbose (bool verbose=true)
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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, 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)
 
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.
 
- Public Member Functions inherited from RooPrintable
 RooPrintable ()
 
virtual ~RooPrintable ()
 
virtual void printAddress (std::ostream &os) const
 Print class name of object.
 
virtual void printExtras (std::ostream &os) const
 Interface to print extras of object.
 
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'.
 
virtual void printTree (std::ostream &os, TString indent="") const
 Interface for tree structure printing of object.
 
virtual void printValue (std::ostream &os) const
 Interface to print value of object.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

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.
 
- Static Public Member Functions inherited from RooPrintable
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static std::ostream & defaultPrintStream (std::ostream *os=nullptr)
 Return a reference to the current default stream to use in Print().
 
static void nameFieldLength (Int_t newLen)
 Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.
 

Protected Member Functions

virtual RooDataSetcreateDataSet (const char *name, const char *title, const RooArgSet &obs)
 Create an empty dataset to hold the events that will be generated.
 
void resampleData (double &ratio)
 Rescale existing output buffer with given ratio.
 
- 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

UInt_t _expectedEvents
 Number of expected events from extended p.d.f.
 
RooAbsPdf::ExtendMode _extendMode
 Extended mode capabilities of p.d.f.
 
RooDataSet_genData = nullptr
 ! Data being generated
 
bool _isValid
 Is context in valid state?
 
Int_t _nextProtoIndex
 Next prototype event to load according to LUT.
 
TString _normRange
 Normalization range of pdf.
 
std::vector< Int_t_protoOrder
 LUT with traversal order of prototype data.
 
const RooDataSet_prototype
 Pointer to prototype dataset.
 
RooArgSet _protoVars
 Prototype observables.
 
RooArgSet _theEvent
 Pointer to observable event being generated.
 
bool _verbose
 Verbose messaging?
 
- 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 ))
}
 
- 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
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Static Protected Attributes inherited from RooPrintable
static Int_t _nameLength
 

#include <RooAbsGenContext.h>

Inheritance diagram for RooAbsGenContext:
[legend]

Constructor & Destructor Documentation

◆ RooAbsGenContext()

RooAbsGenContext::RooAbsGenContext ( const RooAbsPdf model,
const RooArgSet vars,
const RooDataSet prototype = nullptr,
const RooArgSet auxProto = nullptr,
bool  _verbose = false 
)

Constructor.

Definition at line 49 of file RooAbsGenContext.cxx.

Member Function Documentation

◆ attach()

void RooAbsGenContext::attach ( const RooArgSet params)
virtual

Interface to attach given parameters to object in this context.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 103 of file RooAbsGenContext.cxx.

◆ Class()

static TClass * RooAbsGenContext::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 89 of file RooAbsGenContext.h.

◆ createDataSet()

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

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

Reimplemented in RooSimGenContext, and RooSimSplitGenContext.

Definition at line 112 of file RooAbsGenContext.cxx.

◆ DeclFileName()

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

Definition at line 89 of file RooAbsGenContext.h.

◆ defaultPrintContents()

Int_t RooAbsGenContext::defaultPrintContents ( Option_t opt) const
overridevirtual

Define default contents when printing.

Reimplemented from RooPrintable.

Definition at line 367 of file RooAbsGenContext.cxx.

◆ defaultPrintStyle()

RooPrintable::StyleOption RooAbsGenContext::defaultPrintStyle ( Option_t opt) const
overridevirtual

Define default print style.

Reimplemented from RooPrintable.

Definition at line 377 of file RooAbsGenContext.cxx.

◆ generate()

RooDataSet * RooAbsGenContext::generate ( double  nEvents = 0,
bool  skipInit = false,
bool  extendedMode = false 
)
virtual

Generate the specified number of events with nEvents>0 and and return a dataset containing the generated events.

With nEvents<=0, generate the number of events in the prototype dataset, if available, or else the expected number of events, if non-zero. If extendedMode = true generate according to a Poisson(nEvents) The returned dataset belongs to the caller. Return zero in case of an error. Generation of individual events is delegated to a virtual generateEvent() method. A virtual initGenerator() method is also called just before the first call to generateEvent().

Reimplemented in RooSimSplitGenContext, and RooBinnedGenContext.

Definition at line 131 of file RooAbsGenContext.cxx.

◆ generateEvent()

virtual void RooAbsGenContext::generateEvent ( RooArgSet theEvent,
Int_t  remaining 
)
pure virtual

◆ initGenerator()

void RooAbsGenContext::initGenerator ( const RooArgSet theEvent)
virtual

Interface function to initialize context for generation for given set of observables.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooEffGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 247 of file RooAbsGenContext.cxx.

◆ IsA()

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

Reimplemented from TObject.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooEffGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 89 of file RooAbsGenContext.h.

◆ isValid()

bool RooAbsGenContext::isValid ( ) const
inline

Definition at line 33 of file RooAbsGenContext.h.

◆ isVerbose()

bool RooAbsGenContext::isVerbose ( ) const
inline

Definition at line 42 of file RooAbsGenContext.h.

◆ Print()

void RooAbsGenContext::Print ( Option_t option = nullptr) const
inlineoverridevirtual

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 49 of file RooAbsGenContext.h.

◆ printArgs()

void RooAbsGenContext::printArgs ( std::ostream &  os) const
overridevirtual

Print arguments of context, i.e. the observables being generated in this context.

Reimplemented from RooPrintable.

Definition at line 286 of file RooAbsGenContext.cxx.

◆ printClassName()

void RooAbsGenContext::printClassName ( std::ostream &  os) const
overridevirtual

Print class name of context.

Reimplemented from RooPrintable.

Definition at line 276 of file RooAbsGenContext.cxx.

◆ printMultiline()

void RooAbsGenContext::printMultiline ( std::ostream &  os,
Int_t  contents,
bool  verbose = false,
TString  indent = "" 
) const
overridevirtual

Interface for multi-line printing.

Reimplemented from RooPrintable.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooEffGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 306 of file RooAbsGenContext.cxx.

◆ printName()

void RooAbsGenContext::printName ( std::ostream &  os) const
overridevirtual

Print name of context.

Reimplemented from RooPrintable.

Definition at line 256 of file RooAbsGenContext.cxx.

◆ printTitle()

void RooAbsGenContext::printTitle ( std::ostream &  os) const
overridevirtual

Print title of context.

Reimplemented from RooPrintable.

Definition at line 266 of file RooAbsGenContext.cxx.

◆ resampleData()

void RooAbsGenContext::resampleData ( double ratio)
protected

Rescale existing output buffer with given ratio.

Definition at line 338 of file RooAbsGenContext.cxx.

◆ setExpectedData()

virtual void RooAbsGenContext::setExpectedData ( bool  )
inlinevirtual

Reimplemented in RooBinnedGenContext, and RooSimSplitGenContext.

Definition at line 65 of file RooAbsGenContext.h.

◆ setProtoDataOrder()

void RooAbsGenContext::setProtoDataOrder ( Int_t lut)
virtual

Set the traversal order of prototype data to that in the lookup tables passed as argument.

The LUT must be an array of integers with the same size as the number of entries in the prototype dataset and must contain integer values in the range [0,Nevt-1]

Reimplemented in RooBinnedGenContext, RooAddGenContext, RooConvGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 319 of file RooAbsGenContext.cxx.

◆ setVerbose()

void RooAbsGenContext::setVerbose ( bool  verbose = true)
inline

Definition at line 38 of file RooAbsGenContext.h.

◆ Streamer()

void RooAbsGenContext::Streamer ( TBuffer R__b)
overridevirtual

◆ StreamerNVirtual()

void RooAbsGenContext::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 89 of file RooAbsGenContext.h.

Member Data Documentation

◆ _expectedEvents

UInt_t RooAbsGenContext::_expectedEvents
protected

Number of expected events from extended p.d.f.

Definition at line 80 of file RooAbsGenContext.h.

◆ _extendMode

RooAbsPdf::ExtendMode RooAbsGenContext::_extendMode
protected

Extended mode capabilities of p.d.f.

Definition at line 83 of file RooAbsGenContext.h.

◆ _genData

RooDataSet* RooAbsGenContext::_genData = nullptr
protected

! Data being generated

Definition at line 87 of file RooAbsGenContext.h.

◆ _isValid

bool RooAbsGenContext::_isValid
protected

Is context in valid state?

Definition at line 78 of file RooAbsGenContext.h.

◆ _nextProtoIndex

Int_t RooAbsGenContext::_nextProtoIndex
protected

Next prototype event to load according to LUT.

Definition at line 82 of file RooAbsGenContext.h.

◆ _normRange

TString RooAbsGenContext::_normRange
protected

Normalization range of pdf.

Definition at line 85 of file RooAbsGenContext.h.

◆ _protoOrder

std::vector<Int_t> RooAbsGenContext::_protoOrder
protected

LUT with traversal order of prototype data.

Definition at line 84 of file RooAbsGenContext.h.

◆ _prototype

const RooDataSet* RooAbsGenContext::_prototype
protected

Pointer to prototype dataset.

Definition at line 76 of file RooAbsGenContext.h.

◆ _protoVars

RooArgSet RooAbsGenContext::_protoVars
protected

Prototype observables.

Definition at line 81 of file RooAbsGenContext.h.

◆ _theEvent

RooArgSet RooAbsGenContext::_theEvent
protected

Pointer to observable event being generated.

Definition at line 77 of file RooAbsGenContext.h.

◆ _verbose

bool RooAbsGenContext::_verbose
protected

Verbose messaging?

Definition at line 79 of file RooAbsGenContext.h.

Libraries for RooAbsGenContext:

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