Fast photon propagation in quartz optics. More...

#include <FastRaytracer.h>

Inheritance diagram for FastRaytracer:

Public Types
enum	EGeometry { c_Unified = 0 , c_Segmented = 1 }
	Treatement of quartz geometry. More...

enum	EOptics { c_SemiLinear = 0 , c_Exact = 1 }
	Treatement of spherical mirror optics. More...

Public Member Functions
	FastRaytracer (int moduleID, EGeometry geometry=c_Unified, EOptics optics=c_SemiLinear)
	Constructor.

void	clear () const
	Clear mutable variables.

void	propagate (const PhotonState &photon, bool averaging=false) const
	Propagate photon to photo-detector plane.

const std::vector< PhotonState > &	getPhotonStates () const
	Returns photon states (results of propagation).

const std::vector< PhotonState > &	getExtraStates () const
	Returns extra states.

bool	getPropagationStatus () const
	Returns propagation status.

bool	getTotalReflStatus (double cosTotal) const
	Returns total internal reflection status.

double	getPropagationLen () const
	Returns total propagation length since initial position.

double	getPropagationLenDelta () const
	Returns total propagation length difference between true and flipped prism.

double	getXD () const
	Returns unfolded position in x at virtual Detector plane.

double	getYD () const
	Returns unfolded position in y at virtual Detector plane.

double	getInPlaneYD () const
	Returns unfolded position in y such that the prism unfolded windows are turned over into the real Detector plane.

double	getZD () const
	Returns unfolded position in z of virtual Detector plane.

double	getYB () const
	Returns unfolded position in y at Bar-prism-connection plane.

int	getNx () const
	Returns signed number of reflections in x.

int	getNxm () const
	Returns signed number of reflections in x before mirror.

int	getNxb () const
	Returns signed number of reflections in x after mirror and before prism.

int	getNxe () const
	Returns signed number of reflections in x inside prism.

int	getNy () const
	Returns signed number of reflections in y.

int	getNym () const
	Returns signed number of reflections in y before mirror.

int	getNyb () const
	Returns signed number of reflections in y after mirror and before prism.

int	getNye () const
	Returns signed number of reflections in y inside prism.

int	getNys () const
	Returns number of reflections on slanted prism surface.

int	getModuleID () const
	Returns slot ID.

EGeometry	getGeometry () const
	Returns quartz geometry treatement.

EOptics	getOptics () const
	Returns treatement of spherical mirror optics.

const std::vector< BarSegment > &	getBars () const
	Returns geometry data of bar segments.

const Mirror &	getMirror () const
	Returns geometry data of spherical mirror.

const Prism &	getPrism () const
	Returns geometry data of prism.

void	setMirrorCenter (double xc, double yc)
	Sets the mirror center-of-curvature.

Protected Attributes
int	m_moduleID = 0
	slot ID

EGeometry	m_geometry = c_Unified
	quartz geometry

EOptics	m_optics = c_SemiLinear
	spherical mirror optics

std::vector< BarSegment >	m_bars
	geometry data of bar segments

Mirror	m_mirror
	spherical mirror geometry data

Prism	m_prism
	prism geometry data

Private Attributes
std::vector< PhotonState >	m_photonStates
	photon states at propagation steps

std::vector< PhotonState >	m_extraStates
	extra storage

bool	m_status = false
	propagation status

int	m_Nxm = 0
	number of reflections in x before mirror

int	m_Nxb = 0
	number of reflections in x after mirror and before prism

int	m_Nxe = 0
	number of reflections in x inside prism

int	m_Nym = 0
	number of reflections in y before mirror

int	m_Nyb = 0
	number of reflections in y after mirror and before prism

int	m_Nye = 0
	number of reflections in y inside prism

Detailed Description

Fast photon propagation in quartz optics.

Definition at line 26 of file FastRaytracer.h.

Member Enumeration Documentation

◆ EGeometry

enum EGeometry

inherited

Treatement of quartz geometry.

Enumerator
c_Unified	single bar with average width and thickness
c_Segmented	segmented bars

Definition at line 33 of file RaytracerBase.h.

                     {
        c_Unified = 0,   
        c_Segmented = 1  
      };

◆ EOptics

enum EOptics

inherited

Treatement of spherical mirror optics.

