ROOT_528-00b_version: include/RooAbsData.h Source File

00001 /*****************************************************************************
00002  * Project: RooFit                                                           *
00003  * Package: RooFitCore                                                       *
00004  *    File: $Id: RooAbsData.h,v 1.33 2007/07/16 21:04:28 wouter Exp $
00005  * Authors:                                                                  *
00006  *   WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu       *
00007  *   DK, David Kirkby,    UC Irvine,         dkirkby@uci.edu                 *
00008  *                                                                           *
00009  * Copyright (c) 2000-2005, Regents of the University of California          *
00010  *                          and Stanford University. All rights reserved.    *
00011  *                                                                           *
00012  * Redistribution and use in source and binary forms,                        *
00013  * with or without modification, are permitted according to the terms        *
00014  * listed in LICENSE (http://roofit.sourceforge.net/license.txt)             *
00015  *****************************************************************************/
00016 #ifndef ROO_ABS_DATA
00017 #define ROO_ABS_DATA
00018 
00019 #include "TNamed.h"
00020 #include "RooPrintable.h"
00021 #include "RooArgSet.h"
00022 #include "RooFormulaVar.h"
00023 #include <math.h>
00024 #include "TMatrixDSym.h"
00025 
00026 class RooAbsArg;
00027 class RooAbsReal ;
00028 class RooAbsCategory ;
00029 class Roo1DTable ;
00030 class RooPlot;
00031 class RooArgList;
00032 class TH1;
00033 class RooAbsBinning ;
00034 class Roo1DTable ;
00035 class RooAbsDataStore ;
00036 
00037 class RooAbsData : public TNamed, public RooPrintable {
00038 public:
00039 
00040   // Constructors, factory methods etc.
00041   RooAbsData() ; 
00042   RooAbsData(const char *name, const char *title, const RooArgSet& vars, RooAbsDataStore* store=0) ;
00043   RooAbsData(const RooAbsData& other, const char* newname = 0) ;
00044   virtual ~RooAbsData() ;
00045   virtual RooAbsData* emptyClone(const char* newName=0, const char* newTitle=0, const RooArgSet* vars=0) const = 0 ;
00046 
00047   // Reduction methods
00048   RooAbsData* reduce(const RooCmdArg& arg1,const RooCmdArg& arg2=RooCmdArg(),const RooCmdArg& arg3=RooCmdArg(),const RooCmdArg& arg4=RooCmdArg(),
00049                      const RooCmdArg& arg5=RooCmdArg(),const RooCmdArg& arg6=RooCmdArg(),const RooCmdArg& arg7=RooCmdArg(),const RooCmdArg& arg8=RooCmdArg()) ;
00050   RooAbsData* reduce(const char* cut) ;
00051   RooAbsData* reduce(const RooFormulaVar& cutVar) ;
00052   RooAbsData* reduce(const RooArgSet& varSubset, const char* cut=0) ;
00053   RooAbsData* reduce(const RooArgSet& varSubset, const RooFormulaVar& cutVar) ;
00054 
00055   RooAbsDataStore* store() { return _dstore ; }
00056   const RooAbsDataStore* store() const { return _dstore ; }
00057   const TTree* tree() const ;
00058   
00059   virtual void Draw(Option_t* option = "") ;
00060 
00061   void checkInit() const ; 
00062 
00063   // Change name of observable
00064   virtual Bool_t changeObservableName(const char* from, const char* to) ;
00065 
00066   // Add one ore more rows of data
00067   virtual void add(const RooArgSet& row, Double_t weight=1, Double_t weightError=0) = 0 ; // DERIVED
00068   virtual void fill() ; 
00069 
00070   // Load a given row of data
00071   virtual inline const RooArgSet* get() const { 
00072     // Return current row of dataset
00073     return &_vars ; 
00074   } 
00075   virtual Double_t weight() const = 0 ; // DERIVED
00076   virtual Bool_t valid() const { return kTRUE ; }
00077   enum ErrorType { Poisson, SumW2, None, Auto } ;
00078   virtual Double_t weightError(ErrorType etype=Poisson) const ;
00079   virtual void weightError(Double_t& lo, Double_t& hi, ErrorType etype=Poisson) const ; 
00080   virtual const RooArgSet* get(Int_t index) const ;
00081 
00082   virtual Int_t numEntries() const ;
00083   virtual Double_t sumEntries(const char* cutSpec=0, const char* cutRange=0) const = 0 ; // DERIVED
00084   virtual Bool_t isWeighted() const { 
00085     // Do events in dataset have weights?
00086     return kFALSE ; 
00087   }
00088   virtual Bool_t isNonPoissonWeighted() const { 
00089     // Do events in dataset have non-integer weights?
00090     return kFALSE ; 
00091   }
00092   virtual void reset() ;
00093 
00094 
00095   Bool_t getRange(RooRealVar& var, Double_t& lowest, Double_t& highest, Double_t marginFrac=0, Bool_t symMode=kFALSE) const ;
00096 
00097   // Plot the distribution of a real valued arg
00098   virtual Roo1DTable* table(const RooArgSet& catSet, const char* cuts="", const char* opts="") const ;
00099   virtual Roo1DTable* table(const RooAbsCategory& cat, const char* cuts="", const char* opts="") const ;
00100   virtual RooPlot* plotOn(RooPlot* frame, 
00101                           const RooCmdArg& arg1=RooCmdArg::none(), const RooCmdArg& arg2=RooCmdArg::none(),
00102                           const RooCmdArg& arg3=RooCmdArg::none(), const RooCmdArg& arg4=RooCmdArg::none(),
00103                           const RooCmdArg& arg5=RooCmdArg::none(), const RooCmdArg& arg6=RooCmdArg::none(),
00104                           const RooCmdArg& arg7=RooCmdArg::none(), const RooCmdArg& arg8=RooCmdArg::none()) const ;
00105 
00106   virtual RooPlot* plotOn(RooPlot* frame, const RooLinkedList& cmdList) const ;
00107 
00108   // WVE --- This needs to be public to avoid CINT problems
00109   struct PlotOpt {
00110    PlotOpt() : cuts(""), drawOptions("P"), bins(0), etype(RooAbsData::Poisson), cutRange(0), histName(0), histInvisible(kFALSE),
00111               addToHistName(0),addToWgtSelf(1.),addToWgtOther(1.),xErrorSize(1),refreshFrameNorm(kFALSE),correctForBinWidth(kTRUE),
00112               scaleFactor(1.) {} ;
00113    const char* cuts ;
00114    Option_t* drawOptions ;
00115    RooAbsBinning* bins ;
00116    RooAbsData::ErrorType etype ;
00117    const char* cutRange ;
00118    const char* histName ;
00119    Bool_t histInvisible ;
00120    const char* addToHistName ;
00121    Double_t addToWgtSelf ;
00122    Double_t addToWgtOther ;
00123    Double_t xErrorSize ;
00124    Bool_t refreshFrameNorm ;
00125    Bool_t correctForBinWidth ;
00126    Double_t scaleFactor ;
00127   } ;
00128         
00129   // Split a dataset by a category
00130   virtual TList* split(const RooAbsCategory& splitCat, Bool_t createEmptyDataSets=kFALSE) const ;
00131  
00132 
00133   // Create 1,2, and 3D histograms from and fill it
00134   TH1 *createHistogram(const char *name, const RooAbsRealLValue& xvar,
00135                        const RooCmdArg& arg1=RooCmdArg::none(), const RooCmdArg& arg2=RooCmdArg::none(), 
00136                        const RooCmdArg& arg3=RooCmdArg::none(), const RooCmdArg& arg4=RooCmdArg::none(), 
00137                        const RooCmdArg& arg5=RooCmdArg::none(), const RooCmdArg& arg6=RooCmdArg::none(), 
00138                        const RooCmdArg& arg7=RooCmdArg::none(), const RooCmdArg& arg8=RooCmdArg::none()) const ;
00139   TH1* createHistogram(const char *name, const RooAbsRealLValue& xvar, const RooLinkedList& argList) const ;
00140   TH1 *createHistogram(const char* varNameList, Int_t xbins=0, Int_t ybins=0, Int_t zbins=0) const ;
00141 
00142   // Fill an existing histogram
00143   virtual TH1 *fillHistogram(TH1 *hist, const RooArgList &plotVars, const char *cuts= "", const char* cutRange=0) const;
00144 
00145   // Printing interface (human readable)
00146   inline virtual void Print(Option_t *options= 0) const {
00147     // Print contents on stdout
00148     printStream(defaultPrintStream(),defaultPrintContents(options),defaultPrintStyle(options));
00149   }
00150 
00151   virtual void printName(ostream& os) const ;
00152   virtual void printTitle(ostream& os) const ;
00153   virtual void printClassName(ostream& os) const ;
00154   void printMultiline(ostream& os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const ;
00155 
00156   virtual Int_t defaultPrintContents(Option_t* opt) const ;
00157 
00158   void setDirtyProp(Bool_t flag) ;
00159   
00160   Double_t moment(RooRealVar &var, Double_t order, const char* cutSpec=0, const char* cutRange=0) const ;
00161   Double_t moment(RooRealVar &var, Double_t order, Double_t offset, const char* cutSpec=0, const char* cutRange=0) const ;
00162   Double_t standMoment(RooRealVar &var, Double_t order, const char* cutSpec=0, const char* cutRange=0) const ;
00163 
00164   Double_t mean(RooRealVar& var, const char* cutSpec=0, const char* cutRange=0) const { return moment(var,1,0,cutSpec,cutRange) ; }
00165   Double_t sigma(RooRealVar& var, const char* cutSpec=0, const char* cutRange=0) const { return sqrt(moment(var,2,cutSpec,cutRange)) ; }
00166   Double_t skewness(RooRealVar& var, const char* cutSpec=0, const char* cutRange=0) const { return standMoment(var,3,cutSpec,cutRange) ; }
00167   Double_t kurtosis(RooRealVar& var, const char* cutSpec=0, const char* cutRange=0) const { return standMoment(var,4,cutSpec,cutRange) ; }
00168 
00169   Double_t covariance(RooRealVar &x,RooRealVar &y, const char* cutSpec=0, const char* cutRange=0) const { return corrcov(x,y,cutSpec,cutRange,kFALSE) ; }
00170   Double_t correlation(RooRealVar &x,RooRealVar &y, const char* cutSpec=0, const char* cutRange=0) const { return corrcov(x,y,cutSpec,cutRange,kTRUE) ; }
00171 
00172   TMatrixDSym* covarianceMatrix(const char* cutSpec=0, const char* cutRange=0) const { return covarianceMatrix(*get(),cutSpec,cutRange) ; }
00173   TMatrixDSym* correlationMatrix(const char* cutSpec=0, const char* cutRange=0) const { return correlationMatrix(*get(),cutSpec,cutRange) ; }
00174   TMatrixDSym* covarianceMatrix(const RooArgList& vars, const char* cutSpec=0, const char* cutRange=0) const { return corrcovMatrix(vars,cutSpec,cutRange,kFALSE) ; }
00175   TMatrixDSym* correlationMatrix(const RooArgList& vars, const char* cutSpec=0, const char* cutRange=0) const { return corrcovMatrix(vars,cutSpec,cutRange,kTRUE) ; }
00176   
00177   RooRealVar* meanVar(RooRealVar &var, const char* cutSpec=0, const char* cutRange=0) const ;
00178   RooRealVar* rmsVar(RooRealVar &var, const char* cutSpec=0, const char* cutRange=0) const ;
00179 
00180   virtual RooPlot* statOn(RooPlot* frame, 
00181                           const RooCmdArg& arg1=RooCmdArg::none(), const RooCmdArg& arg2=RooCmdArg::none(), 
00182                           const RooCmdArg& arg3=RooCmdArg::none(), const RooCmdArg& arg4=RooCmdArg::none(), 
00183                           const RooCmdArg& arg5=RooCmdArg::none(), const RooCmdArg& arg6=RooCmdArg::none(), 
00184                           const RooCmdArg& arg7=RooCmdArg::none(), const RooCmdArg& arg8=RooCmdArg::none()) ;
00185 
00186   virtual RooPlot* statOn(RooPlot* frame, const char *what, 
00187                           const char *label= "", Int_t sigDigits= 2,
00188                           Option_t *options= "NELU", Double_t xmin=0.15, 
00189                           Double_t xmax= 0.65,Double_t ymax=0.85, 
00190                           const char* cutSpec=0, const char* cutRange=0, 
00191                           const RooCmdArg* formatCmd=0);
00192 
00193 
00194 
00195   Bool_t hasFilledCache() const ; 
00196 
00197 
00198 protected:
00199 
00200   Double_t corrcov(RooRealVar &x,RooRealVar &y, const char* cutSpec, const char* cutRange, Bool_t corr) const  ;
00201   TMatrixDSym* corrcovMatrix(const RooArgList& vars, const char* cutSpec, const char* cutRange, Bool_t corr) const  ;
00202 
00203   virtual void optimizeReadingWithCaching(RooAbsArg& arg, const RooArgSet& cacheList, const RooArgSet& keepObsList) ;
00204   Bool_t allClientsCached(RooAbsArg*, const RooArgSet&) ;
00205 
00206 
00207  // PlotOn implementation
00208   virtual RooPlot *plotOn(RooPlot *frame, PlotOpt o) const ;
00209   virtual RooPlot *plotAsymOn(RooPlot* frame, const RooAbsCategoryLValue& asymCat, PlotOpt o) const ;
00210   virtual RooPlot *plotEffOn(RooPlot* frame, const RooAbsCategoryLValue& effCat, PlotOpt o) const ;
00211  
00212  
00213   // Constant term optimizer interface
00214   friend class RooAbsArg ;
00215   friend class RooAbsReal ;
00216   friend class RooAbsOptTestStatistic ;
00217   friend class RooAbsCachedPdf ;
00218 
00219   virtual void cacheArgs(const RooAbsArg* owner, RooArgSet& varSet, const RooArgSet* nset=0) ;
00220   virtual void resetCache() ;
00221   virtual void setArgStatus(const RooArgSet& set, Bool_t active) ;
00222   virtual void attachCache(const RooAbsArg* newOwner, const RooArgSet& cachedVars) ;
00223 
00224   virtual RooAbsData* cacheClone(const RooAbsArg* newCacheOwner, const RooArgSet* newCacheVars, const char* newName=0) = 0 ; // DERIVED
00225   virtual RooAbsData* reduceEng(const RooArgSet& varSubset, const RooFormulaVar* cutVar, const char* cutRange=0, 
00226                                 Int_t nStart=0, Int_t nStop=2000000000, Bool_t copyCache=kTRUE) = 0 ; // DERIVED
00227 
00228   RooRealVar* dataRealVar(const char* methodname, RooRealVar& extVar) const ;
00229 
00230   // Column structure definition
00231   RooArgSet _vars;         // Dimensions of this data set
00232   RooArgSet _cachedVars ;  //! External variables cached with this data set
00233 
00234   TIterator *_iterator;    //! Iterator over dimension variables
00235   TIterator *_cacheIter ;  //! Iterator over cached variables
00236 
00237   RooAbsDataStore* _dstore ; // Data storage implementation
00238 
00239 private:
00240 
00241   ClassDef(RooAbsData,2) // Abstract data collection
00242 };
00243 
00244 #endif