QualityEstimatorMC.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <tracking/trackFindingVXD/trackQualityEstimators/QualityEstimatorBase.h>
#include <framework/datastore/StoreArray.h>
#include <tracking/dataobjects/RecoTrack.h>
#include <tracking/spacePointCreation/SpacePoint.h>
 
namespace Belle2 {
  class QualityEstimatorMC : public QualityEstimatorBase {
  public:
    // some typedefs to increase readability
    typedef int MCRecoTrackIndex; 
    typedef unsigned int NMatches; 
    typedef std::pair<MCRecoTrackIndex, NMatches> MatchInfo; 
    QualityEstimatorMC(const std::string& mcRecoTracksStoreArrayName = "MCRecoTracks",
                       bool strictQualityIndicator = true, bool mva_target = false):
      QualityEstimatorBase(), m_strictQualityIndicator(strictQualityIndicator), m_mva_target(mva_target),
      m_mcRecoTracksStoreArrayName(mcRecoTracksStoreArrayName)
    {
      m_mcRecoTracks.isRequired(m_mcRecoTracksStoreArrayName);
    };
 
    virtual double estimateQuality(std::vector<SpacePoint const*> const& measurements) final;
 
    virtual QualityEstimationResults estimateQualityAndProperties(std::vector<SpacePoint const*> const& measurements) override final;
 
    void setClustersNames(const std::string& svdClustersName, const std::string& pxdClustersName)
    {
      m_svdClustersName = svdClustersName;
      m_pxdClustersName = pxdClustersName;
      m_clusterNamesNeedSetting = false;
    };
 
    void forceUpdateClusterNames() {m_clusterNamesNeedSetting = true;}
 
  protected:
    MatchInfo getBestMatchToMCClusters(std::vector<SpacePoint const*> const& measurements);
 
    double calculateQualityIndicator(unsigned int nClusters, MatchInfo& match);
 
    // parameters
    bool m_strictQualityIndicator;
 
    bool m_mva_target;
 
    // module members
    std::string m_mcRecoTracksStoreArrayName; 
    std::string m_svdClustersName = ""; 
    std::string m_pxdClustersName = ""; 
    bool m_clusterNamesNeedSetting =
      true; 
    MatchInfo m_match;
 
    StoreArray<RecoTrack> m_mcRecoTracks;
  };
}