// @(#)root/tmva $Id: MethodCuts.h 23645 2008-05-03 15:33:17Z brun $ // Author: Andreas Hoecker, Matt Jachowski, Peter Speckmayer, Helge Voss, Kai Voss /********************************************************************************** * Project: TMVA - a Root-integrated toolkit for multivariate data analysis * * Package: TMVA * * Class : MethodCuts * * Web : http://tmva.sourceforge.net * * * * Description: * * Multivariate optimisation of signal efficiency for given background * * efficiency, using rectangular minimum and maximum requirements on * * input variables * * * * Authors (alphabetical): * * Andreas Hoecker - CERN, Switzerland * * Matt Jachowski - Stanford University, USA * * Peter Speckmayer - CERN, Switzerland * * Helge Voss - MPI-K Heidelberg, Germany * * Kai Voss - 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_MethodCuts #define ROOT_TMVA_MethodCuts ////////////////////////////////////////////////////////////////////////// // // // MethodCuts // // // // Multivariate optimisation of signal efficiency for given background // // efficiency, using rectangular minimum and maximum requirements on // // input variables // // // ////////////////////////////////////////////////////////////////////////// #include #include #ifndef ROOT_TMVA_MethodBase #include "TMVA/MethodBase.h" #endif #ifndef ROOT_TMVA_BinarySearchTree #include "TMVA/BinarySearchTree.h" #endif #ifndef ROOT_TMVA_PDF #include "TMVA/PDF.h" #endif #ifndef ROOT_TMVA_TMatrixD #include "TMatrixD.h" #endif #ifndef ROOT_TMVA_IFitterTarget #include "IFitterTarget.h" #endif class TRandom; namespace TMVA { class Interval; class MethodCuts : public MethodBase, public IFitterTarget { public: MethodCuts( const TString& jobName, const TString& methodTitle, DataSet& theData, const TString& theOption = "MC:150:10000:", TDirectory* theTargetFile = 0 ); MethodCuts( DataSet& theData, const TString& theWeightFile, TDirectory* theTargetDir = NULL ); virtual ~MethodCuts( void ); // training method void Train( void ); using MethodBase::WriteWeightsToStream; using MethodBase::ReadWeightsFromStream; // write weights to file void WriteWeightsToStream( ostream& o ) const; // read weights from file void ReadWeightsFromStream( istream& istr ); // calculate the MVA value (for CUTs this is just a dummy) Double_t GetMvaValue(); // write method specific histos to target file void WriteMonitoringHistosToFile( void ) const; // test the method void Test( TTree* theTestTree ); // also overwrite: Double_t GetSeparation ( TH1*, TH1* ) const { return 0; } Double_t GetSeparation ( PDF* = 0, PDF* = 0 ) const { return 0; } Double_t GetSignificance( void ) const { return 0; } Double_t GetmuTransform ( TTree *) { return 0; } Double_t GetEfficiency ( TString, TTree *, Double_t& ); Double_t GetTrainingEfficiency( TString ); // rarity distributions (signal or background (default) is uniform in [0,1]) Double_t GetRarity( Double_t, Types::ESBType ) const { return 0; } // accessors for Minuit Double_t ComputeEstimator( std::vector & ); Double_t EstimatorFunction( std::vector & ); Double_t EstimatorFunction( Int_t ievt1, Int_t ievt2 ); void SetTestSignalEfficiency( Double_t effS ) { fTestSignalEff = effS; } // retrieve cut values for given signal efficiency void PrintCuts( Double_t effS ) const; void GetCuts ( Double_t effS, std::vector& cutMin, std::vector& cutMax ) const; void GetCuts ( Double_t effS, Double_t* cutMin, Double_t* cutMax ) const; // ranking of input variables const Ranking* CreateRanking() { return 0; } void DeclareOptions(); void ProcessOptions(); // maximum |cut| value static const Double_t fgMaxAbsCutVal; protected: // make ROOT-independent C++ class for classifier response (classifier-specific implementation) void MakeClassSpecific( std::ostream&, const TString& ) const; // get help message text void GetHelpMessage() const; private: // optimisation method enum EFitMethodType { kUseMonteCarlo = 0, kUseGeneticAlgorithm, kUseSimulatedAnnealing, kUseMinuit, kUseEventScan, kUseMonteCarloEvents }; // efficiency calculation method // - kUseEventSelection: computes efficiencies from given data sample // - kUsePDFs : creates smoothed PDFs from data samples, and // uses this to compute efficiencies enum EEffMethod { kUseEventSelection = 0, kUsePDFs }; // improve the Monte Carlo by providing some additional information enum EFitParameters { kNotEnforced = 0, kForceMin, kForceMax, kForceSmart, kForceVerySmart }; // general TString fFitMethodS; // chosen fit method (string) EFitMethodType fFitMethod; // chosen fit method TString fEffMethodS; // chosen efficiency calculation method (string) EEffMethod fEffMethod; // chosen efficiency calculation method vector* fFitParams; // vector for series of fit methods Double_t fTestSignalEff; // used to test optimized signal efficiency Double_t* fCutRangeMin; // minimum of allowed cut range Double_t* fCutRangeMax; // maximum of allowed cut range vector fCutRange; // allowed ranges for cut optimisation // for the use of the binary tree method BinarySearchTree* fBinaryTreeS; BinarySearchTree* fBinaryTreeB; // MC method Int_t fNRandCuts; // number of random cut samplings Double_t** fCutMin; // minimum requirement Double_t** fCutMax; // maximum requirement Double_t* fTmpCutMin; // temporary minimum requirement Double_t* fTmpCutMax; // temporary maximum requirement TString* fAllVarsI; // what to do with variables // relevant for all methods Int_t fNpar; // number of parameters in fit (default: 2*Nvar) Double_t fEffRef; // reference efficiency vector* fRangeSign; // used to match cuts to fit parameters (and vice versa) TRandom* fRandom; // random generator for MC optimisation method // basic statistics vector* fMeanS; // means of variables (signal) vector* fMeanB; // means of variables (background) vector* fRmsS; // RMSs of variables (signal) vector* fRmsB; // RMSs of variables (background) TH1* fEffBvsSLocal; // intermediate eff. background versus eff signal histo // PDF section vector* fVarHistS; // reference histograms (signal) vector* fVarHistB; // reference histograms (background) vector* fVarHistS_smooth; // smoothed reference histograms (signal) vector* fVarHistB_smooth; // smoothed reference histograms (background) vector* fVarPdfS; // reference PDFs (signal) vector* fVarPdfB; // reference PDFs (background) // the definition of fit parameters can be different from the actual // cut requirements; these functions provide the matching void MatchParsToCuts( const std::vector&, Double_t*, Double_t* ); void MatchParsToCuts( Double_t*, Double_t*, Double_t* ); void MatchCutsToPars( std::vector&, Double_t*, Double_t* ); void MatchCutsToPars( std::vector&, Double_t**, Double_t**, Int_t ibin ); // creates PDFs in case these are used to compute efficiencies // (corresponds to: EffMethod == kUsePDFs) void CreateVariablePDFs( void ); // checks ordering of variables in vectors Bool_t SanityChecks( void ); // returns signal and background efficiencies for given cuts - using event counting void GetEffsfromSelection( Double_t* cutMin, Double_t* cutMax, Double_t& effS, Double_t& effB); // returns signal and background efficiencies for given cuts - using PDFs void GetEffsfromPDFs( Double_t* cutMin, Double_t* cutMax, Double_t& effS, Double_t& effB ); // default initialisation method called by all constructors void InitCuts( void ); ClassDef(MethodCuts,0) // Multivariate optimisation of signal efficiency }; } // namespace TMVA #endif