Module.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
 
/* CLHEP headers. */
#include <CLHEP/Geometry/Transform3D.h>
#include <CLHEP/Vector/Rotation.h>
#include <CLHEP/Vector/ThreeVector.h>
 
/* C++ headers. */
#include <vector>
 
namespace Belle2 {
  namespace bklm {
 
    class Module {
 
    public:
 
      Module(void);
 
      Module(double                    phiStripWidth,
             int                       phiStripMin,
             int                       phiStripMax,
             double                    zStripWidth,
             int                       zStripNumber,
             const CLHEP::Hep3Vector&  globalOrigin,
             const CLHEP::Hep3Vector&  localReconstructionShift,
             const CLHEP::HepRotation& rotation);
 
      Module(double                    stripWidth,
             int                       phiStripNumber,
             int                       phiSensorSide,
             int                       zStripNumber,
             const CLHEP::Hep3Vector&  globalOrigin,
             const CLHEP::Hep3Vector&  localReconstructionShift,
             const CLHEP::HepRotation& rotation,
             bool                      isFlipped);
 
      Module(const Module& m);
 
      Module& operator=(const Module& m);
 
      ~Module();
 
      bool isFlipped() const
      {
        return m_IsFlipped;
      }
 
      bool hasRPCs() const
      {
        return m_HasRPCs;
      }
 
      int getPhiStripMin() const
      {
        return m_PhiStripMin;
      }
 
      int getPhiStripMax() const
      {
        return m_PhiStripMax;
      }
 
      double getPhiStripWidth() const
      {
        return m_PhiStripWidth;
      }
 
      int getZStripMin() const
      {
        return m_ZStripMin;
      }
 
      int getZStripMax() const
      {
        return m_ZStripMax;
      }
 
      double getZStripWidth() const
      {
        return m_ZStripWidth;
      }
 
      void addPhiScint(int scint, double length, double offset, double position);
 
      void addZScint(int scint, double length, double offset, double position);
 
      double getPhiScintHalfLength(int scint) const
      {
        return 0.5 * m_PhiScintLengths[scint];
      }
 
      double getPhiScintOffset(int scint) const
      {
        return m_PhiScintOffsets[scint];
      }
 
      double getPhiScintPosition(int scint) const
      {
        return m_PhiScintPositions[scint];
      }
 
      double getZScintHalfLength(int scint) const
      {
        return 0.5 * m_ZScintLengths[scint];
      }
 
      double getZScintOffset(int scint) const
      {
        return m_ZScintOffsets[scint];
      }
 
      double getZScintPosition(int scint) const
      {
        return m_ZScintPositions[scint];
      }
 
      double getStripLength(int plane, int strip) const;
 
      const CLHEP::Hep3Vector getLocalPosition(double phiStripAve, double zStripAve) const;
 
      const CLHEP::Hep3Vector getPropagationDistance(const CLHEP::Hep3Vector&) const;
 
      double getPropagationDistance(const CLHEP::Hep3Vector& local,
                                    int strip, bool phiReadout) const;
 
      const CLHEP::Hep3Vector getPropagationDistance(
        const CLHEP::Hep3Vector&, int stripZ, int stripPhi) const;
 
      const CLHEP::Hep3Vector getPropagationTimes(const CLHEP::Hep3Vector&) const;
 
      double getPropagationTime(const CLHEP::Hep3Vector& local,
                                int strip, bool phiReadout) const;
 
      const CLHEP::Hep3Vector getPropagationTimes(
        const CLHEP::Hep3Vector&, int stripZ, int stripPhi) const;
 
      double getPhiStrip(const CLHEP::Hep3Vector& p) const
      {
        return p.y() / m_PhiStripWidth + m_PhiPositionBase;
      }
 
      double getZStrip(const CLHEP::Hep3Vector& p) const
      {
        return p.z() / m_ZStripWidth + m_ZPositionBase;
      }
 
      int getPhiStripNumber(const CLHEP::Hep3Vector& p) const;
 
      int getZStripNumber(const CLHEP::Hep3Vector& p) const;
 
      const CLHEP::Hep3Vector localToGlobal(const CLHEP::Hep3Vector& v, bool reco = false) const;
 
      const CLHEP::Hep3Vector RotateToLocal(const CLHEP::Hep3Vector& v) const
      {
        return m_RotationInverse * v;
      }
 
      const CLHEP::Hep3Vector RotateToGlobal(const CLHEP::Hep3Vector& v) const
      {
        return m_Rotation * v;
      }
 
      const CLHEP::Hep3Vector globalToLocal(const CLHEP::Hep3Vector& v,  bool reco = false) const;
 
      const CLHEP::Hep3Vector getLocalReconstructionShift() const
      {
        return m_LocalReconstructionShift;
      }
 
      const CLHEP::Hep3Vector getGlobalOrigin() const
      {
        return m_GlobalOrigin;
      }
 
      void setAlignment(const HepGeom::Transform3D& moduleAlignment);
 
      void setDisplacedGeo(const HepGeom::Transform3D& moduleDisplacedGeo);
 
      const HepGeom::Transform3D getAlignment() const
      {
        return m_Alignment;
      }
 
      const HepGeom::Transform3D getDisplacedGeo() const
      {
        return m_DisplacedGeo;
      }
 
      const CLHEP::HepRotation getRotationFromTransform3D(const HepGeom::Transform3D& trans) const;
 
      const CLHEP::Hep3Vector getTranslationFromTransform3D(const HepGeom::Transform3D& trans) const;
 
    private:
 
      bool m_HasRPCs;
 
      bool m_IsFlipped;
 
      double m_PhiStripWidth;
 
      int m_PhiStripMin;
 
      int m_PhiStripMax;
 
      double m_PhiPositionBase;
 
      double m_ZStripWidth;
 
      int m_ZStripMin;
 
      int m_ZStripMax;
 
      double m_ZPositionBase;
 
      int m_PhiSensorSide;
 
      double m_SignalSpeed;
 
      CLHEP::Hep3Vector m_GlobalOrigin;
 
      CLHEP::Hep3Vector m_LocalReconstructionShift;
 
      CLHEP::HepRotation m_Rotation;
 
      CLHEP::HepRotation m_RotationInverse;
 
      HepGeom::Transform3D m_Alignment;
 
      CLHEP::HepRotation m_AlignmentRotation;
 
      CLHEP::Hep3Vector m_AlignmentTranslation;
 
      HepGeom::Transform3D m_AlignmentInverse;
 
      CLHEP::HepRotation m_AlignmentRotationInverse;
 
      HepGeom::Transform3D m_DisplacedGeo;
 
      CLHEP::HepRotation m_DisplacedGeoRotation;
 
      CLHEP::Hep3Vector m_DisplacedGeoTranslation;
 
      HepGeom::Transform3D m_DisplacedGeoInverse;
 
      CLHEP::HepRotation m_DisplacedGeoRotationInverse;
 
      std::vector<double> m_PhiScintLengths;
 
      std::vector<double> m_PhiScintPositions;
 
      std::vector<double> m_PhiScintOffsets;
 
      std::vector<double> m_ZScintLengths;
 
      std::vector<double> m_ZScintPositions;
 
      std::vector<double> m_ZScintOffsets;
 
    };
 
  } // end of namespace bklm
 
} // end of namespace Belle2