// @(#)root/tmva $Id: Factory.h,v 1.9 2006/11/20 15:35:28 brun Exp $ // Author: Andreas Hoecker, Joerg Stelzer, Helge Voss, Kai Voss /********************************************************************************** * Project: TMVA - a Root-integrated toolkit for multivariate data analysis * * Package: TMVA * * Class : Factory * * Web : http://tmva.sourceforge.net * * * * Description: * * This is the main MVA steering class: it creates (books) all MVA methods, * * and guides them through the training, testing and evaluation phases. * * It also manages multiple MVA handling in case of distinct phase space * * requirements (cuts). * * * * Authors (alphabetical): * * Andreas Hoecker <Andreas.Hocker@cern.ch> - CERN, Switzerland * * Xavier Prudent <prudent@lapp.in2p3.fr> - LAPP, France * * Helge Voss <Helge.Voss@cern.ch> - MPI-K Heidelberg, Germany * * Kai Voss <Kai.Voss@cern.ch> - U. of Victoria, Canada * * * * Copyright (c) 2005: * * CERN, Switzerland, * * U. of Victoria, Canada, * * MPI-K Heidelberg, Germany , * * LAPP, Annecy, France * * * * Redistribution and use in source and binary forms, with or without * * modification, are permitted according to the terms listed in LICENSE * * (http://tmva.sourceforge.net/LICENSE) * **********************************************************************************/ #ifndef ROOT_TMVA_Factory #define ROOT_TMVA_Factory ////////////////////////////////////////////////////////////////////////// // // // Factory // // // // This is the main MVA steering class: it creates all MVA methods, // // and guides them through the training, testing and evaluation // // phases. It also manages multiple MVA handling in case of distinct // // phase space requirements (cuts). // // // ////////////////////////////////////////////////////////////////////////// #include <string> #include <vector> #include <map> #include "TCut.h" #include "TDirectory.h" #include "TTreeFormula.h" #ifndef ROOT_TMVA_Types #include "TMVA/Types.h" #endif #ifndef ROOT_TMatrixD #include "TMatrixD.h" #endif #ifndef ROOT_TMVA_DataSet #include "TMVA/DataSet.h" #endif #ifndef ROOT_TMVA_MsgLogger #include "TMVA/MsgLogger.h" #endif class TFile; class TTree; class TNtuple; namespace TMVA { class IMethod; class Factory : public TObject { public: // no default constructor Factory( TString theJobName, TFile* theTargetFile, TString theOption = "" ); // constructor used if no training, but only testing, application is desired Factory( TFile*theTargetFile ); // default destructor virtual ~Factory(); // the (colourfull) greeting void Greeting( TString="" ); // modified name (remove TMVA::) const char* GetName() const { return TString(TObject::GetName()).ReplaceAll( "TMVA::", "" ).Data(); } /* * Create signal and background trees from individual ascii files * note that the format of the file must be the following: * * myVar1/D:myVar2[2]/F:myVar3/I:myString/S * 3.1415 6.24 56.14 18 UmmmYeah * 4.31534 7.4555 9.1466 8 OhWell * ... * The first line says to make a tree with 4 branches. * The 1st branch will be called "myVar1" and will contain a Double_t. * The 2nd branch will be called "myVar2" and will contain a TArrayF. * The 3rd branch will be called "myVar3" and will contain an Int_t. * The 4th branch will be called "myString" and will contain a TObjString. */ Bool_t SetInputTrees(TString signalFileName, TString backgroundFileName, Double_t signalWeight=1.0, Double_t backgroundWeight=1.0 ); Bool_t SetInputTrees(TTree* inputTree, TCut SigCut, TCut BgCut = ""); // Set input trees at once Bool_t SetInputTrees(TTree* signal, TTree* background, Double_t signalWeight=1.0, Double_t backgroundWeight=1.0); // set signal tree void SetSignalTree(TTree* signal, Double_t weight=1.0); // set background tree void SetBackgroundTree(TTree* background, Double_t weight=1.0); // set input variable void SetInputVariables( std::vector<TString>* theVariables ); void AddVariable( const TString& expression, char type='F' ) { Data().AddVariable(expression, type); } void SetWeightExpression( const TString& variable) { Data().SetWeightExpression(variable); } // prepare input tree for training void PrepareTrainingAndTestTree(TCut cut = "",Int_t Ntrain = 0, Int_t Ntest = 0 , TString TreeName=""); // book multiple MVAs void BookMultipleMVAs(TString theVariable, Int_t nbins, Double_t *array); // process Multiple MVAs void ProcessMultipleMVA(); Bool_t BookMethod( TString theMethodName, TString methodTitle, TString theOption = "" ); Bool_t BookMethod( Types::EMVA theMethod, TString methodTitle, TString theOption = "" ); Bool_t BookMethod( TMVA::Types::EMVA theMethod, TString methodTitle, TString methodOption, TMVA::Types::EMVA theCommittee, TString committeeOption = "" ); // booking the method with a given weight file --> testing or application only // Bool_t BookMethod( IMethod *theMethod ); // training for all booked methods void TrainAllMethods( void ); // testing void TestAllMethods( void ); // performance evaluation void EvaluateAllMethods( void ); void EvaluateAllVariables( TString options = ""); // delete all methods and reset the method vector void DeleteAllMethods( void ); // accessors IMethod* GetMVA( TString method ); Bool_t Verbose( void ) const { return fVerbose; } void SetVerbose( Bool_t v=kTRUE ) { fVerbose = v; Data().SetVerbose(Verbose()); } protected: DataSet& Data() const { return *fDataSet; } DataSet& Data() { return *fDataSet; } private: // cd to local directory DataSet* fDataSet; // the dataset TFile* fTargetFile; // ROOT output file TString fOptions; // option string given by construction (presently only "V") Bool_t fVerbose; // verbose mode std::vector<TTreeFormula*> fInputVarFormulas; // local forulas of the same std::vector<IMethod*> fMethods; // all MVA methods TString fJobName; // jobname, used as extension in weight file names // driving flags for multi-cut (multiple MVAs) environment; required for internal mapping Bool_t fMultipleMVAs; // multi-cut mode ? Bool_t fMultipleStoredOptions; // multi-cut driving flag Bool_t fMultiTrain; // multi-cut driving flag Bool_t fMultiTest; // multi-cut driving flag Bool_t fMultiEvalVar; // multi-cut driving flag Bool_t fMultiEval; // multi-cut driving flag // in case of multiple MVAs, the cut given in the constructor determines the // distinguished phase-space regions Int_t fMultiNtrain; // number of training events Int_t fMultiNtest; // number of testing events // maps for multi-cut treatment containing: // TString: simple bin name (for directories without special characters) // TString: cut (human readable) // TCut : ROOT cut std::map<TString, std::pair<TString,TCut> > fMultipleMVAnames; // map of MVA names std::map<TString, std::pair<TString,TString> > fMultipleMVAMethodOptions; // map of option strings // local directory for each MVA in output target, used to store // specific monitoring histograms (e.g., reference distributions of likelihood method) TDirectory* fLocalTDir; protected: mutable MsgLogger fLogger; // message logger ClassDef(Factory,0) // The factory creates all MVA methods, and performs their training and testing ; }; } // namespace TMVA #endif