ROOT logo
// @(#)root/roostats:$Id: ModelConfig.h 27519 2009-02-19 13:31:41Z pellicci $
// Author: Kyle Cranmer, Lorenzo Moneta, Gregory Schott, Wouter Verkerke
/*************************************************************************
 * 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


#ifndef ROO_ABS_PDF
#include "RooAbsPdf.h"
#endif

#ifndef ROO_ABS_DATA
#include "RooAbsData.h"
#endif

#ifndef ROO_ARG_SET
#include "RooArgSet.h"
#endif

#ifndef ROO_WORKSPACE
#include "RooWorkspace.h"
#endif

#ifndef ROO_MSG_SERVICE
#include "RooMsgService.h"
#endif


//_________________________________________________
/*
BEGIN_HTML
<p>
ModelConfig is a simple class that holds configuration information specifying how a model
should be used in the context of various RooStats tools.  A single model can be used
in different ways, and this class should carry all that is needed to specify how it should be used.
</p>
END_HTML
*/
//

namespace RooStats {

class ModelConfig : public TNamed {

public:
   ModelConfig() : TNamed(){
      fWS = 0;
      fOwnsWorkspace = false;
   }
    
   ModelConfig(const char* name) : TNamed(name, name){
      fWS = 0;
      fOwnsWorkspace = false;
   }
    
   ModelConfig(const char* name, const char* title) : TNamed(name, title){
      fWS = 0;
      fOwnsWorkspace = false;
   }
    
   virtual ~ModelConfig() {
      // destructor.
      if( fOwnsWorkspace && fWS) delete fWS;
   }
    
   // set a workspace that owns all the necessary components for the analysis
   virtual void SetWorkspace(RooWorkspace & ws) {
      if (!fWS)
         fWS = &ws;
      else{
         RooMsgService::instance().setGlobalKillBelow(RooFit::ERROR) ;
         fWS->merge(ws);
         RooMsgService::instance().setGlobalKillBelow(RooFit::DEBUG) ;
      }
      
   }

   // helper function to avoid code duplication
   void DefineSet(const char* name, RooArgSet& set){
      if (!fWS) {
         fWS = new RooWorkspace();
         fOwnsWorkspace = true; 
      }
      if (! fWS->set( name )){
         RooMsgService::instance().setGlobalKillBelow(RooFit::ERROR) ;
         fWS->defineSet(name, set);
         RooMsgService::instance().setGlobalKillBelow(RooFit::DEBUG) ;
      }
   }
    

   // Set the DataSet, add to the the workspace if not already there
   virtual void SetData(RooAbsData & data) {      
      if (!fWS) {
         fWS = new RooWorkspace();
         fOwnsWorkspace = true; 
      }
      if (! fWS->data( data.GetName() ) ){
         RooMsgService::instance().setGlobalKillBelow(RooFit::ERROR) ;
         fWS->import(data);
         RooMsgService::instance().setGlobalKillBelow(RooFit::DEBUG) ;
      }
      SetData( data.GetName() );
      
   }

   // Set the proto DataSet, add to the the workspace if not already there
   virtual void SetProtoData(RooAbsData & data) {      
      if (!fWS) {
         fWS = new RooWorkspace();
         fOwnsWorkspace = true; 
      }
      if (! fWS->data( data.GetName() ) ){
         RooMsgService::instance().setGlobalKillBelow(RooFit::ERROR) ;
         fWS->import(data);
         RooMsgService::instance().setGlobalKillBelow(RooFit::DEBUG) ;
      }
      SetProtoData( data.GetName() );
   }
    
   // Set the Pdf, add to the the workspace if not already there
   virtual void SetPdf(RooAbsPdf& pdf) {
      if (!fWS) 
         fWS = new RooWorkspace();
      if (! fWS->pdf( pdf.GetName() ) ){
         RooMsgService::instance().setGlobalKillBelow(RooFit::ERROR) ;
         fWS->import(pdf);
         RooMsgService::instance().setGlobalKillBelow(RooFit::DEBUG) ;
      }
      SetPdf( pdf.GetName() );
   }
    
   // specify the parameters of interest in the interval
   virtual void SetParameters(RooArgSet& set) {
      string temp = GetName();
      temp+="_POI";
      fPOIName=temp.c_str();
      DefineSet(fPOIName, set);
   }
    
