QualityEstimatorBase.h

/**************************************************************************
 * BASF2 (Belle Analysis Framework 2)                                     *
 * Copyright(C) 2017 - Belle II Collaboration                             *
 *                                                                        *
 * Author: The Belle II Collaboration                                     *
 * Contributors: Jonas Wagner                                             *
 *                                                                        *
 * This software is provided "as is" without any warranty.                *
 **************************************************************************/
 
#pragma once
 
#include <boost/optional.hpp>
 
#include <framework/geometry/B2Vector3.h>
#include <tracking/spacePointCreation/SpacePoint.h>
 
 
namespace Belle2 {
  struct QualityEstimationResults {
    double qualityIndicator = 0; 
    boost::optional<double> chiSquared; 
    boost::optional<short> curvatureSign; 
    boost::optional<double> pt; 
    boost::optional<double> pmag; 
    boost::optional<B2Vector3<double>> p; 
  };
 
  class QualityEstimatorBase {
 
  public:
    QualityEstimatorBase() {}
 
    virtual ~QualityEstimatorBase() = default;
 
    void setMagneticFieldStrength(double magneticFieldZ = 1.5) {m_magneticFieldZ = magneticFieldZ;}
 
    virtual double estimateQuality(std::vector<SpacePoint const*> const& measurements) = 0;
 
    virtual QualityEstimationResults estimateQualityAndProperties(std::vector<SpacePoint const*> const& measurements)
    {
      m_results = QualityEstimationResults();
      m_results.qualityIndicator = estimateQuality(measurements);
      return m_results;
    }
 
 
  protected:
    // utility methods
    double calcPt(double const radius) const { return m_magneticFieldZ * radius * 0.00299792458; }
 
    // Data members
    double m_magneticFieldZ = 1.5;
 
    QualityEstimationResults m_results;
  };
}