Logo ROOT   6.30.04
Reference Guide
 All Namespaces Files Pages
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  virtual RooAbsArg& operator=(Int_t ival) { return operator=((Double_t)ival) ; }
44 
45  // Implementation of RooAbsLValue
46  virtual void setBin(Int_t ibin, const char* rangeName=0) ;
47  virtual Int_t getBin(const char* rangeName=0) const { return getBinning(rangeName).binNumber(getVal()) ; }
48  virtual Int_t numBins(const char* rangeName=0) const { return getBins(rangeName) ; }
49  virtual Double_t getBinWidth(Int_t i, const char* rangeName=0) const { return getBinning(rangeName).binWidth(i) ; }
50  virtual Double_t volume(const char* rangeName) const { return getMax(rangeName)-getMin(rangeName) ; }
51  virtual void randomize(const char* rangeName=0);
52 
53  virtual const RooAbsBinning* getBinningPtr(const char* rangeName) const { return &getBinning(rangeName) ; }
54  virtual Int_t getBin(const RooAbsBinning* ptr) const { return ptr->binNumber(getVal()) ; }
55 
56  virtual void setBin(Int_t ibin, const RooAbsBinning& binning) ;
57  virtual Int_t getBin(const RooAbsBinning& binning) const { return binning.binNumber(getVal()) ; }
58  virtual Int_t numBins(const RooAbsBinning& binning) const { return binning.numBins() ; }
59  virtual Double_t getBinWidth(Int_t i, const RooAbsBinning& binning) const { return binning.binWidth(i) ; }
60  virtual Double_t volume(const RooAbsBinning& binning) const { return binning.highBound() - binning.lowBound() ; }
61  virtual void randomize(const RooAbsBinning& binning) ;
62 
63 
64  virtual void setBinFast(Int_t ibin, const RooAbsBinning& binning) ;
65 
66  // Get fit range limits
67 
68  /// Retrive binning configuration with given name or default binning.
69  virtual const RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) const = 0 ;
70  /// Retrive binning configuration with given name or default binning.
71  virtual RooAbsBinning& getBinning(const char* name=0, Bool_t verbose=kTRUE, Bool_t createOnTheFly=kFALSE) = 0 ;
72  /// Check if binning with given name has been defined.
73  virtual Bool_t hasBinning(const char* name) const = 0 ;
74  virtual Bool_t inRange(const char* name) const ;
75  /// Get number of bins of currently defined range.
76  /// \param name Optionally, request number of bins for range with given name.
77  virtual Int_t getBins(const char* name=0) const { return getBinning(name).numBins(); }
78  /// Get miniminum of currently defined range.
79  /// \param name Optionally, request minimum of range with given name.
80  virtual Double_t getMin(const char* name=0) const { return getBinning(name).lowBound(); }
81  /// Get maximum of currently defined range.
82  /// \param name Optionally, request maximum of range with given name.
83  virtual Double_t getMax(const char* name=0) const { return getBinning(name).highBound(); }
84  /// Get low and high bound of the variable.
85  /// \param name Optional range name. If not given, the default range will be used.
86  /// \return A pair with [lowerBound, upperBound]
87  std::pair<double, double> getRange(const char* name = 0) const {
88  return {getMin(name), getMax(name)};
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