ModelConfig.h

Go to the documentation of this file.

// @(#)root/roostats:$Id$
// Author: Kyle Cranmer, Lorenzo Moneta, Gregory Schott, Wouter Verkerke, Sven Kreiss
/*************************************************************************
 * Copyright (C) 1995-2008, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOSTATS_ModelConfig
#define ROOSTATS_ModelConfig
 
 
#include "RooAbsPdf.h"
 
#include "RooAbsData.h"
 
#include "RooArgSet.h"
 
#include "RooWorkspaceHandle.h"
 
#include "TRef.h"
 
#include <string>
 
 
namespace RooStats {
 
class ModelConfig final : public TNamed, public RooWorkspaceHandle {
 
public:
 
   ModelConfig(RooWorkspace * ws = nullptr) :
      TNamed()
   {
      if(ws) SetWS(*ws);
   }
 
   ModelConfig(const char* name, RooWorkspace *ws = nullptr) :
      TNamed(name, name)
   {
      if(ws) SetWS(*ws);
   }
 
   ModelConfig(const char* name, const char* title, RooWorkspace *ws = nullptr) :
      TNamed(name, title)
   {
      if(ws) SetWS(*ws);
   }
 
 
   /// clone
   ModelConfig * Clone(const char * name = "") const override {
      ModelConfig * mc =  new ModelConfig(*this);
      if(strcmp(name,"")==0)
         mc->SetName(this->GetName());
      else
         mc->SetName(name);
      return mc;
   }
 
   /// Set a workspace that owns all the necessary components for the analysis.
   void SetWS(RooWorkspace & ws) override;
   //// alias for SetWS(...)
   virtual void SetWorkspace(RooWorkspace & ws) { SetWS(ws); }
 
   /// Remove the existing reference to a workspace and replace it with this new one.
   void ReplaceWS(RooWorkspace *ws) override {
     fRefWS = nullptr;
     SetWS(*ws);
   }
 
   /// Set the proto DataSet, add to the workspace if not already there
   virtual void SetProtoData(RooAbsData & data) {
      ImportDataInWS(data);
      SetProtoData( data.GetName() );
   }
 
   /// Set the Pdf, add to the workspace if not already there
   virtual void SetPdf(const RooAbsPdf& pdf) {
      ImportPdfInWS(pdf);
      SetPdf( pdf.GetName() );
   }
 
   /// Set the Prior Pdf, add to the workspace if not already there
   virtual void SetPriorPdf(const RooAbsPdf& pdf) {
      ImportPdfInWS(pdf);
      SetPriorPdf( pdf.GetName() );
   }
 
   /// Specify parameters of the PDF.
   virtual void SetParameters(const RooArgSet& set) {
     if (!SetHasOnlyParameters(set,"ModelConfig::SetParameters")) return ;
     fPOIName=std::string(GetName()) + "_POI";
     DefineSetInWS(fPOIName.c_str(), set);
   }
 
   /// Specify parameters of interest.
   virtual void SetParametersOfInterest(const RooArgSet& set) {
     if (!SetHasOnlyParameters(set,"ModelConfig::SetParametersOfInterest")) return ;
      SetParameters(set);
   }
 
   /// Specify parameters
   /// using a list of comma-separated list of arguments already in the workspace.
   virtual void SetParameters(const char *argList) {
      if(!GetWS()) return;
      SetParameters(GetWS()->argSet(argList));
   }
 
   /// Specify parameters of interest
   /// using a comma-separated list of arguments already in the workspace.
   virtual void SetParametersOfInterest(const char *argList) {
      SetParameters(argList);
   }
 
   /// Specify the nuisance parameters (parameters that are not POI).
   virtual void SetNuisanceParameters(const RooArgSet& set) {
     if (!SetHasOnlyParameters(set,"ModelConfig::SetNuisanceParameters")) return ;
      fNuisParamsName=std::string(GetName()) + "_NuisParams";
      DefineSetInWS(fNuisParamsName.c_str(), set);
   }
 
   /// Specify the nuisance parameters
   /// using a comma-separated list of arguments already in the workspace.
   virtual void SetNuisanceParameters(const char *argList) {
      if(!GetWS()) return;
      SetNuisanceParameters(GetWS()->argSet(argList));
   }
 
   /// Specify the constraint parameters
   virtual void SetConstraintParameters(const RooArgSet& set) {
     if (!SetHasOnlyParameters(set,"ModelConfig::SetConstainedParameters")) return ;
      fConstrParamsName=std::string(GetName()) + "_ConstrainedParams";
      DefineSetInWS(fConstrParamsName.c_str(), set);
   }
   /// Specify the constraint parameters
   /// through a comma-separated list of arguments already in the workspace.
   virtual void SetConstraintParameters(const char *argList) {
      if(!GetWS()) return;
      SetConstraintParameters(GetWS()->argSet(argList));
   }
 
   /// Specify the observables.
   virtual void SetObservables(const RooArgSet& set) {
     if (!SetHasOnlyParameters(set,"ModelConfig::SetObservables")) return ;
      fObservablesName=std::string(GetName()) + "_Observables";
      DefineSetInWS(fObservablesName.c_str(), set);
   }
   /// specify the observables
   /// through a comma-separated list of arguments already in the workspace.
   virtual void SetObservables(const char *argList) {
      if(!GetWS()) return;
      SetObservables(GetWS()->argSet(argList));
   }
 
   /// Specify the conditional observables.
   virtual void SetConditionalObservables(const RooArgSet& set) {
     if (!SetHasOnlyParameters(set,"ModelConfig::SetConditionalObservables")) return ;
      fConditionalObsName=std::string(GetName()) + "_ConditionalObservables";
      DefineSetInWS(fConditionalObsName.c_str(), set);
   }
   /// Specify the conditional observables
   /// through a comma-separated list of arguments already in the workspace.
   virtual void SetConditionalObservables(const char *argList) {
      if(!GetWS()) return;
      SetConditionalObservables(GetWS()->argSet(argList));
   }
 
   /// Specify the global observables.
   virtual void SetGlobalObservables(const RooArgSet& set) {
 
     if (!SetHasOnlyParameters(set,"ModelConfig::SetGlobalObservables")) return ;
 
      // make global observables constant
     for (auto *arg : set){
         arg->setAttribute("Constant", true);
     }
 
      fGlobalObsName=std::string(GetName()) + "_GlobalObservables";
      DefineSetInWS(fGlobalObsName.c_str(), set);
   }
   /// Specify the global observables
   /// through a comma-separated list of arguments already in the workspace.
   virtual void SetGlobalObservables(const char *argList) {
      if(!GetWS()) return;
      SetGlobalObservables(GetWS()->argSet(argList));
   }
 
   /// Set parameter values for a particular hypothesis if using a common PDF
   /// by saving a snapshot in the workspace.
   virtual void SetSnapshot(const RooArgSet& set);
 
   /// Specify the name of the PDF in the workspace to be used.
   virtual void SetPdf(const char* name) {
      if (! GetWS() ) return;
 
      if(GetWS()->pdf(name))
         fPdfName = name;
      else
         coutE(ObjectHandling) << "pdf "<<name<< " does not exist in workspace"<<std::endl;
   }
 
   /// Specify the name of the PDF in the workspace to be used.
   virtual void SetPriorPdf(const char* name) {
      if (! GetWS() ) return;
 
      if(GetWS()->pdf(name))
         fPriorPdfName = name;
      else
         coutE(ObjectHandling) << "pdf "<<name<< " does not exist in workspace"<<std::endl;
   }
 
 
   /// Specify the name of the dataset in the workspace to be used.
   virtual void SetProtoData(const char* name){
      if (! GetWS() ) return;
 
      if(GetWS()->data(name))
         fProtoDataName = name;
      else
         coutE(ObjectHandling) << "dataset "<<name<< " does not exist in workspace"<<std::endl;
   }
 
 
   /* getter methods */
 
 
   /// get model PDF (return nullptr if pdf has not been specified or does not exist)
   RooAbsPdf * GetPdf() const { return (GetWS()) ? GetWS()->pdf(fPdfName.c_str()) : nullptr;   }
 
   /// get RooArgSet containing the parameter of interest (return nullptr if not existing)
   const RooArgSet * GetParametersOfInterest() const { return (GetWS()) ? GetWS()->set(fPOIName.c_str()) : nullptr; }
 
   /// get RooArgSet containing the nuisance parameters (return nullptr if not existing)
   const RooArgSet * GetNuisanceParameters() const { return (GetWS()) ? GetWS()->set(fNuisParamsName.c_str()) : nullptr; }
 
   /// get RooArgSet containing the constraint parameters (return nullptr if not existing)
   const RooArgSet * GetConstraintParameters() const { return (GetWS()) ? GetWS()->set(fConstrParamsName.c_str()) : nullptr; }
 
   /// get parameters prior pdf  (return nullptr if not existing)
   RooAbsPdf * GetPriorPdf() const { return (GetWS()) ? GetWS()->pdf(fPriorPdfName.c_str()) : nullptr; }
 
   /// get RooArgSet for observables  (return nullptr if not existing)
   const RooArgSet * GetObservables() const { return (GetWS()) ? GetWS()->set(fObservablesName.c_str()) : nullptr; }
 
   /// get RooArgSet for conditional observables  (return nullptr if not existing)
   const RooArgSet * GetConditionalObservables() const { return (GetWS()) ? GetWS()->set(fConditionalObsName.c_str()) : nullptr; }
 
   /// get RooArgSet for global observables  (return nullptr if not existing)
   const RooArgSet * GetGlobalObservables() const { return (GetWS()) ? GetWS()->set(fGlobalObsName.c_str()) : nullptr; }
 
   /// get Proto data set (return nullptr if not existing)
   RooAbsData * GetProtoData()  const {  return (GetWS()) ? GetWS()->data(fProtoDataName.c_str()) : nullptr; }
 
   /// get RooArgSet for parameters for a particular hypothesis  (return nullptr if not existing)
   const RooArgSet * GetSnapshot() const;
 
   void LoadSnapshot() const;
 
   RooWorkspace * GetWS() const override;
   /// alias for GetWS()
   RooWorkspace * GetWorkspace() const { return GetWS(); }
 
   void GuessObsAndNuisance(const RooAbsData& data, bool printModelConfig = true);
 
   /// overload the print method
   void Print(Option_t* option = "") const override;
 