Enumerator
c_SemiLinear	semi-linear approximation
c_Exact	exact optics

Definition at line 41 of file RaytracerBase.h.

                   {
        c_SemiLinear = 0, 
        c_Exact = 1       
      };

Constructor & Destructor Documentation

◆ FastRaytracer()

FastRaytracer	(	int	moduleID,
		EGeometry	geometry = `c_Unified`,
		EOptics	optics = `c_SemiLinear`
	)

inlineexplicit

Constructor.

Parameters

moduleID	slot ID
geometry	treatement of quartz geometry
optics	treatement of spherical mirror optics

Definition at line 36 of file FastRaytracer.h.

                                                                                                         :
        RaytracerBase(moduleID, geometry, optics)
      {};

Member Function Documentation

◆ clear()

void clear ( ) const

Clear mutable variables.

Definition at line 20 of file FastRaytracer.cc.

    {
      m_photonStates.clear();
      m_extraStates.clear();
      m_status = false;
      m_Nxm = 0;
      m_Nxb = 0;
      m_Nxe = 0;
      m_Nym = 0;
      m_Nyb = 0;
      m_Nye = 0;
    }

◆ getBars()

const std::vector< BarSegment > & getBars ( ) const

inlineinherited

Returns geometry data of bar segments.

Returns: geometry data of bar segments

Definition at line 161 of file RaytracerBase.h.

161{return m_bars;}

Belle2::TOP::RaytracerBase::m_bars

std::vector< BarSegment > m_bars

geometry data of bar segments

Definition: RaytracerBase.h:188

◆ getExtraStates()

const std::vector< PhotonState > & getExtraStates ( ) const

inline

Returns extra states.

Returns: extra states

Definition at line 62 of file FastRaytracer.h.

62{return m_extraStates;}

◆ getGeometry()

EGeometry getGeometry ( ) const

inlineinherited

Returns quartz geometry treatement.

Returns: quartz geometry treatement

Definition at line 149 of file RaytracerBase.h.

149{return m_geometry;}

Belle2::TOP::RaytracerBase::m_geometry

EGeometry m_geometry

quartz geometry

Definition: RaytracerBase.h:185

◆ getInPlaneYD()

double getInPlaneYD ( ) const

Returns unfolded position in y such that the prism unfolded windows are turned over into the real Detector plane.

Reliable only if propagation status is true. For reflected photons unfolding is done up to spherical mirror.

Returns: unfolded position in y at real Detector plane

Definition at line 143 of file FastRaytracer.cc.

    {
      if (m_photonStates.empty()) return 0;
 
      double y = m_photonStates.back().getY();
      for (int i = m_photonStates.size() - 1; i > 0; i--) {
        const auto& photonState = m_photonStates[i];
        if (photonState.getSegmentType() == PhotonState::c_MirrorSegment) break;
        y = photonState.getUnfoldedY(y);
      }
      return y;
    }

◆ getMirror()

const Mirror & getMirror ( ) const

inlineinherited

Returns geometry data of spherical mirror.

Returns: geometry data of spherical mirror

Definition at line 167 of file RaytracerBase.h.

167{return m_mirror;}

Belle2::TOP::RaytracerBase::m_mirror

Mirror m_mirror

spherical mirror geometry data

Definition: RaytracerBase.h:189

◆ getModuleID()

int getModuleID ( ) const

inlineinherited

Returns slot ID.

Returns: slot ID

Definition at line 143 of file RaytracerBase.h.

143{return m_moduleID;}

Belle2::TOP::RaytracerBase::m_moduleID

int m_moduleID

slot ID

Definition: RaytracerBase.h:184

◆ getNx()

int getNx ( ) const

Returns signed number of reflections in x.

Reliable only if propagation status is true.

Returns: number of reflections in x

Definition at line 180 of file FastRaytracer.cc.

    {
      int Nx = m_Nxm;
      Nx += (Nx % 2 == 0) ? m_Nxb : -m_Nxb;
      Nx += (Nx % 2 == 0) ? m_Nxe : -m_Nxe;
      return Nx;
    }

◆ getNxb()

int getNxb ( ) const

inline

Returns signed number of reflections in x after mirror and before prism.

Reliable only if propagation status is true.

Returns: number of reflections in x