   // specify the nuisance parameters (eg. the rest of the parameters)
   virtual void SetNuisanceParameters(RooArgSet& set) {
      string temp = GetName();
      temp+="_NuisParams";
      fNuisParamsName=temp.c_str();
      DefineSet(fNuisParamsName, set);
   }

   // set parameter values for the null if using a common PDF
   virtual void SetSnapshot(RooArgSet& set) {
      string temp = GetName();
      temp+="_Snapshot";
      fSnapshotName=temp.c_str();
      DefineSet(fSnapshotName, set);
   }    
    
   // specify the name of the PDF in the workspace to be used
   virtual void SetPdf(const char* name) {
      if(!fWS){
         coutE(ObjectHandling) << "workspace not set" << endl;
         return;
      }
      if(fWS->pdf(name))
         fPdfName = name;
      else
         coutE(ObjectHandling) << "pdf "<<name<< " does not exist in workspace"<<endl;
   }

   // specify the name of the PDF in the workspace to be used
   virtual void SetPriorPdf(const char* name) {
      if(!fWS){
         coutE(ObjectHandling) << "workspace not set" << endl;
         return;
      }
      if(fWS->pdf(name))
         fPriorPdfName = name;
      else
         coutE(ObjectHandling) << "pdf "<<name<< " does not exist in workspace"<<endl;
   }

   // specify the name of the dataset in the workspace to be used
   virtual void SetData(const char* name){
      if(!fWS){
         coutE(ObjectHandling) << "workspace not set" << endl;
         return;
      }
      if(fWS->data(name))
         fDataName = name;
      else
         coutE(ObjectHandling) << "dataset "<<name<< " does not exist in workspace"<<endl;
   }

   // specify the name of the dataset in the workspace to be used
   virtual void SetProtoData(const char* name){
      if(!fWS){
         coutE(ObjectHandling) << "workspace not set" << endl;
         return;
      }
      if(fWS->data(name))
         fProtoDataName = name;
      else
         coutE(ObjectHandling) << "dataset "<<name<< " does not exist in workspace"<<endl;
   }


   /* getter methods */


   /// get model PDF (return NULL if pdf has not been specified or does not exist)
   RooAbsPdf * GetPdf() { return (fWS) ? fWS->pdf(fPdfName) : 0;   }

   /// get data set (return NULL if data set has not been specified or does not exist)
   RooAbsData * GetData() { return (fWS) ? fWS->data(fDataName) : 0; }

   /// get RooArgSet containing the parameter of interest (return NULL if not existing) 
   const RooArgSet * GetParametersOfInterest() { return (fWS) ? fWS->set(fPOIName) : 0; } 

   /// get RooArgSet containing the nuisance parameters (return NULL if not existing) 
   const RooArgSet * GetNuisanceParameters() { return (fWS) ? fWS->set(fNuisParamsName) : 0; } 

   /// get RooArgSet containing the constraint parameters (return NULL if not existing) 
   const RooArgSet * GetConstraintParameters() { return (fWS) ? fWS->set(fConstrainedParamName) : 0; } 

   /// get parameters prior pdf  (return NULL if not existing) 
   RooAbsPdf * GetPriorPdf() { return (fWS) ? fWS->pdf(fPriorPdfName) : 0; } 

   /// get RooArgSet for observales  (return NULL if not existing) 
   const RooArgSet * GetObservables() { return (fWS) ? fWS->set(fObservablesName) : 0; } 

   /// get RooArgSet for conditional observales  (return NULL if not existing) 
   const RooArgSet * GetConditionalObservables() { return (fWS) ? fWS->set(fConditionalObservablesName) : 0; } 

   /// get Proto data set (return NULL if not existing) 
   RooAbsData * GetProtoData()  {  return (fWS) ? fWS->data(fProtoDataName) : 0; } 

   /// get RooArgSet for parameters for a particular hypothesis  (return NULL if not existing) 
   const RooArgSet * GetSnapshot() { return (fWS) ? fWS->set(fSnapshotName) : 0; } 

    
protected:
    
   RooWorkspace* fWS; // a workspace that owns all the components to be used by the calculator
   Bool_t fOwnsWorkspace;
   const char* fPdfName; // name of  PDF in workspace
   const char* fDataName; // name of data set in workspace
   const char* fPOIName; // name for RooArgSet specifying parameters of interest
    
   const char* fNuisParamsName; // name for RooArgSet specifying nuisance parameters
   const char* fConstrainedParamName; // name for RooArgSet specifying constrained parameters
   const char* fPriorPdfName; // name for RooAbsPdf specifying a prior on the parameters
    
