Logo ROOT  
Reference Guide
RooRealVar.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Project: RooFit *
3  * Package: RooFitCore *
4  * File: $Id: RooRealVar.h,v 1.54 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_REAL_VAR
17 #define ROO_REAL_VAR
18 
19 #include "RooAbsRealLValue.h"
20 
21 #include "TString.h"
22 
23 #include <list>
24 #include <string>
25 #include <map>
26 #include <memory>
27 #include <unordered_map>
28 
29 
30 class RooArgSet ;
31 class RooErrorVar ;
32 class RooVectorDataStore ;
35 namespace RooBatchCompute{
36 struct RunContext;
37 }
38 
39 class RooRealVar : public RooAbsRealLValue {
40 public:
41  // Constructors, assignment etc.
42  RooRealVar() ;
43  RooRealVar(const char *name, const char *title,
44  Double_t value, const char *unit= "") ;
45  RooRealVar(const char *name, const char *title, Double_t minValue,
46  Double_t maxValue, const char *unit= "");
47  RooRealVar(const char *name, const char *title, Double_t value,
48  Double_t minValue, Double_t maxValue, const char *unit= "") ;
49  RooRealVar(const RooRealVar& other, const char* name=0);
50  RooRealVar& operator=(const RooRealVar& other);
51  virtual TObject* clone(const char* newname) const { return new RooRealVar(*this,newname); }
52  virtual ~RooRealVar();
53 
54  // Parameter value and error accessors
55  virtual Double_t getValV(const RooArgSet* nset=0) const ;
57 
58  virtual void setVal(Double_t value);
59  virtual void setVal(Double_t value, const char* rangeName);
60  inline Double_t getError() const { return _error>=0?_error:0. ; }
61  inline Bool_t hasError(Bool_t allowZero=kTRUE) const { return allowZero ? (_error>=0) : (_error>0) ; }
62  inline void setError(Double_t value) { _error= value ; }
63  inline void removeError() { _error = -1 ; }
64  inline Double_t getAsymErrorLo() const { return _asymErrLo<=0?_asymErrLo:0. ; }
65  inline Double_t getAsymErrorHi() const { return _asymErrHi>=0?_asymErrHi:0. ; }
66  inline Bool_t hasAsymError(Bool_t allowZero=kTRUE) const { return allowZero ? ((_asymErrHi>=0 && _asymErrLo<=0)) : ((_asymErrHi>0 && _asymErrLo<0)) ; }
67  inline void removeAsymError() { _asymErrLo = 1 ; _asymErrHi = -1 ; }
68  inline void setAsymError(Double_t lo, Double_t hi) { _asymErrLo = lo ; _asymErrHi = hi ; }
69  inline Double_t getErrorLo() const { return _asymErrLo<=0?_asymErrLo:-1*_error ; }
70  inline Double_t getErrorHi() const { return _asymErrHi>=0?_asymErrHi:_error ; }
71 
72  RooErrorVar* errorVar() const ;
73 
74  // Set/get finite fit range limits
75  void setMin(const char* name, Double_t value) ;
76  void setMax(const char* name, Double_t value) ;
77  void setRange(const char* name, Double_t min, Double_t max) ;
78  void setRange(const char* name, RooAbsReal& min, RooAbsReal& max) ;
79  inline void setMin(Double_t value) { setMin(0,value) ; }
80  inline void setMax(Double_t value) { setMax(0,value) ; }
81  /// Set the limits of the default range.
82  inline void setRange(Double_t min, Double_t max) { setRange(0,min,max) ; }
83  /// Set parameterised limits of the default range. See setRange(const char*, RooAbsReal&, RooAbsReal&).
84  inline void setRange(RooAbsReal& min, RooAbsReal& max) { setRange(0,min,max) ; }
85 
86  void setBins(Int_t nBins, const char* name=0);
87  void setBinning(const RooAbsBinning& binning, const char* name=0) ;
88 
89  // RooAbsRealLValue implementation
90  Bool_t hasBinning(const char* name) const ;
91  const RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const ;
92  RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) ;
93  std::list<std::string> getBinningNames() const ;
94 
95  // Set infinite fit range limits
96  /// Remove lower range limit for binning with given name. Empty name means default range.
97  void removeMin(const char* name=0);
98  /// Remove upper range limit for binning with given name. Empty name means default range.
99  void removeMax(const char* name=0);
100  /// Remove range limits for binning with given name. Empty name means default range.
101  void removeRange(const char* name=0);
102 
103  // I/O streaming interface (machine readable)
104  virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
105  virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
106 
107  // We implement a fundamental type of AbsArg that can be stored in a dataset
108  inline virtual Bool_t isFundamental() const { return kTRUE; }
109 
110  // Force to be a leaf-node of any expression tree, even if we have (shape) servers
111  virtual Bool_t isDerived() const {
112  // Does value or shape of this arg depend on any other arg?
113  return !_serverList.empty() || _proxyList.GetEntries()>0;
114  }
115 
116  // Printing interface (human readable)
117  virtual void printValue(std::ostream& os) const ;
118  virtual void printExtras(std::ostream& os) const ;
119  virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
120  virtual Int_t defaultPrintContents(Option_t* opt) const ;
121 
122 
123  TString* format(const RooCmdArg& formatArg) const ;
124  TString* format(Int_t sigDigits, const char *options) const ;
125 
126  static void printScientific(Bool_t flag=kFALSE) ;
127  static void printSigDigits(Int_t ndig=5) ;
128 
129  using RooAbsRealLValue::operator= ;
130 
131  void deleteSharedProperties() ;
132 
133  void copyCacheFast(const RooRealVar& other, Bool_t setValDirty=kTRUE) { _value = other._value ; if (setValDirty) setValueDirty() ; }
134 
135  protected:
136 
139 
140  friend class RooAbsRealLValue ;
141  virtual void setValFast(Double_t value) { _value = value ; setValueDirty() ; }
142 
143 
144  virtual Double_t evaluate() const { return _value ; } // dummy because we overloaded getVal()
145  virtual void copyCache(const RooAbsArg* source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE) ;
146  virtual void attachToTree(TTree& t, Int_t bufSize=32000) ;
147  virtual void attachToVStore(RooVectorDataStore& vstore) ;
148  virtual void fillTreeBranch(TTree& t) ;
149 
150  Double_t chopAt(Double_t what, Int_t where) const ;
151 
152  Double_t _error; // Symmetric error associated with current value
153  Double_t _asymErrLo ; // Low side of asymmetric error associated with current value
154  Double_t _asymErrHi ; // High side of asymmetric error associated with current value
155  std::unique_ptr<RooAbsBinning> _binning;
156  std::unordered_map<std::string,std::unique_ptr<RooAbsBinning>> _altNonSharedBinning ; //! Non-shareable alternative binnings
157 
158  std::shared_ptr<RooRealVarSharedProperties> sharedProp() const;
159  void installSharedProp(std::shared_ptr<RooRealVarSharedProperties>&& prop);
160 
161  virtual void setExpensiveObjectCache(RooExpensiveObjectCache&) { ; } // variables don't need caches
162  static RooRealVarSharedProperties& _nullProp(); // Null property
163  static std::map<std::string,std::weak_ptr<RooRealVarSharedProperties>>& _sharedPropList(); // List of properties shared among clones of a variable
164 
165  std::shared_ptr<RooRealVarSharedProperties> _sharedProp; //! Shared binnings associated with this instance
166 
167  ClassDef(RooRealVar,7) // Real-valued variable
168 };
169 
170 
171 
172 
173 #endif
RooRealVar::getAsymErrorHi
Double_t getAsymErrorHi() const
Definition: RooRealVar.h:65
RooRealVar::_asymErrLo
Double_t _asymErrLo
Definition: RooRealVar.h:153
RooCmdArg
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:27
RooRealVarSharedProperties
Class RooRealVarSharedProperties is an implementation of RooSharedProperties that stores the properti...
Definition: RooRealVarSharedProperties.h:27
RooRealVar::_sharedProp
std::shared_ptr< RooRealVarSharedProperties > _sharedProp
Definition: RooRealVar.h:165
RooRealVar::setVal
virtual void setVal(Double_t value)
Set value of variable to 'value'.
Definition: RooRealVar.cxx:257
kTRUE
const Bool_t kTRUE
Definition: RtypesCore.h:91
RooRealVar::_altNonSharedBinning
std::unordered_map< std::string, std::unique_ptr< RooAbsBinning > > _altNonSharedBinning
Definition: RooRealVar.h:156
RooRealVar::installSharedProp
void installSharedProp(std::shared_ptr< RooRealVarSharedProperties > &&prop)
Install the shared property into the member _sharedProp.
Definition: RooRealVar.cxx:1288
Option_t
const char Option_t
Definition: RtypesCore.h:66
RooRealVar::printSigDigits
static void printSigDigits(Int_t ndig=5)
Set number of digits to show when printing RooRealVars.
Definition: RooRealVar.cxx:1338
RooRealVar::setMin
void setMin(const char *name, Double_t value)
Set minimum of name range to given value.
Definition: RooRealVar.cxx:461
RooRealVar::evaluate
virtual Double_t evaluate() const
Evaluate this PDF / function / constant. Needs to be overridden by all derived classes.
Definition: RooRealVar.h:144
RooRealVar::_printScientific
static Bool_t _printScientific
Definition: RooRealVar.h:137
RooRealVar::getBinningNames
std::list< std::string > getBinningNames() const
Get a list of all binning names.
Definition: RooRealVar.cxx:376
RooRealVar::format
TString * format(const RooCmdArg &formatArg) const
Format contents of RooRealVar for pretty printing on RooPlot parameter boxes.
Definition: RooRealVar.cxx:857
RooAbsArg::_serverList
RefCountList_t _serverList
Definition: RooAbsArg.h:594
TTree
A TTree represents a columnar dataset.
Definition: TTree.h:79
RooRealVar::operator=
RooAbsRealLValue & operator=(const RooAbsRealLValue &)=default
RooRealVar::fillTreeBranch
virtual void fillTreeBranch(TTree &t)
Overload RooAbsReal::fillTreeBranch to also fill tree branches with (asymmetric) errors if requested.
Definition: RooRealVar.cxx:1155
RooRealVar::setMax
void setMax(Double_t value)
Definition: RooRealVar.h:80
RooRealVar::removeAsymError
void removeAsymError()
Definition: RooRealVar.h:67
TObjArray::GetEntries
Int_t GetEntries() const
Return the number of objects in array (i.e.
Definition: TObjArray.cxx:523
indent
static void indent(ostringstream &buf, int indent_level)
Definition: TClingCallFunc.cxx:87
RooAbsReal
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:61
RooErrorVar
RooErrorVar is an auxilary class that represents the error of a RooRealVar as a seperate object.
Definition: RooErrorVar.h:28
RooRealVar::writeToStream
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
Definition: RooRealVar.cxx:707
RooRealVar::_sharedPropList
static std::map< std::string, std::weak_ptr< RooRealVarSharedProperties > > & _sharedPropList()
Return a reference to a map of weak pointers to RooRealVarSharedProperties.
Definition: RooRealVar.cxx:58
RooRealVar::~RooRealVar
virtual ~RooRealVar()
Destructor.
Definition: RooRealVar.cxx:208
RooRealVar::chopAt
Double_t chopAt(Double_t what, Int_t where) const
Utility to calculate number of decimals to show based on magnitude of error.
Definition: RooRealVar.cxx:1055
TString
Basic string class.
Definition: TString.h:136
RooRealVar::copyCache
virtual void copyCache(const RooAbsArg *source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE)
Copy the cached value of another RooAbsArg to our cache Warning: This function copies the cached valu...
Definition: RooRealVar.cxx:1193
RooRealVar::setRange
void setRange(const char *name, Double_t min, Double_t max)
Set a fit or plotting range.
Definition: RooRealVar.cxx:526
RooSTLRefCountList::empty
bool empty() const
Check if empty.
Definition: RooSTLRefCountList.h:114
RooRealVar::printValue
virtual void printValue(std::ostream &os) const
Print value of variable.
Definition: RooRealVar.cxx:772
TString.h
RooRealVar::errorVar
RooErrorVar * errorVar() const
Return a RooAbsRealLValue representing the error associated with this variable.
Definition: RooRealVar.cxx:291
RooExpensiveObjectCache
RooExpensiveObjectCache is a singleton class that serves as repository for objects that are expensive...
Definition: RooExpensiveObjectCache.h:24
bool
RooRealVar::setRange
void setRange(Double_t min, Double_t max)
Set the limits of the default range.
Definition: RooRealVar.h:82
RooRealVar::readFromStream
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
Definition: RooRealVar.cxx:568
hi
float type_of_call hi(const int &, const int &)
RooRealVar::attachToVStore
virtual void attachToVStore(RooVectorDataStore &vstore)
Overload RooAbsReal::attachToTree to also attach branches for errors and/or asymmetric errors attribu...
Definition: RooRealVar.cxx:1069
RooRealVar::setMin
void setMin(Double_t value)
Definition: RooRealVar.h:79
RooRealVar::_nullProp
static RooRealVarSharedProperties & _nullProp()
Return a dummy object to use when properties are not initialised.
Definition: RooRealVar.cxx:65
RooRealVar::RooRealVar
RooRealVar()
Default constructor.
Definition: RooRealVar.cxx:74
RooRealVar::_asymErrHi
Double_t _asymErrHi
Definition: RooRealVar.h:154
RooRealVar::getError
Double_t getError() const
Definition: RooRealVar.h:60
RooRealVar::getAsymErrorLo
Double_t getAsymErrorLo() const
Definition: RooRealVar.h:64
RooRealVar::getErrorHi
Double_t getErrorHi() const
Definition: RooRealVar.h:70
RooRealVar::removeError
void removeError()
Definition: RooRealVar.h:63
RooRealVar::removeMax
void removeMax(const char *name=0)
Remove upper range limit for binning with given name. Empty name means default range.
Definition: RooRealVar.cxx:396
RooRealVar::clone
virtual TObject * clone(const char *newname) const
Definition: RooRealVar.h:51
kFALSE
const Bool_t kFALSE
Definition: RtypesCore.h:92
RooRealVar::setError
void setError(Double_t value)
Definition: RooRealVar.h:62
RooRealVar::hasBinning
Bool_t hasBinning(const char *name) const
Returns true if variable has a binning named 'name'.
Definition: RooRealVar.cxx:305
RooAbsBinning
RooAbsBinning is the abstract base class for RooRealVar binning definitions.
Definition: RooAbsBinning.h:26
RooRealVar::isFundamental
virtual Bool_t isFundamental() const
Is this object a fundamental type that can be added to a dataset? Fundamental-type subclasses overrid...
Definition: RooRealVar.h:108
RooRealVar::isDerived
virtual Bool_t isDerived() const
Does value or shape of this arg depend on any other arg?
Definition: RooRealVar.h:111
what
static const char * what
Definition: stlLoader.cc:6
RooAbsReal::_value
Double_t _value
Definition: RooAbsReal.h:461
RooRealVar::attachToTree
virtual void attachToTree(TTree &t, Int_t bufSize=32000)
Overload RooAbsReal::attachToTree to also attach branches for errors and/or asymmetric errors attribu...
Definition: RooRealVar.cxx:1102
RooRealVar::printExtras
virtual void printExtras(std::ostream &os) const
Print extras of variable: (asymmetric) error, constant flag, limits and binning.
Definition: RooRealVar.cxx:788
RooRealVar::getBinning
const RooAbsBinning & getBinning(const char *name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const
Return binning definition with name.
Definition: RooRealVar.cxx:318
RooRealVar::defaultPrintContents
virtual Int_t defaultPrintContents(Option_t *opt) const
Mapping of Print() option string to RooPrintable contents specifications.
Definition: RooRealVar.cxx:828
RooRealVar::getValV
virtual Double_t getValV(const RooArgSet *nset=0) const
Return value of variable.
Definition: RooRealVar.cxx:217
RooRealVar::setMax
void setMax(const char *name, Double_t value)
Set maximum of name range to given value.
Definition: RooRealVar.cxx:491
Double_t
double Double_t
Definition: RtypesCore.h:59
RooAbsArg::_proxyList
RooRefArray _proxyList
Definition: RooAbsArg.h:599
RooRealVar::setRange
void setRange(RooAbsReal &min, RooAbsReal &max)
Set parameterised limits of the default range. See setRange(const char*, RooAbsReal&,...
Definition: RooRealVar.h:84
RooRealVar::copyCacheFast
void copyCacheFast(const RooRealVar &other, Bool_t setValDirty=kTRUE)
Definition: RooRealVar.h:133
RooRealVar::setValFast
virtual void setValFast(Double_t value)
Definition: RooRealVar.h:141
RooRealVar::setBinning
void setBinning(const RooAbsBinning &binning, const char *name=0)
Add given binning under name 'name' with this variable.
Definition: RooRealVar.cxx:415
RooRealVar::setExpensiveObjectCache
virtual void setExpensiveObjectCache(RooExpensiveObjectCache &)
Definition: RooRealVar.h:161
RooRealVar::printScientific
static void printScientific(Bool_t flag=kFALSE)
If true, contents of RooRealVars will be printed in scientific notation.
Definition: RooRealVar.cxx:1329
RooVectorDataStore
RooVectorDataStore uses std::vectors to store data columns.
Definition: RooVectorDataStore.h:36
RooRealVar::hasAsymError
Bool_t hasAsymError(Bool_t allowZero=kTRUE) const
Definition: RooRealVar.h:66
TObject
Mother of all ROOT objects.
Definition: TObject.h:37
ClassDef
#define ClassDef(name, id)
Definition: Rtypes.h:325
RooRealVar::sharedProp
std::shared_ptr< RooRealVarSharedProperties > sharedProp() const
Non-shareable alternative binnings.
Definition: RooRealVar.cxx:1274
RooRealVar::removeRange
void removeRange(const char *name=0)
Remove range limits for binning with given name. Empty name means default range.
Definition: RooRealVar.cxx:399
name
char name[80]
Definition: TGX11.cxx:110
RooBatchCompute
VDT headers for RooFit.
Definition: BracketAdapter.h:24
RooRealVar::removeMin
void removeMin(const char *name=0)
Remove lower range limit for binning with given name. Empty name means default range.
Definition: RooRealVar.cxx:393
genreflex::verbose
bool verbose
Definition: rootcling_impl.cxx:133
RooRealVar::_binning
std::unique_ptr< RooAbsBinning > _binning
Definition: RooRealVar.h:155
RooRealVar::_printSigDigits
static Int_t _printSigDigits
Definition: RooRealVar.h:138
RooAbsArg
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:72
RooRealVar::_error
Double_t _error
Definition: RooRealVar.h:152
RooAbsArg::setValueDirty
void setValueDirty()
Mark the element dirty. This forces a re-evaluation when a value is requested.
Definition: RooAbsArg.h:488
RooRealVar::setAsymError
void setAsymError(Double_t lo, Double_t hi)
Definition: RooRealVar.h:68
RooRealVar::getErrorLo
Double_t getErrorLo() const
Definition: RooRealVar.h:69
RooRealVar::setBins
void setBins(Int_t nBins, const char *name=0)
Create a uniform binning under name 'name' for this variable.
Definition: RooRealVar.cxx:408
RooRealVar
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:39
RooAbsRealLValue
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
Definition: RooAbsRealLValue.h:31
RooRealVar::getValues
RooSpan< const double > getValues(RooBatchCompute::RunContext &inputData, const RooArgSet *) const final
Retrieve data column of this variable.
Definition: RooRealVar.cxx:231
RooAbsRealLValue.h
RooRealVar::deleteSharedProperties
void deleteSharedProperties()
Stop sharing properties.
Definition: RooRealVar.cxx:1312
RooBatchCompute::RunContext
Data that has to be passed around when evaluating functions / PDFs.
Definition: RunContext.h:32
RooSpan
A simple container to hold a batch of data values.
Definition: RooSpan.h:34
RooArgSet
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:29
RooRealVar::hasError
Bool_t hasError(Bool_t allowZero=kTRUE) const
Definition: RooRealVar.h:61
int
RooRealVar::printMultiline
virtual void printMultiline(std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
Detailed printing interface.
Definition: RooRealVar.cxx:840