Definition at line 152 of file FastRaytracer.h.

152{return m_Nxb;}

◆ getNxe()

int getNxe ( ) const

inline

Returns signed number of reflections in x inside prism.

Reliable only if propagation status is true.

Returns: number of reflections in x

Definition at line 159 of file FastRaytracer.h.

159{return m_Nxe;}

◆ getNxm()

int getNxm ( ) const

inline

Returns signed number of reflections in x before mirror.

Reliable only if propagation status is true.

Returns: number of reflections in x

Definition at line 145 of file FastRaytracer.h.

145{return m_Nxm;}

◆ getNy()

int getNy ( ) const

Returns signed number of reflections in y.

Reliable only if propagation status is true.

Returns: number of reflections in y

Definition at line 189 of file FastRaytracer.cc.

    {
      int Ny = m_Nym;
      Ny += (Ny % 2 == 0) ? m_Nyb : -m_Nyb;
      Ny += (Ny % 2 == 0) ? m_Nye : -m_Nye;
      return Ny;
    }

◆ getNyb()

int getNyb ( ) const

inline

Returns signed number of reflections in y after mirror and before prism.

Reliable only if propagation status is true.

Returns: number of reflections in y

Definition at line 180 of file FastRaytracer.h.

180{return m_Nyb;}

◆ getNye()

int getNye ( ) const

inline

Returns signed number of reflections in y inside prism.

Reliable only if propagation status is true.

Returns: number of reflections in y

Definition at line 187 of file FastRaytracer.h.

187{return m_Nye;}

◆ getNym()

int getNym ( ) const

inline

Returns signed number of reflections in y before mirror.

Reliable only if propagation status is true.

Returns: number of reflections in y

Definition at line 173 of file FastRaytracer.h.

173{return m_Nym;}

◆ getNys()

int getNys ( ) const

Returns number of reflections on slanted prism surface.

Reliable only if propagation status is true.

Returns: number of reflections on slanted prism surface

Definition at line 197 of file FastRaytracer.cc.

    {
      int N = (m_Nye > 0) ? m_Nye / 2 : (std::abs(m_Nye) + 1) / 2;
      return N;
    }

◆ getOptics()

EOptics getOptics ( ) const

inlineinherited

Returns treatement of spherical mirror optics.

Returns: spherical mirror optics

Definition at line 155 of file RaytracerBase.h.

155{return m_optics;}

Belle2::TOP::RaytracerBase::m_optics

EOptics m_optics

spherical mirror optics

Definition: RaytracerBase.h:186

◆ getPhotonStates()

const std::vector< PhotonState > & getPhotonStates ( ) const

inline

Returns photon states (results of propagation).

Returns: photon states

Definition at line 56 of file FastRaytracer.h.

56{return m_photonStates;}

◆ getPrism()

const Prism & getPrism ( ) const

inlineinherited

Returns geometry data of prism.

Returns: geometry data of prism

Definition at line 173 of file RaytracerBase.h.

173{return m_prism;}

Belle2::TOP::RaytracerBase::m_prism

Prism m_prism

prism geometry data

Definition: RaytracerBase.h:190

◆ getPropagationLen()

double getPropagationLen ( ) const

Returns total propagation length since initial position.

If averaging is ON the return value equals to arithmetic average of true and flipped prism.

Returns: propagation length

Definition at line 100 of file FastRaytracer.cc.

    {
      if (m_photonStates.empty()) return 0;
      if (m_extraStates.empty()) return m_photonStates.back().getPropagationLen();
      return (m_photonStates.back().getPropagationLen() + m_extraStates.back().getPropagationLen()) / 2;
    }

◆ getPropagationLenDelta()

double getPropagationLenDelta ( ) const

Returns total propagation length difference between true and flipped prism.

Returns: propagation length difference (or 0 if averaging is OFF)

Definition at line 107 of file FastRaytracer.cc.

    {
      if (m_photonStates.empty() or m_extraStates.empty()) return 0;
      return (m_photonStates.back().getPropagationLen() - m_extraStates.back().getPropagationLen());
    }

◆ getPropagationStatus()

bool getPropagationStatus ( ) const

inline

Returns propagation status.

Returns: true on success

Definition at line 68 of file FastRaytracer.h.

