SensitiveDetectorBase.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.                  *
 **************************************************************************/
 
#ifndef VXD_SENSITIVEDETECTORBASE_H
#define VXD_SENSITIVEDETECTORBASE_H
 
//If this is defined, we create a root file with all information necessary to
//check functionality of the implementation
//#define VXD_SENSITIVEDETECTOR_DEBUG
 
#include <simulation/kernel/SensitiveDetectorBase.h>
#include <vxd/simulation/SensorTraversal.h>
#include <vxd/geometry/SensorInfoBase.h>
#include <stack>
#include <vector>
 
namespace Belle2 {
  namespace VXD {
    class SensitiveDetectorBase: public Simulation::SensitiveDetectorBase {
    public:
      explicit SensitiveDetectorBase(SensorInfoBase* info):
        Simulation::SensitiveDetectorBase((info->getType() == SensorInfoBase::PXD ? "PXD " : "SVD ") + (std::string)info->getID(),
                                          info->getType() == SensorInfoBase::PXD ? Const::PXD : Const::SVD), m_info(info) {};
 
      void setOptions(bool seeNeutrons, bool onlyPrimaryTrueHits, float distanceTolerance,
                      float electronTolerance, float minimumElectrons)
      {
        m_seeNeutrons = seeNeutrons;
        m_onlyPrimaryTrueHits = onlyPrimaryTrueHits;
        m_distanceTolerance = distanceTolerance;
        m_electronTolerance = electronTolerance;
        m_minimumElectrons = minimumElectrons;
      }
 
      virtual ~SensitiveDetectorBase() override
      {
        if (m_info) delete m_info;
      }
 
      SensorInfoBase* getSensorInfo() { return m_info; }
 
      VxdID getSensorID() const { return m_info->getID(); }
 
    protected:
      virtual int saveTrueHit(const SensorTraversal& traversal) = 0;
 
      virtual int saveSimHit(const SensorTraversal& traversal, const SensorTraversal::range& points) = 0;
 
      virtual void saveRelations(const SensorTraversal& traversal, int trueHitIndex,
                                 std::vector<std::pair<unsigned int, float>> simHitIndices) = 0;
 
      std::vector<unsigned int> simplifyEnergyDeposit(const SensorTraversal::range& points);
 
      StepInformation findMidPoint(const SensorTraversal& traversal);
    private:
      bool step(G4Step* step, G4TouchableHistory*) override;
 
      bool finishTrack();
 
      std::vector<std::pair<unsigned int, float>> createSimHits();
 
      SensorInfoBase* m_info {0};
      std::stack<SensorTraversal> m_tracks;
      float m_distanceTolerance {0};
      float m_electronTolerance {0};
      float m_minimumElectrons {0};
      bool m_seeNeutrons {false};
      bool m_onlyPrimaryTrueHits {false};
    };
  }
} //Belle2 namespace
#endif