Logo ROOT   master
Reference Guide
RooAbsRealLValue.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Project: RooFit *
3  * Package: RooFitCore *
4  * File: $Id: RooAbsRealLValue.h,v 1.37 2007/07/13 21:50:24 wouter 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_REAL_LVALUE
17 #define ROO_ABS_REAL_LVALUE
18 
19 #include <cmath>
20 #include <float.h>
21 #include "TString.h"
22 
23 #include "RooAbsReal.h"
24 #include "RooNumber.h"
25 #include "RooAbsLValue.h"
26 #include "RooAbsBinning.h"
27 
28 class RooArgSet ;
29 
30 class RooAbsRealLValue : public RooAbsReal, public RooAbsLValue {
31 public:
32  // Constructors, assignment etc.
33  inline RooAbsRealLValue() { }
34  RooAbsRealLValue(const char *name, const char *title, const char *unit= "") ;
35  RooAbsRealLValue(const RooAbsRealLValue& other, const char* name=0);
36  RooAbsRealLValue& operator=(const RooAbsRealLValue&) = default;
37  virtual ~RooAbsRealLValue();
38 
39  // Parameter value and error accessors
40  virtual void setVal(Double_t value)=0;
41  virtual RooAbsArg& operator=(const RooAbsReal& other) ;
42  virtual RooAbsArg& operator=(Double_t newValue);
43 
44  // Implementation of RooAbsLValue
45  virtual void setBin(Int_t ibin, const char* rangeName=0) ;
46  virtual Int_t getBin(const char* rangeName=0) const { return getBinning(rangeName).binNumber(getVal()) ; }
47  virtual Int_t numBins(const char* rangeName=0) const { return getBins(rangeName) ; }
48  virtual Double_t getBinWidth(Int_t i, const char* rangeName=0) const { return getBinning(rangeName).binWidth(i) ; }
49  virtual Double_t volume(const char* rangeName) const { return getMax(rangeName)-getMin(rangeName) ; }
50  virtual void randomize(const char* rangeName=0);
51 
52  virtual const RooAbsBinning* getBinningPtr(const char* rangeName) const { return &getBinning(rangeName) ; }
53  virtual Int_t getBin(const RooAbsBinning* ptr) const { return ptr->binNumber(getVal()) ; }
54 
55  virtual void setBin(Int_t ibin, const RooAbsBinning& binning) ;
56  virtual Int_t getBin(const RooAbsBinning& binning) const { return binning.binNumber(getVal()) ; }
57  virtual Int_t numBins(const RooAbsBinning& binning) const { return binning.numBins() ; }
58  virtual Double_t getBinWidth(Int_t i, const RooAbsBinning& binning) const { return binning.binWidth(i) ; }
59  virtual Double_t volume(const RooAbsBinning& binning) const { return binning.highBound() - binning.lowBound() ; }
60  virtual void randomize(const RooAbsBinning& binning) ;
61 
62 
63  virtual void setBinFast(Int_t ibin, const RooAbsBinning& binning) ;
64 
65  // Get fit range limits
66 
67  /// Retrive binning configuration with given name or default binning.
68  virtual const RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const = 0 ;
69  /// Retrive binning configuration with given name or default binning.
70  virtual RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) = 0 ;
71  /// Check if binning with given name has been defined.
72  virtual Bool_t hasBinning(const char* name) const = 0 ;
73  virtual Bool_t inRange(const char* name) const ;
74  /// Get number of bins of currently defined range.
75  /// \param name Optionally, request number of bins for range with given name.
76  virtual Int_t getBins(const char* name=0) const { return getBinning(name).numBins(); }
77  /// Get miniminum of currently defined range.
78  /// \param name Optionally, request minimum of range with given name.
79  virtual Double_t getMin(const char* name=0) const { return getBinning(name).lowBound(); }
80  /// Get maximum of currently defined range.
81  /// \param name Optionally, request maximum of range with given name.
82  virtual Double_t getMax(const char* name=0) const { return getBinning(name).highBound(); }
83  /// Get low and high bound of the variable.
84  /// \param name Optional range name. If not given, the default range will be used.
85  /// \return A pair with [lowerBound, upperBound]
86  std::pair<double, double> getRange(const char* name = 0) const {
87  const auto& binning = getBinning(name);
88  return {binning.lowBound(), binning.highBound()};
89  }
90  /// Check if variable has a lower bound.
91  inline Bool_t hasMin(const char* name=0) const { return !RooNumber::isInfinite(getMin(name)); }
92  /// Check if variable has an upper bound.
93  inline Bool_t hasMax(const char* name=0) const { return !RooNumber::isInfinite(getMax(name)); }
94  /// Check if variable has a binning with given name.
95  virtual Bool_t hasRange(const char* name) const { return hasBinning(name) ; }
96 
97  // Jacobian term management
98  virtual Bool_t isJacobianOK(const RooArgSet& depList) const ;
99  virtual Double_t jacobian() const { return 1 ; }
100 
101  inline virtual Bool_t isLValue() const { return kTRUE; }
102 
103  // Test a value against our fit range
104  Bool_t inRange(Double_t value, const char* rangeName, Double_t* clippedValue=0) const;
105  virtual Bool_t isValidReal(Double_t value, Bool_t printError=kFALSE) const ;
106 
107  // Constant and Projected flags
108  inline void setConstant(Bool_t value= kTRUE) { setAttribute("Constant",value); setValueDirty() ; setShapeDirty() ; }
109 
110  // I/O streaming interface (machine readable)
111  virtual Bool_t readFromStream(std::istream& is, Bool_t compact, Bool_t verbose=kFALSE) ;
112  virtual void writeToStream(std::ostream& os, Bool_t compact) const ;
113 
114  // Printing interface (human readable)
115  virtual void printMultiline(std::ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
116 
117 
118  // Build 1-dimensional plots
119  RooPlot* frame(const RooCmdArg& arg1, const RooCmdArg& arg2=RooCmdArg::none(),
120  const RooCmdArg& arg3=RooCmdArg::none(), const RooCmdArg& arg4=RooCmdArg::none(), const RooCmdArg& arg5=RooCmdArg::none(),
121  const RooCmdArg& arg6=RooCmdArg::none(), const RooCmdArg& arg7=RooCmdArg::none(), const RooCmdArg& arg8=RooCmdArg::none()) const ;
122  RooPlot *frame(const RooLinkedList& cmdList) const ;
123  RooPlot *frame(Double_t lo, Double_t hi, Int_t nbins) const;
124  RooPlot *frame(Double_t lo, Double_t hi) const;
125  RooPlot *frame(Int_t nbins) const;
126  RooPlot *frame() const;
127 
128  // Create empty 1,2, and 3D histograms from a list of 1-3 RooAbsReals
129  TH1 *createHistogram(const char *name,
130  const RooCmdArg& arg1=RooCmdArg::none(), const RooCmdArg& arg2=RooCmdArg::none(),
131  const RooCmdArg& arg3=RooCmdArg::none(), const RooCmdArg& arg4=RooCmdArg::none(),
132  const RooCmdArg& arg5=RooCmdArg::none(), const RooCmdArg& arg6=RooCmdArg::none(),
133  const RooCmdArg& arg7=RooCmdArg::none(), const RooCmdArg& arg8=RooCmdArg::none()) const ;
134  TH1 *createHistogram(const char *name, const RooLinkedList& cmdList) const ;
135 
136  TH1F *createHistogram(const char *name, const char *yAxisLabel) const ;
137  TH1F *createHistogram(const char *name, const char *yAxisLabel, Double_t xlo, Double_t xhi, Int_t nBins) const ;
138  TH1F *createHistogram(const char *name, const char *yAxisLabel, const RooAbsBinning& bins) const ;
139 
140  TH2F *createHistogram(const char *name, const RooAbsRealLValue &yvar, const char *zAxisLabel=0,
141  Double_t* xlo=0, Double_t* xhi=0, Int_t* nBins=0) const ;
142  TH2F *createHistogram(const char *name, const RooAbsRealLValue &yvar, const char *zAxisLabel, const RooAbsBinning** bins) const ;
143 
144 
145  TH3F *createHistogram(const char *name, const RooAbsRealLValue &yvar, const RooAbsRealLValue &zvar,
146  const char *tAxisLabel, Double_t* xlo=0, Double_t* xhi=0, Int_t* nBins=0) const ;
147  TH3F *createHistogram(const char *name, const RooAbsRealLValue &yvar, const RooAbsRealLValue &zvar, const char* tAxisLabel, const RooAbsBinning** bins) const ;
148 
149  static TH1* createHistogram(const char *name, RooArgList &vars, const char *tAxisLabel, Double_t* xlo, Double_t* xhi, Int_t* nBins) ;
150  static TH1* createHistogram(const char *name, RooArgList &vars, const char *tAxisLabel, const RooAbsBinning** bins) ;
151 
152 protected:
153 
154  friend class RooRealBinding ;
155 
156  virtual void setValFast(Double_t value) { setVal(value) ; }
157 
158  virtual void setVal(Double_t value, const char* /*rangeName*/) {
159  // Set object value to 'value'
160  return setVal(value) ;
161  }
162  Bool_t fitRangeOKForPlotting() const ;
163  void copyCache(const RooAbsArg* source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE) ;
164 
165  ClassDef(RooAbsRealLValue,1) // Abstract modifiable real-valued object
166 };
167 
168 #endif
virtual Double_t getMin(const char *name=0) const
Get miniminum of currently defined range.
void setAttribute(const Text_t *name, Bool_t value=kTRUE)
Set (default) or clear a named boolean attribute of this object.
Definition: RooAbsArg.cxx:258
virtual void setBin(Int_t ibin, const char *rangeName=0)
Set value to center of bin &#39;ibin&#39; of binning &#39;rangeName&#39; (or of default binning if no range is specif...
virtual ~RooAbsRealLValue()
Destructor.
Bool_t hasMin(const char *name=0) const
Check if variable has a lower bound.
virtual void setValFast(Double_t value)
virtual Double_t getMax(const char *name=0) const
Get maximum of currently defined range.
virtual Int_t getBin(const RooAbsBinning *ptr) const
virtual void randomize(const char *rangeName=0)
Set a new value sampled from a uniform distribution over the fit range.
void setShapeDirty()
Notify that a shape-like property (e.g. binning) has changed.
Definition: RooAbsArg.h:510
3-D histogram with a float per channel (see TH1 documentation)}
Definition: TH3.h:267
virtual Int_t numBins(const char *rangeName=0) const
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:28
virtual Double_t volume(const char *rangeName) const
virtual void printMultiline(std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
Structure printing.
Bool_t hasMax(const char *name=0) const
Check if variable has an upper bound.
Basic string class.
Definition: TString.h:131
virtual Double_t volume(const RooAbsBinning &binning) const
1-D histogram with a float per channel (see TH1 documentation)}
Definition: TH1.h:571
static Int_t isInfinite(Double_t x)
Return true if x is infinite by RooNumBer internal specification.
Definition: RooNumber.cxx:58
virtual Double_t getBinWidth(Int_t i, const RooAbsBinning &binning) const
virtual void writeToStream(std::ostream &os, Bool_t compact) const
Write object contents to given stream.
virtual Double_t jacobian() const
virtual Bool_t readFromStream(std::istream &is, Bool_t compact, Bool_t verbose=kFALSE)
Read object contents from given stream.
static const RooCmdArg & none()
Return reference to null argument.
Definition: RooCmdArg.cxx:52
#define ClassDef(name, id)
Definition: Rtypes.h:322
Bool_t fitRangeOKForPlotting() const
Check if fit range is usable as plot range, i.e.
TH1 * createHistogram(const char *name, const RooCmdArg &arg1=RooCmdArg::none(), 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 void setBinFast(Int_t ibin, const RooAbsBinning &binning)
Set value to center of bin &#39;ibin&#39; of binning &#39;rangeName&#39; (or of default binning if no range is specif...
RooPlot * frame() const
Create a new RooPlot on the heap with a drawing frame initialized for this object, but no plot contents.
virtual Double_t highBound() const =0
virtual const RooAbsBinning * getBinningPtr(const char *rangeName) const
virtual Bool_t isValidReal(Double_t value, Bool_t printError=kFALSE) const
Check if given value is valid.
void setConstant(Bool_t value=kTRUE)
2-D histogram with a float per channel (see TH1 documentation)}
Definition: TH2.h:251
virtual Bool_t hasBinning(const char *name) const =0
Check if binning with given name has been defined.
Double_t getVal(const RooArgSet *normalisationSet=nullptr) const
Evaluate object.
Definition: RooAbsReal.h:90
virtual const RooAbsBinning & getBinning(const char *name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const =0
Retrive binning configuration with given name or default binning.
virtual Double_t lowBound() const =0
virtual void setVal(Double_t value, const char *)
static void indent(ostringstream &buf, int indent_level)
virtual void setVal(Double_t value)=0
virtual Int_t binNumber(Double_t x) const =0
A RooPlot is a plot frame and a container for graphics objects within that frame. ...
Definition: RooPlot.h:44
const Bool_t kFALSE
Definition: RtypesCore.h:90
RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in ...
Definition: RooLinkedList.h:35
virtual Bool_t isJacobianOK(const RooArgSet &depList) const
RooAbsBinning is the abstract base class for RooRealVar binning definitions This class defines the in...
Definition: RooAbsBinning.h:26
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:60
virtual Int_t getBin(const char *rangeName=0) const
The TH1 histogram class.
Definition: TH1.h:56
Int_t numBins() const
Definition: RooAbsBinning.h:37
virtual Int_t numBins(const RooAbsBinning &binning) const
virtual Bool_t inRange(const char *name) const
Check if current value is inside range with given name.
void setValueDirty()
Mark the element dirty. This forces a re-evaluation when a value is requested.
Definition: RooAbsArg.h:505
RooAbsRealLValue is the common abstract base class for objects that represent a real value that may a...
virtual Double_t binWidth(Int_t bin) const =0
virtual Bool_t hasRange(const char *name) const
Check if variable has a binning with given name.
virtual Bool_t isLValue() const
Is this argument an l-value, i.e., can it appear on the left-hand side of an assignment expression...
void copyCache(const RooAbsArg *source, Bool_t valueOnly=kFALSE, Bool_t setValDirty=kTRUE)
Copy cache of another RooAbsArg to our cache.
std::pair< double, double > getRange(const char *name=0) const
Get low and high bound of the variable.
RooArgList is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgList.h:21
float type_of_call hi(const int &, const int &)
virtual Int_t getBins(const char *name=0) const
Get number of bins of currently defined range.
Abstract base class for objects that are lvalues, i.e.
Definition: RooAbsLValue.h:26
RooAbsRealLValue & operator=(const RooAbsRealLValue &)=default
Lightweight interface adaptor that binds a RooAbsReal object to a subset of its servers and present i...
RooAbsArg is the common abstract base class for objects that represent a value (of arbitrary type) an...
Definition: RooAbsArg.h:73
virtual Double_t getBinWidth(Int_t i, const char *rangeName=0) const
const Bool_t kTRUE
Definition: RtypesCore.h:89
char name[80]
Definition: TGX11.cxx:109
virtual Int_t getBin(const RooAbsBinning &binning) const
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:28