protected:
 
   /// helper function to check that content of a given set is exclusively parameters
   bool SetHasOnlyParameters(const RooArgSet& set, const char* errorMsgPrefix=nullptr) ;
 
   /// helper functions to define a set in the WS
   void DefineSetInWS(const char* name, const RooArgSet& set);
 
   /// internal function to import Pdf in WS
   void ImportPdfInWS(const RooAbsPdf & pdf);
 
   /// internal function to import data in WS
   void ImportDataInWS(RooAbsData & data);
 
   TRef fRefWS;                     ///< WS reference used in the file
 
   std::string fWSName;             ///< name of the WS
 
   std::string fPdfName;            ///< name of  PDF in workspace
   std::string fDataName;           ///< name of data set in workspace
   std::string fPOIName;            ///< name for RooArgSet specifying parameters of interest
 
   std::string fNuisParamsName;     ///< name for RooArgSet specifying nuisance parameters
   std::string fConstrParamsName;   ///< name for RooArgSet specifying constrained parameters
   std::string fPriorPdfName;       ///< name for RooAbsPdf specifying a prior on the parameters
 
   std::string fConditionalObsName; ///< name for RooArgSet specifying conditional observables
   std::string fGlobalObsName;      ///< name for RooArgSet specifying global observables
   std::string fProtoDataName;      ///< name for RooArgSet specifying dataset that should be used as proto-data
 
   std::string fSnapshotName;       ///< name for RooArgSet that specifies a particular hypothesis
 
   std::string fObservablesName;    ///< name for RooArgSet specifying observable parameters.
 
   ClassDefOverride(ModelConfig,5)  ///< A class that holds configuration information for a model using a workspace as a store
 
};
 
}   // end namespace RooStats
 
 
#endif