KLMStripEfficiencyAlgorithm.h

/**************************************************************************
 * BASF2 (Belle Analysis Framework 2)                                     *
 * Copyright(C) 2019 - Belle II Collaboration                             *
 *                                                                        *
 * Author: The Belle II Collaboration                                     *
 * Contributors: Vitaliy Popov, Dmytro Minchenko                          *
 *                                                                        *
 * This software is provided "as is" without any warranty.                *
 **************************************************************************/
 
#pragma once
 
/* KLM headers. */
#include <klm/dataobjects/KLMElementNumbers.h>
#include <klm/dataobjects/KLMPlaneArrayIndex.h>
#include <klm/dbobjects/KLMStripEfficiency.h>
 
/* Belle 2 headers. */
#include <calibration/CalibrationAlgorithm.h>
 
namespace Belle2 {
  class KLMStripEfficiencyAlgorithm : public CalibrationAlgorithm {
 
  public:
 
    enum CalibrationStage {
 
      c_MeasurablePlaneCheck,
 
      c_EfficiencyMeasurement,
 
    };
 
    class Results {
 
      friend class KLMStripEfficiencyAlgorithm;
 
    public:
 
      Results();
 
      Results(const Results& results);
 
      ~Results();
 
      float getAchievedPrecision() const
      {
        return m_AchievedPrecision;
      }
 
      int getMatchedDigits() const
      {
        return m_MatchedDigits;
      }
 
      float* getEfficiency() const
      {
        return m_Efficiency;
      }
 
      int getExtHits() const
      {
        return m_ExtHits;
      }
 
      int* getExtHitsPlane() const
      {
        return m_ExtHitsPlane;
      }
 
      int newMeasuredPlanes(float* efficiency) const;
 
      int newExtHitsPlanes(int* extHitsPlane) const;
 
    private:
 
      float m_AchievedPrecision = 0;
 
      int m_MatchedDigits = 0;
 
      float* m_Efficiency = nullptr;
 
      int m_ExtHits = 0;
 
      int* m_ExtHitsPlane = nullptr;
 
    };
 
    KLMStripEfficiencyAlgorithm();
 
    KLMStripEfficiencyAlgorithm(const KLMStripEfficiencyAlgorithm&) = delete;
 
    KLMStripEfficiencyAlgorithm& operator=(const KLMStripEfficiencyAlgorithm&) = delete;
 
    ~KLMStripEfficiencyAlgorithm();
 
    CalibrationAlgorithm::EResult calibrate() override;
 
    void setOutputFileName(const char* outputFileName)
    {
      m_OutputFileName = outputFileName;
    }
 
    void setForcedCalibration(bool forcedCalibration)
    {
      m_ForcedCalibration = forcedCalibration;
    }
 
    void setCalibrationStage(enum CalibrationStage calibrationStage)
    {
      m_CalibrationStage = calibrationStage;
    }
 
    void setMinimalExtHits(int minimalExtHits)
    {
      m_MinimalExtHits = minimalExtHits;
    }
 
    void setRequestedPrecision(float requestedPrecision)
    {
      m_RequestedPrecision = requestedPrecision;
    }
 
    float getRequestedPrecision() const
    {
      return m_RequestedPrecision;
    }
 
    const Results* getResults() const
    {
      return &m_Results;
    }
 
  private:
 
    std::string m_OutputFileName = "TrackMatchedResult.root";
 
    bool m_ForcedCalibration = false;
 
    enum CalibrationStage m_CalibrationStage = c_MeasurablePlaneCheck;
 
    int m_MinimalExtHits = 10;
 
    float m_RequestedPrecision = 0.02;
 
    const KLMElementNumbers* m_ElementNumbers;
 
    const KLMPlaneArrayIndex* m_PlaneArrayIndex;
 
    Results m_Results;
 
    KLMStripEfficiency* m_StripEfficiency;
 
  };
 
}