PndPidMvaAssociatorTask.h

Go to the documentation of this file.

//****************************************************************************
//*                   This file is part of PandaRoot.                        *
//*                                                                          *
//*            PandaRoot is distributed under the terms of the               *
//*              GNU General Public License (GPL) version 3,                 *
//*                 copied verbatim in the file "LICENSE".                   *
//*                                                                          *
//*  Copyright (C) 2006 - 2024 FAIR GmbH and copyright holders of PandaRoot  *
//*     The copyright holders are listed in the file "COPYRIGHTHOLDERS".     *
//*               The authors are listed in the file "AUTHORS".              *
//****************************************************************************

/* ************************************
 *  Author: M. Babai (M.Babai@rug.nl) *
 *                                    *
 *  pid classifier                    *
 *                                    *
 * Created: 23-03-2010                *
 * Modified:                          *
 *                                    *
 * ************************************/
//#pragma once
#ifndef PID_MVA_ASSOCIATOR_H
#define PID_MVA_ASSOCIATOR_H

// Standard C++ includes
#include <string>
#include <vector>

// Root includes.
class TClonesArray;

// PANDA and Fair includes.
#include "FairTask.h"
class FairRootManager;
class PndPidCandidate;
class PndPidProbability;

// MVA headers
class PndMvaClassifier;

// ========================================================================
typedef enum {
  UNKNOWN_METHOD = 0,
  KNN = 1,      // KNN methode
  LVQ = 2,      // LVQ
  TMVA_MLP = 3, // Multi label TMVA ANN.
  TMVA_BDT = 4  // Multi label TMVA BDT.
} Mva_MethodType;

// ========================================================================
class PndPidMvaAssociatorTask : public FairTask {
 public:
  PndPidMvaAssociatorTask();

  PndPidMvaAssociatorTask(char const *name);

  virtual ~PndPidMvaAssociatorTask();

  virtual void Exec(Option_t *option);

  virtual InitStatus Init();

  void Register();

  void Reset();

  inline void SetVerbose(Bool_t verb);

  virtual void SetParContainers();

  virtual void Finish();

  inline virtual void SetVarNames(std::vector<std::string> const &vNames);

  inline void SetClassNames(std::vector<std::string> const &clNames);

  inline void SetWeightFileName(std::string const &wFileName);

  inline void SetClassifier(Mva_MethodType const &methodT);

  void SetClassifier(std::string const &methodName);

  //______________ KNN- Classifier parameter _____________
  inline void SetNumNeigh(size_t val);

  inline void SetKnnEventParams(float scFact, double weight);

  //=============== Private members.
 private:
  // Copy const.
  PndPidMvaAssociatorTask(PndPidMvaAssociatorTask const &other);
  // Assignment operator.
  PndPidMvaAssociatorTask &operator=(PndPidMvaAssociatorTask const &other);

  void DoPidMatch(PndPidCandidate &pidcand, PndPidProbability &prob);

  std::vector<float> const *PrepareEvtVect(PndPidCandidate const &pidcand) const;

  FairRootManager *fManager;

  // Classifiers variables and functions
  /* Set the default path where the weights are stored. */
  void SetDefaultWeightsPath();

  std::vector<std::string> fVarNames;

  std::vector<std::string> fClassNames;

  std::string fWeightsFileName;

  size_t fNumNeigh;
  float fScFact;
  double fWeight;

  PndMvaClassifier *fClassifier;

  Mva_MethodType fMethodType;

  TClonesArray *fPidChargedCand; 
  TClonesArray *fPidChargedProb; 
  TClonesArray *fMCTrack;        
  // TClonesArray* fPidNeutralCand; //! PndPidCandidate TCA for neutral particles
  // TClonesArray* fPidNeutralProb; //! PndPidProbability TCA for neutral particles
  std::string fMethodName;

  ClassDef(PndPidMvaAssociatorTask, 0);
};

inline void PndPidMvaAssociatorTask::SetVerbose(Bool_t verb)
{
  fVerbose = verb;
};

inline void PndPidMvaAssociatorTask::SetVarNames(std::vector<std::string> const &vNames)
{
  fVarNames = vNames;
};

inline void PndPidMvaAssociatorTask::SetClassNames(std::vector<std::string> const &clNames)
{
  fClassNames = clNames;
};

inline void PndPidMvaAssociatorTask::SetWeightFileName(std::string const &wFileName)
{
  fWeightsFileName = wFileName;
};

inline void PndPidMvaAssociatorTask::SetNumNeigh(size_t val)
{
  fNumNeigh = val;
};

inline void PndPidMvaAssociatorTask::SetClassifier(Mva_MethodType const &methodT)
{
  fMethodType = methodT;
};

inline void PndPidMvaAssociatorTask::SetKnnEventParams(float scFact, double weight)
{
  fScFact = scFact;
  fWeight = weight;
};
#endif // End of interface definition (PndPidMvaAssociatorTask)