TOPGeoModule.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 <top/dbobjects/TOPGeoBase.h>
#include <top/dbobjects/TOPGeoBarSegment.h>
#include <top/dbobjects/TOPGeoMirrorSegment.h>
#include <top/dbobjects/TOPGeoPrism.h>
#include <top/dbobjects/TOPGeoPMTArray.h>
#include <top/dbobjects/TOPGeoPMTArrayDisplacement.h>
#include <top/dbobjects/TOPGeoModuleDisplacement.h>
#include <Math/Transform3D.h>
#include <Math/Vector3D.h>
#include <Math/Point3D.h>
 
namespace Belle2 {
  class TOPGeoModule: public TOPGeoBase {
  public:
 
    TOPGeoModule()
    {}
 
    TOPGeoModule(int moduleID, double radius, double phi, double backwardZ,
                 const std::string& name = "TOPModule"): TOPGeoBase(name),
      m_moduleID(moduleID), m_radius(radius), m_phi(phi), m_backwardZ(backwardZ)
    {}
 
    TOPGeoModule(const TOPGeoModule& module);
 
    TOPGeoModule& operator=(const TOPGeoModule& module);
 
    ~TOPGeoModule();
 
    void setModuleCNumber(unsigned moduleCNumber) {m_moduleCNumber = moduleCNumber;}
 
    void setBarSegment1(const TOPGeoBarSegment& bar) {m_bar1 = bar;}
 
    void setBarSegment2(const TOPGeoBarSegment& bar) {m_bar2 = bar;}
 
    void setMirrorSegment(const TOPGeoMirrorSegment& mirror) {m_mirror = mirror;}
 
    void setPrism(const TOPGeoPrism& prism) {m_prism = prism;}
 
    void setPMTArray(const TOPGeoPMTArray& array) {m_pmtArray = array;}
 
    void setDecoupledPMT(unsigned pmtID) {m_pmtArray.setDecoupledPMT(pmtID);}
 
    void generateDecoupledPMTs(double fraction)
    {
      m_pmtArray.generateDecoupledPMTs(fraction);
    }
 
    void setBrokenGlue(int glueID, double fraction, double angle,
                       const std::string& material);
 
    void setPeelOffRegions(double thickness, const std::string& material);
 
    void appendPeelOffRegion(unsigned ID, double fraction, double angle)
    {
      m_prism.appendPeelOffRegion(ID, fraction, angle);
    }
 
 
    void setPMTArrayDisplacement(const TOPGeoPMTArrayDisplacement& displ)
    {
      m_arrayDisplacement = displ;
    }
 
    void setModuleDisplacement(const TOPGeoModuleDisplacement& displ)
    {
      m_moduleDisplacement = displ;
    }
 
    int getModuleID() const {return m_moduleID;}
 
    double getRadius() const {return m_radius / s_unit;}
 
    double getPhi() const {return m_phi;}
 
    double getBackwardZ() const {return m_backwardZ / s_unit;}
 
    unsigned getModuleCNumber() const {return m_moduleCNumber;}
 
    const TOPGeoBarSegment& getBarSegment1() const {return m_bar1;}
 
    const TOPGeoBarSegment& getBarSegment2() const {return m_bar2;}
 
    const TOPGeoMirrorSegment& getMirrorSegment() const {return m_mirror;}
 
    const TOPGeoPrism& getPrism() const {return m_prism;}
 
    const TOPGeoPMTArray& getPMTArray() const {return m_pmtArray;}
 
    const TOPGeoPMTArrayDisplacement& getPMTArrayDisplacement() const
    {
      return m_arrayDisplacement;
    }
 
    const TOPGeoModuleDisplacement& getModuleDisplacement() const
    {
      return m_moduleDisplacement;
    }
 
    double getBarLength() const
    {
      return m_bar1.getFullLength() + m_bar2.getFullLength() + m_mirror.getFullLength();
    }
 
    double getFullLength() const {return getBarLength() + m_prism.getFullLength();}
 
    double getForwardZ() const {return getBackwardZ() + getBarLength();}
 
    double getBarThickness() const
    {
      return (m_bar1.getThickness() * m_bar1.getFullLength() +
              m_bar2.getThickness() * m_bar2.getFullLength() +
              m_mirror.getThickness() * m_mirror.getFullLength()) / getBarLength();
    }
 
    double getBarWidth() const
    {
      return (m_bar1.getWidth() * m_bar1.getFullLength() +
              m_bar2.getWidth() * m_bar2.getFullLength() +
              m_mirror.getWidth() * m_mirror.getFullLength()) / getBarLength();
    }
 
    double getSurfaceReflectivity(double energy) const
    {
      return (m_bar1.getSurfaceReflectivity(energy) * m_bar1.getFullLength() +
              m_bar2.getSurfaceReflectivity(energy) * m_bar2.getFullLength() +
              m_mirror.getSurfaceReflectivity(energy) * m_mirror.getFullLength()) / getBarLength();
    }
 
    double getSigmaAlpha() const
    {
      return (m_bar1.getSigmaAlpha() * m_bar1.getFullLength() +
              m_bar2.getSigmaAlpha() * m_bar2.getFullLength() +
              m_mirror.getSigmaAlpha() * m_mirror.getFullLength()) / getBarLength();
    }
 
    double getZc() const {return (getBackwardZ() + getForwardZ()) / 2;}
 
    double getInnerRadius() const {return getRadius() - getBarThickness() / 2;}
 
    const ROOT::Math::Transform3D& getTransformation() const
    {
      if (not m_transform) setTransformation();
      return *m_transform;
    }
 
    const ROOT::Math::Transform3D& getTransformationNominal() const
    {
      if (not m_transformNominal) setTransformation();
      return *m_transformNominal;
    }
 
    ROOT::Math::XYZPoint pointToLocal(const ROOT::Math::XYZPoint& point) const;
 
    ROOT::Math::XYZVector momentumToLocal(const ROOT::Math::XYZVector& momentum) const;
 
    ROOT::Math::XYZPoint pointToGlobal(const ROOT::Math::XYZPoint& point) const;
 
    ROOT::Math::XYZVector momentumToGlobal(const ROOT::Math::XYZVector& momentum) const;
 
    ROOT::Math::XYZPoint pointGlobalToNominal(const ROOT::Math::XYZPoint& point) const;
 
    ROOT::Math::XYZVector momentumGlobalToNominal(const ROOT::Math::XYZVector& momentum) const;
 
    ROOT::Math::XYZPoint pointNominalToGlobal(const ROOT::Math::XYZPoint& point) const;
 
    ROOT::Math::XYZVector momentumNominalToGlobal(const ROOT::Math::XYZVector& momentum) const;
 
    bool isConsistent() const override;
 
    void print(const std::string& title = "Module geometry parameters") const override;
 
 
  private:
 
    void setTransformation() const;
 
    int m_moduleID = 0; 
    float m_radius = 0; 
    float m_phi = 0; 
    float m_backwardZ = 0; 
    unsigned m_moduleCNumber = 0; 
    TOPGeoBarSegment m_bar1; 
    TOPGeoBarSegment m_bar2; 
    TOPGeoMirrorSegment m_mirror; 
    TOPGeoPrism m_prism; 
    TOPGeoPMTArray m_pmtArray;  
    TOPGeoPMTArrayDisplacement m_arrayDisplacement;  
    TOPGeoModuleDisplacement m_moduleDisplacement;   
    mutable ROOT::Math::Transform3D* m_transform = 0;  
    mutable ROOT::Math::Transform3D* m_transformNominal = 0;  
 
    ClassDefOverride(TOPGeoModule, 3); 
  };
 
} // end namespace Belle2