MethodKNN.h

Go to the documentation of this file.

// @(#)root/tmva $Id$
// Author: Rustem Ospanov
 
/**********************************************************************************
 * Project: TMVA - a Root-integrated toolkit for multivariate data analysis       *
 * Package: TMVA                                                                  *
 * Class  : MethodKNN                                                             *
 *                                             *
 *                                                                                *
 * Description:                                                                   *
 *      Analysis of k-nearest neighbor                                            *
 *                                                                                *
 * Author:                                                                        *
 *      Rustem Ospanov <rustem@fnal.gov> - U. of Texas at Austin, USA             *
 *                                                                                *
 * Copyright (c) 2007:                                                            *
 *      CERN, Switzerland                                                         *
 *      MPI-K Heidelberg, Germany                                                 *
 *      U. of Texas at Austin, USA                                                *
 *                                                                                *
 * Redistribution and use in source and binary forms, with or without             *
 * modification, are permitted according to the terms listed in LICENSE           *
 * (see tmva/doc/LICENSE)                                          *
 **********************************************************************************/
 
#ifndef ROOT_TMVA_MethodKNN
#define ROOT_TMVA_MethodKNN
 
//////////////////////////////////////////////////////////////////////////
//                                                                      //
// MethodKNN                                                            //
//                                                                      //
// Analysis of k-nearest neighbor                                       //
//                                                                      //
//////////////////////////////////////////////////////////////////////////
 
#include <vector>
 
// Local
#include "TMVA/MethodBase.h"
#include "TMVA/ModulekNN.h"
 
// SVD and linear discriminant code
#include "TMVA/LDA.h"
 
namespace TMVA
{
   namespace kNN
   {
      class ModulekNN;
   }
 
   class MethodKNN : public MethodBase
   {
   public:
 
      MethodKNN(const TString& jobName,
                const TString& methodTitle,
                DataSetInfo& theData,
                const TString& theOption = "KNN");
 
      MethodKNN(DataSetInfo& theData,
                const TString& theWeightFile);
 
      virtual ~MethodKNN( void );
 
      Bool_t HasAnalysisType( Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets ) override;
 
      void Train( void ) override;
 
      Double_t GetMvaValue( Double_t* err = nullptr, Double_t* errUpper = nullptr ) override;
      const std::vector<Float_t>& GetRegressionValues() override;
 
      using MethodBase::ReadWeightsFromStream;
 
      void WriteWeightsToStream(TFile& rf) const;
      void AddWeightsXMLTo( void* parent ) const override;
      void ReadWeightsFromXML( void* wghtnode ) override;
 
      void ReadWeightsFromStream(std::istream& istr) override;
      void ReadWeightsFromStream(TFile &rf) override;
 
      const Ranking* CreateRanking() override;
 
   protected:
 
      // make ROOT-independent C++ class for classifier response (classifier-specific implementation)
      void MakeClassSpecific( std::ostream&, const TString& ) const override;
 
      // get help message text
      void GetHelpMessage() const override;
 
   private:
 
      // the option handling methods
      void DeclareOptions() override;
      void ProcessOptions() override;
      void DeclareCompatibilityOptions() override;
 
      // default initialisation called by all constructors
      void Init( void ) override;
 
      // create kd-tree (binary tree) structure
      void MakeKNN( void );
 
      // polynomial and Gaussian kernel weight function
      Double_t PolnKernel(Double_t value) const;
      Double_t GausKernel(const kNN::Event &event_knn, const kNN::Event &event, const std::vector<Double_t> &svec) const;
 
      Double_t getKernelRadius(const kNN::List &rlist) const;
      const std::vector<Double_t> getRMS(const kNN::List &rlist, const kNN::Event &event_knn) const;
 
      double getLDAValue(const kNN::List &rlist, const kNN::Event &event_knn);
 
   private:
 
      // number of events (sumOfWeights)
      Double_t fSumOfWeightsS;        ///< sum-of-weights for signal training events
      Double_t fSumOfWeightsB;        ///< sum-of-weights for background training events
 
      kNN::ModulekNN *fModule;        ///<! module where all work is done
 
      Int_t fnkNN;            ///< number of k-nearest neighbors
      Int_t fBalanceDepth;    ///< number of binary tree levels used for balancing tree
 
      Float_t fScaleFrac;     ///< fraction of events used to compute variable width
      Float_t fSigmaFact;     ///< scale factor for Gaussian sigma in Gaus. kernel
 
      TString fKernel;        ///< ="Gaus","Poln" - kernel type for smoothing
 
      Bool_t fTrim;           ///< set equal number of signal and background events
      Bool_t fUseKernel;      ///< use polynomial kernel weight function
      Bool_t fUseWeight;      ///< use weights to count kNN
      Bool_t fUseLDA;         ///< use local linear discriminant analysis to compute MVA
 
      kNN::EventVec fEvent;   ///<! (untouched) events used for learning
 
      LDA fLDA;               ///<! Experimental feature for local knn analysis
 
      // for backward compatibility
      Int_t fTreeOptDepth;    ///< number of binary tree levels used for optimization
 
      ClassDefOverride(MethodKNN,0); // k Nearest Neighbour classifier
   };
 
} // namespace TMVA
 
#endif // MethodKNN