68{return m_status;}

◆ getTotalReflStatus()

bool getTotalReflStatus ( double cosTotal ) const

Returns total internal reflection status.

Reliable only if propagation status is true.

Parameters

cosTotal cosine of total reflection angle

Returns: true if totally reflected

Definition at line 92 of file FastRaytracer.cc.

    {
      for (const auto& photonState : m_photonStates) {
        if (not photonState.getTotalReflStatus(cosTotal)) return false;
      }
      return true;
    }

◆ getXD()

double getXD ( ) const

Returns unfolded position in x at virtual Detector plane.

If averaging is ON the return value equals to arithmetic average of true and flipped prism. Reliable only if propagation status is true. For reflected photons unfolding is done up to spherical mirror.

Returns: unfolded position in x at virtual Detector plane

Definition at line 113 of file FastRaytracer.cc.

    {
      if (m_photonStates.empty()) return 0;
 
      double x = m_extraStates.empty() ?
                 m_photonStates.back().getXD() : (m_photonStates.back().getXD() + m_extraStates.back().getXD()) / 2;
 
      for (int i = m_photonStates.size() - 2; i > 0; i--) {
        const auto& photonState = m_photonStates[i];
        if (photonState.getSegmentType() == PhotonState::c_MirrorSegment) break;
        x = photonState.getUnfoldedX(x);
      }
      return x;
    }

◆ getYB()

double getYB ( ) const

Returns unfolded position in y at Bar-prism-connection plane.

Reliable only if propagation status is true. For reflected photons unfolding is done up to spherical mirror.

Returns: unfolded position in y at Bar-prism-connection plane

Definition at line 165 of file FastRaytracer.cc.

    {
      if (m_photonStates.size() < 2) return 0;
 
      int i0 = m_photonStates.size() - 2;
      double y = m_photonStates[i0].getY();
      for (int i = i0; i > 0; i--) {
        const auto& photonState = m_photonStates[i];
        if (photonState.getSegmentType() == PhotonState::c_MirrorSegment) break;
        y = photonState.getUnfoldedY(y);
      }
      return y;
    }

◆ getYD()

double getYD ( ) const

Returns unfolded position in y at virtual Detector plane.

Reliable only if propagation status is true. For reflected photons unfolding is done up to spherical mirror.

Returns: unfolded position in y at virtual Detector plane

Definition at line 129 of file FastRaytracer.cc.

    {
      if (m_photonStates.empty()) return 0;
 
      double y = m_photonStates.back().getYD();
      for (int i = m_photonStates.size() - 2; i > 0; i--) {
        const auto& photonState = m_photonStates[i];
        if (photonState.getSegmentType() == PhotonState::c_MirrorSegment) break;
        y = photonState.getUnfoldedY(y);
      }
      return y;
    }

◆ getZD()

double getZD ( ) const

Returns unfolded position in z of virtual Detector plane.

If averaging is ON the return value equals to arithmetic average of true and flipped prism. Reliable only if propagation status is true.

Returns: unfolded position in z of virtual Detector plane

Definition at line 157 of file FastRaytracer.cc.

    {
      if (m_photonStates.empty()) return 0;
      if (m_extraStates.empty()) return m_photonStates.back().getZD();
      return (m_photonStates.back().getZD() + m_extraStates.back().getZD()) / 2;
    }

◆ propagate()

void propagate	(	const PhotonState &	photon,
		bool	averaging = `false`
	)		const

Propagate photon to photo-detector plane.

Parameters

photon	initial photon state
averaging	if true, propagate photon also in upside-down flipped prism