   const char* fConditionalObservablesName; // name for RooArgSet specifying conditional observables
   const char* fProtoDataName; // name for RooArgSet specifying dataset that should be used as protodata
    
   const char* fSnapshotName; // name for RooArgSet that specifies a particular hypothesis
    
   const char* fObservablesName; // name for RooArgSet specifying observable parameters. 
    
   ClassDef(ModelConfig,1) // A class that holds configuration information for a model using a workspace as a store
      
};

}   // end namespace RooStats


#endif
 ModelConfig.h:1
 ModelConfig.h:2
 ModelConfig.h:3
 ModelConfig.h:4
 ModelConfig.h:5
 ModelConfig.h:6
 ModelConfig.h:7
 ModelConfig.h:8
 ModelConfig.h:9
 ModelConfig.h:10
 ModelConfig.h:11
 ModelConfig.h:12
 ModelConfig.h:13
 ModelConfig.h:14
 ModelConfig.h:15
 ModelConfig.h:16
 ModelConfig.h:17
 ModelConfig.h:18
 ModelConfig.h:19
 ModelConfig.h:20
 ModelConfig.h:21
 ModelConfig.h:22
 ModelConfig.h:23
 ModelConfig.h:24
 ModelConfig.h:25
 ModelConfig.h:26
 ModelConfig.h:27
 ModelConfig.h:28
 ModelConfig.h:29
 ModelConfig.h:30
 ModelConfig.h:31
 ModelConfig.h:32
 ModelConfig.h:33
 ModelConfig.h:34
 ModelConfig.h:35
 ModelConfig.h:36
 ModelConfig.h:37
 ModelConfig.h:38
 ModelConfig.h:39
 ModelConfig.h:40
 ModelConfig.h:41
 ModelConfig.h:42
 ModelConfig.h:43
 ModelConfig.h:44
 ModelConfig.h:45
 ModelConfig.h:46
 ModelConfig.h:47
 ModelConfig.h:48
 ModelConfig.h:49
 ModelConfig.h:50
 ModelConfig.h:51
 ModelConfig.h:52
 ModelConfig.h:53
 ModelConfig.h:54
 ModelConfig.h:55
 ModelConfig.h:56
 ModelConfig.h:57
 ModelConfig.h:58
 ModelConfig.h:59
 ModelConfig.h:60
 ModelConfig.h:61
 ModelConfig.h:62
 ModelConfig.h:63
 ModelConfig.h:64
 ModelConfig.h:65
 ModelConfig.h:66
 ModelConfig.h:67
 ModelConfig.h:68
 ModelConfig.h:69
 ModelConfig.h:70
 ModelConfig.h:71
 ModelConfig.h:72
 ModelConfig.h:73
 ModelConfig.h:74
 ModelConfig.h:75
 ModelConfig.h:76
 ModelConfig.h:77
 ModelConfig.h:78
 ModelConfig.h:79
 ModelConfig.h:80
 ModelConfig.h:81
 ModelConfig.h:82
 ModelConfig.h:83
 ModelConfig.h:84
 ModelConfig.h:85
 ModelConfig.h:86
 ModelConfig.h:87
 ModelConfig.h:88
 ModelConfig.h:89
 ModelConfig.h:90
 ModelConfig.h:91
 ModelConfig.h:92
 ModelConfig.h:93
 ModelConfig.h:94
 ModelConfig.h:95
 ModelConfig.h:96
 ModelConfig.h:97
 ModelConfig.h:98
 ModelConfig.h:99
 ModelConfig.h:100
 ModelConfig.h:101
 ModelConfig.h:102
 ModelConfig.h:103
 ModelConfig.h:104
 ModelConfig.h:105
 ModelConfig.h:106
 ModelConfig.h:107
 ModelConfig.h:108
 ModelConfig.h:109
 ModelConfig.h:110
 ModelConfig.h:111
 ModelConfig.h:112
 ModelConfig.h:113
 ModelConfig.h:114
 ModelConfig.h:115
 ModelConfig.h:116
 ModelConfig.h:117
 ModelConfig.h:118
 ModelConfig.h:119
 ModelConfig.h:120
 ModelConfig.h:121
 ModelConfig.h:122
 ModelConfig.h:123
 ModelConfig.h:124
 ModelConfig.h:125
 ModelConfig.h:126
 ModelConfig.h:127
 ModelConfig.h:128
 ModelConfig.h:129
 ModelConfig.h:130
 ModelConfig.h:131
 ModelConfig.h:132
 ModelConfig.h:133
 ModelConfig.h:134
 ModelConfig.h:135
 ModelConfig.h:136
 ModelConfig.h:137
 ModelConfig.h:138
 ModelConfig.h:139
 ModelConfig.h:140
 ModelConfig.h:141
 ModelConfig.h:142
 ModelConfig.h:143
 ModelConfig.h:144
 ModelConfig.h:145
 ModelConfig.h:146
 ModelConfig.h:147
 ModelConfig.h:148
 ModelConfig.h:149
 ModelConfig.h:150
 ModelConfig.h:151
 ModelConfig.h:152
 ModelConfig.h:153
 ModelConfig.h:154
 ModelConfig.h:155
 ModelConfig.h:156
 ModelConfig.h:157
 ModelConfig.h:158
 ModelConfig.h:159
 ModelConfig.h:160
 ModelConfig.h:161
 ModelConfig.h:162
 ModelConfig.h:163
 ModelConfig.h:164
 ModelConfig.h:165
 ModelConfig.h:166
 ModelConfig.h:167
 ModelConfig.h:168
 ModelConfig.h:169
 ModelConfig.h:170
 ModelConfig.h:171
 ModelConfig.h:172
 ModelConfig.h:173
 ModelConfig.h:174
 ModelConfig.h:175
 ModelConfig.h:176
 ModelConfig.h:177
 ModelConfig.h:178
 ModelConfig.h:179
 ModelConfig.h:180
 ModelConfig.h:181
 ModelConfig.h:182
 ModelConfig.h:183
 ModelConfig.h:184
 ModelConfig.h:185
 ModelConfig.h:186
 ModelConfig.h:187
 ModelConfig.h:188
 ModelConfig.h:189
 ModelConfig.h:190
 ModelConfig.h:191
 ModelConfig.h:192
 ModelConfig.h:193
 ModelConfig.h:194
 ModelConfig.h:195
 ModelConfig.h:196
 ModelConfig.h:197
 ModelConfig.h:198
 ModelConfig.h:199
 ModelConfig.h:200
 ModelConfig.h:201
 ModelConfig.h:202
 ModelConfig.h:203
 ModelConfig.h:204
 ModelConfig.h:205
 ModelConfig.h:206
 ModelConfig.h:207
 ModelConfig.h:208
 ModelConfig.h:209
 ModelConfig.h:210
 ModelConfig.h:211
 ModelConfig.h:212
 ModelConfig.h:213
 ModelConfig.h:214
 ModelConfig.h:215
 ModelConfig.h:216
 ModelConfig.h:217
 ModelConfig.h:218
 ModelConfig.h:219
 ModelConfig.h:220
 ModelConfig.h:221
 ModelConfig.h:222
 ModelConfig.h:223
 ModelConfig.h:224
 ModelConfig.h:225
 ModelConfig.h:226
 ModelConfig.h:227
 ModelConfig.h:228
 ModelConfig.h:229
 ModelConfig.h:230
 ModelConfig.h:231
 ModelConfig.h:232
 ModelConfig.h:233
 ModelConfig.h:234
 ModelConfig.h:235
 ModelConfig.h:236
 ModelConfig.h:237
 ModelConfig.h:238
 ModelConfig.h:239
 ModelConfig.h:240
 ModelConfig.h:241
 ModelConfig.h:242
 ModelConfig.h:243
 ModelConfig.h:244
 ModelConfig.h:245
 ModelConfig.h:246
 ModelConfig.h:247
 ModelConfig.h:248
 ModelConfig.h:249
 ModelConfig.h:250
 ModelConfig.h:251
 ModelConfig.h:252
 ModelConfig.h:253
 ModelConfig.h:254
 ModelConfig.h:255
 ModelConfig.h:256
 ModelConfig.h:257
 ModelConfig.h:258
 ModelConfig.h:259
 ModelConfig.h:260
 ModelConfig.h:261
 ModelConfig.h:262
 ModelConfig.h:263
 ModelConfig.h:264
 ModelConfig.h:265
 ModelConfig.h:266
 ModelConfig.h:267
 ModelConfig.h:268
 ModelConfig.h:269
 ModelConfig.h:270
 ModelConfig.h:271
 ModelConfig.h:272
 ModelConfig.h:273