Logo ROOT  
Reference Guide
RooAbsGenContext.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooAbsGenContext.h,v 1.15 2007/05/11 09:11:30 verkerke Exp $
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16#ifndef ROO_ABS_GEN_CONTEXT
17#define ROO_ABS_GEN_CONTEXT
18
19#include "TNamed.h"
20#include "RooPrintable.h"
21#include "RooArgSet.h"
22#include "RooAbsPdf.h"
23
24class RooDataSet;
25
26class RooAbsGenContext : public TNamed, public RooPrintable {
27public:
28 RooAbsGenContext(const RooAbsPdf &model, const RooArgSet &vars, const RooDataSet *prototype= 0, const RooArgSet* auxProto=0,
29 bool _verbose= false) ;
30 ~RooAbsGenContext() override;
31
32 virtual RooDataSet *generate(double nEvents= 0, bool skipInit=false, bool extendedMode=false);
33
34 bool isValid() const {
35 // If true generator context is in a valid state
36 return _isValid;
37 }
38
39 inline void setVerbose(bool verbose= true) {
40 // Set/clear verbose messaging
42 }
43 inline bool isVerbose() const {
44 // If true verbose messaging is active
45 return _verbose;
46 }
47
48 virtual void setProtoDataOrder(Int_t* lut) ;
49
50 inline void Print(Option_t *options= 0) const override {
51 // Print context information on stdout
53 }
54
55 virtual void attach(const RooArgSet& params) ;
56
57 void printName(std::ostream& os) const override ;
58 void printTitle(std::ostream& os) const override ;
59 void printClassName(std::ostream& os) const override ;
60 void printArgs(std::ostream& os) const override ;
61 void printMultiline(std::ostream& os, Int_t contents, bool verbose=false, TString indent="") const override;
62
63 Int_t defaultPrintContents(Option_t* opt) const override ;
64 StyleOption defaultPrintStyle(Option_t* opt) const override ;
65
66 virtual void setExpectedData(bool) {} ;
67
68 virtual void generateEvent(RooArgSet &theEvent, Int_t remaining) = 0;
69 virtual void initGenerator(const RooArgSet &theEvent);
70
71protected:
72
73 virtual RooDataSet* createDataSet(const char* name, const char* title, const RooArgSet& obs) ;
74
75 void resampleData(double& ratio) ;
76
77 const RooDataSet *_prototype; ///< Pointer to prototype dataset
78 RooArgSet _theEvent; ///< Pointer to observable event being generated
79 bool _isValid; ///< Is context in valid state?
80 bool _verbose; ///< Verbose messaging?
81 UInt_t _expectedEvents; ///< Number of expected events from extended p.d.f
82 RooArgSet _protoVars; ///< Prototype observables
83 Int_t _nextProtoIndex; ///< Next prototype event to load according to LUT
84 RooAbsPdf::ExtendMode _extendMode ; ///< Extended mode capabilities of p.d.f.
85 Int_t* _protoOrder ; ///< LUT with traversal order of prototype data
86 TString _normRange ; ///< Normalization range of pdf
87
88 RooDataSet* _genData ; ///<! Data being generated
89
90 ClassDefOverride(RooAbsGenContext,0) // Abstract context for generating a dataset from a PDF
91};
92
93#endif
const char Option_t
Definition: RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
static void indent(ostringstream &buf, int indent_level)
char name[80]
Definition: TGX11.cxx:110
RooAbsGenContext is the abstract base class for generator contexts of RooAbsPdf objects.
virtual RooDataSet * createDataSet(const char *name, const char *title, const RooArgSet &obs)
Create an empty dataset to hold the events that will be generated.
RooAbsPdf::ExtendMode _extendMode
Extended mode capabilities of p.d.f.
virtual void setExpectedData(bool)
StyleOption defaultPrintStyle(Option_t *opt) const override
Define default print style.
Int_t defaultPrintContents(Option_t *opt) const override
Define default contents when printing.
void setVerbose(bool verbose=true)
virtual void attach(const RooArgSet &params)
Interface to attach given parameters to object in this context.
RooDataSet * _genData
! Data being generated
virtual RooDataSet * generate(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 genera...
void printClassName(std::ostream &os) const override
Print class name of context.
void printName(std::ostream &os) const override
Print name of context.
virtual void initGenerator(const RooArgSet &theEvent)
Interface function to initialize context for generation for given set of observables.
RooArgSet _theEvent
Pointer to observable event being generated.
void Print(Option_t *options=0) const override
Print TNamed name and title.
RooAbsGenContext(const RooAbsPdf &model, const RooArgSet &vars, const RooDataSet *prototype=0, const RooArgSet *auxProto=0, bool _verbose=false)
Constructor.
void printMultiline(std::ostream &os, Int_t contents, bool verbose=false, TString indent="") const override
Interface for multi-line printing.
~RooAbsGenContext() override
Destructor.
const RooDataSet * _prototype
Pointer to prototype dataset.
Int_t * _protoOrder
LUT with traversal order of prototype data.
TString _normRange
Normalization range of pdf.
void printArgs(std::ostream &os) const override
Print arguments of context, i.e. the observables being generated in this context.
UInt_t _expectedEvents
Number of expected events from extended p.d.f.
Int_t _nextProtoIndex
Next prototype event to load according to LUT.
RooArgSet _protoVars
Prototype observables.
void printTitle(std::ostream &os) const override
Print title of context.
virtual void generateEvent(RooArgSet &theEvent, Int_t remaining)=0
bool _verbose
Verbose messaging?
bool _isValid
Is context in valid state?
bool isValid() const
virtual void setProtoDataOrder(Int_t *lut)
Set the traversal order of prototype data to that in the lookup tables passed as argument.
bool isVerbose() const
void resampleData(double &ratio)
Rescale existing output buffer with given ratio.
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:57
RooDataSet is a container class to hold unbinned data.
Definition: RooDataSet.h:55
RooPlotable is a 'mix-in' base class that define the standard RooFit plotting and printing methods.
Definition: RooPrintable.h:25
static std::ostream & defaultPrintStream(std::ostream *os=0)
Return a reference to the current default stream to use in Print().
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,...
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Basic string class.
Definition: TString.h:136