Definition at line 33 of file FastRaytracer.cc.

    {
      clear();
      m_photonStates.push_back(photon);
 
      int nbars = m_bars.size();
      if (photon.getKz() > 0 and photon.getZ() > m_prism.zR) {
        for (int i = 0; i < nbars; i++) {
          const auto& bar = m_bars[i];
          const auto& lastState = m_photonStates.back();
          if (lastState.getZ() >= bar.zR) continue;
          m_photonStates.push_back(lastState);
          auto& newState = m_photonStates.back();
          if (i < nbars - 1) {
            newState.propagate(bar);
          } else if (m_optics == c_SemiLinear) {
            newState.propagateSemiLinear(bar, m_mirror);
          } else {
            newState.propagateExact(bar, m_mirror);
          }
          if (not newState.getPropagationStatus()) return;
 
          m_Nxm += (m_Nxm % 2 == 0) ? newState.getNx() : -newState.getNx();
          m_Nym += (m_Nym % 2 == 0) ? newState.getNy() : -newState.getNy();
        }
      }
 
      for (int i = nbars - 1; i >= 0; i--) {
        const auto& bar = m_bars[i];
        const auto& lastState = m_photonStates.back();
        if (lastState.getZ() <= bar.zL) continue;
        m_photonStates.push_back(lastState);
        auto& newState = m_photonStates.back();
        newState.propagate(bar);
        if (not newState.getPropagationStatus()) return;
 
        m_Nxb += (m_Nxb % 2 == 0) ? newState.getNx() : -newState.getNx();
        m_Nyb += (m_Nyb % 2 == 0) ? newState.getNy() : -newState.getNy();
      }
 
      const auto& lastState = m_photonStates.back();
      m_photonStates.push_back(lastState);
      auto& newState = m_photonStates.back();
      newState.propagate(m_prism);
      if (not newState.getPropagationStatus()) return;
 
      if (averaging) {
        m_extraStates.push_back(lastState);
        auto& flippedState = m_extraStates.back().flipKy();
        flippedState.propagate(m_prism);
        if (not flippedState.getPropagationStatus()) return;
      }
 
      m_Nxe = newState.getNx();
      m_Nye = newState.getNy();
 
      m_status = true;
    }

◆ setMirrorCenter()

void setMirrorCenter	(	double	xc,
		double	yc
	)

inherited

Sets the mirror center-of-curvature.

Parameters

xc	center of curvature in x
yc	center of curvature in y

Definition at line 100 of file RaytracerBase.cc.

    {
      m_mirror.xc = xc;
      m_mirror.yc = yc;
 
      double zc = m_mirror.zc;
      double R = m_mirror.R;
      double zb = zc + R;
      double Ah = m_bars.back().A / 2;
      double Bh = m_bars.back().B / 2;
      zb = std::min(zb, zc + sqrt(pow(R, 2) - pow(xc - Ah, 2) - pow(yc - Bh, 2)));
      zb = std::min(zb, zc + sqrt(pow(R, 2) - pow(xc + Ah, 2) - pow(yc - Bh, 2)));
      zb = std::min(zb, zc + sqrt(pow(R, 2) - pow(xc - Ah, 2) - pow(yc + Bh, 2)));
      zb = std::min(zb, zc + sqrt(pow(R, 2) - pow(xc + Ah, 2) - pow(yc + Bh, 2)));
      m_mirror.zb = zb;
    }

Definition at line 190 of file RaytracerBase.h.

◆ m_status

bool m_status = false

mutableprivate

propagation status

Definition at line 201 of file FastRaytracer.h.

The documentation for this class was generated from the following files:

top/reconstruction_cpp/include/FastRaytracer.h
top/reconstruction_cpp/src/FastRaytracer.cc

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EGeometry

◆ EOptics

Constructor & Destructor Documentation

◆ FastRaytracer()

Member Function Documentation

◆ clear()

◆ getBars()

◆ getExtraStates()

◆ getGeometry()

◆ getInPlaneYD()

◆ getMirror()

◆ getModuleID()

◆ getNx()

◆ getNxb()

◆ getNxe()

◆ getNxm()

◆ getNy()

◆ getNyb()

◆ getNye()

◆ getNym()

◆ getNys()

◆ getOptics()

◆ getPhotonStates()

◆ getPrism()

◆ getPropagationLen()

◆ getPropagationLenDelta()

◆ getPropagationStatus()

◆ getTotalReflStatus()

◆ getXD()

◆ getYB()

◆ getYD()

◆ getZD()

◆ propagate()

◆ setMirrorCenter()

Member Data Documentation

◆ m_bars

◆ m_extraStates

◆ m_geometry

◆ m_mirror

◆ m_moduleID

◆ m_Nxb

◆ m_Nxe

◆ m_Nxm

◆ m_Nyb

◆ m_Nye

◆ m_Nym

◆ m_optics

◆ m_photonStates

◆ m_prism

◆ m_status