EIC code displayed by LXR master/​include/​root/​RooAbsMCStudyModule.h	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-09-17 09:29:54

 /*****************************************************************************
  * Project: RooFit                                                           *
  * Package: RooFitCore                                                       *
  *    File: $Id: RooAbsMCStudyModule.h,v 1.2 2007/05/11 09:11:30 verkerke Exp $
  * Authors:                                                                  *
  *   WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu       *
  *   DK, David Kirkby,    UC Irvine,         dkirkby@uci.edu                 *
  *                                                                           *
  * Copyright (c) 2000-2005, Regents of the University of California          *
  *                          and Stanford University. All rights reserved.    *
  *                                                                           *
  * Redistribution and use in source and binary forms,                        *
  * with or without modification, are permitted according to the terms        *
  * listed in LICENSE (http://roofit.sourceforge.net/license.txt)             *
  *****************************************************************************/
 
 #ifndef ROO_ABS_MC_STUDY_MODULE
 #define ROO_ABS_MC_STUDY_MODULE
 
 #include "RooArgSet.h"
 #include "RooMCStudy.h"
 class RooAbsPdf;
 class RooDataSet ;
 class RooAbsData ;
 class RooAbsGenContext ;
 class RooFitResult ;
 class RooPlot ;
 class RooRealVar ;
 
 class RooAbsMCStudyModule : public TNamed {
 public:
 
   RooAbsMCStudyModule(const char* name, const char* title) ;
   RooAbsMCStudyModule(const RooAbsMCStudyModule& other) ;
 
   /// Initializer method called upon attachment to given RooMCStudy object
   bool doInitializeInstance(RooMCStudy& /*study*/) ;
 
   /// Initializer called immediately after attachment to RooMCStudy object and initialization of module base class
   virtual bool initializeInstance() {
     return true ;
   }
 
   /// Method called at the beginning of each RooMCStudy run
   virtual bool initializeRun(Int_t /*numSamples*/) {
     return true ;
   }
 
   /// Method called at the end of each RooMCStudy run. If a RooDataSet is returned, it must have a length equal to
   /// the number of toy experiments performed and will merged with the fitpar dataset of RooMCStudy.
   virtual RooDataSet* finalizeRun() {
     return nullptr ;
   }
 
   /// Method called after resetting of generator parameters to initial values and before call to generator context
   /// Any modifications to generator parameters will affect next generation operation (only)
   virtual bool processBeforeGen(Int_t /*sampleNum*/) {
     return true ;
   }
 
   /// Method called after generation of toy data sample and resetting of fit parameters to initial values and before
   /// actual fit is performed. Any modifications to fit parameters will apply to next fit operation. Note that setConstant
   /// flag of fit parameters are not explicitly reset by RooMCStudy, so any changes made to these flags here will persist
   virtual bool processBetweenGenAndFit(Int_t /*sampleNum*/) {
     return true ;
   }
 
   /// Method called after fit has been performed. It's crucial that this is
   /// implemented, because it's the responsability of this method to ensure
   /// that this MC study module will not have added an element to its internal
   /// RooDataSet if the fit has failed.
   virtual bool processAfterFit(bool fitOk) = 0;
 
 protected:
 
    // Interface methods to RooMCStudy objects,
    // which are only functional after module has been attached to a RooMCStudy object
 
    /// Refit model using original or specified data sample
    RooFit::OwningPtr<RooFitResult> refit(RooAbsData* inGenSample=nullptr);
 
    /// Return generate sample
    RooAbsData* genSample() {
      return _mcs ? _mcs->_genSample : nullptr ;
    }
 
    /// Return generator pdf
    RooAbsPdf* genModel() {
      return _mcs ? _mcs->_genModel : nullptr ;
    }
 
    // Accessor for generator context, generator parameters, prototype data and projected dependents.
    RooAbsGenContext* genContext() {
      return _mcs ? _mcs->_genContext.get() : nullptr ;
    }
 
    /// Return initial value of generator model parameters
    RooArgSet* genInitParams() {
      return _mcs ? &_mcs->_genInitParams : nullptr ;
    }
 
    /// Return current value of generator model parameters
    RooArgSet* genParams() {
      return _mcs ? &_mcs->_genParams : nullptr ;
    }
 
    /// Return generator prototype data provided by user
    const RooDataSet* genProtoData() {
      return _mcs ? _mcs->_genProtoData : nullptr ;
    }
 
    /// Return projected observables
    RooArgSet* projDeps() {
      return _mcs ? &_mcs->_projDeps : nullptr ;
    }
 
    // Accessors for fit observables, fit model, current and initial fit parameters and NLL value
 
    /// Return fit model observables
    RooArgSet* dependents() {
      return _mcs ? &_mcs->_dependents : nullptr ;
    }
 
    /// Return all observables
    RooArgSet* allDependents() {
      return _mcs ? &_mcs->_allDependents : nullptr ;
    }
 
    /// Return fit model
    RooAbsPdf* fitModel() {
      return _mcs ? _mcs->_fitModel : nullptr ;
    }
 
    /// Return initial value of parameters of fit model
    RooArgSet* fitInitParams() {
      return _mcs ? &_mcs->_fitInitParams : nullptr ;
    }
 
    /// Return current value of parameters of fit model
    RooArgSet* fitParams() {
      return _mcs ? &_mcs-> _fitParams : nullptr ;
    }
 
    /// Return pointer to RooRealVar holding minimized -log(L) value
    RooRealVar* nllVar() {
      return _mcs ? _mcs->_nllVar.get() : nullptr ;
    }
 
    // Accessors for fit options, generator and MCstudy configuration flags
 
    /// Return list of fit options provided by user
    RooLinkedList* fitOptList() {
      return _mcs ? &_mcs->_fitOptList : nullptr ;
    }
 
    /// If true extended mode generation is requested
    bool extendedGen() {
      return _mcs ? _mcs->_extendedGen : false ;
    }
 
    /// If true binning of data between generating and fitting is requested
    bool binGenData() {
      return _mcs ? _mcs->_binGenData : false ;
    }
 
    /// Return expected number of events from generator model
    double numExpGen() {
      return _mcs ? _mcs->_nExpGen : 0 ;
    }
 
    /// If true randomization of prototype data order is requested
    bool randProto() {
      return _mcs ? _mcs->_randProto : false ;
    }
 
    /// If true verbose message in the generation step is requested
    bool verboseGen() {
      return _mcs ? _mcs->_verboseGen : false ;
    }
 
 private:
 
   RooMCStudy* _mcs ; ///< Pointer to RooMCStudy object module is attached to
 
   ClassDefOverride(RooAbsMCStudyModule,0) // Monte Carlo study manager add-on module
 } ;
 
 
 #endif
 

This page was automatically generated by the 2.3.7 LXR engine. The LXR team