Module Class Reference

Define the geometry of a BKLM module Each sector [octant] contains Modules. More...

#include <Module.h>

Public Member Functions
	Module (void)
	Empty constructor does nothing.
	Module (double phiStripWidth, int phiStripMin, int phiStripMax, double zStripWidth, int zStripNumber, const CLHEP::Hep3Vector &globalOrigin, const CLHEP::Hep3Vector &localReconstructionShift, const CLHEP::HepRotation &rotation)
	Constructor with explicit values (for RPC module)
	Module (double stripWidth, int phiStripNumber, int phiSensorSide, int zStripNumber, const CLHEP::Hep3Vector &globalOrigin, const CLHEP::Hep3Vector &localReconstructionShift, const CLHEP::HepRotation &rotation, bool isFlipped)
	Constructor with explicit values (for scint module)
	Module (const Module &m)
	Copy constructor.
Module &	operator= (const Module &m)
	Assignment operator: utilizes copy constructor.
	~Module ()
	Destructor.
bool	isFlipped () const
	Determine if this module is flipped by 180 degrees about z axis within its air gap.
bool	hasRPCs () const
	Determine if this module contains RPCs (true) or scintillators (false)
int	getPhiStripMin () const
	Get module's phi-strip minimum index.
int	getPhiStripMax () const
	Get module's phi-strip maximum index.
double	getPhiStripWidth () const
	Get phi-strip width.
int	getZStripMin () const
	Get module's z-strip minimum index.
int	getZStripMax () const
	Get module's z-strip maximum index.
double	getZStripWidth () const
	Get z-strip width.
void	addPhiScint (int scint, double length, double offset, double position)
	Add one phi-measuring scintillator strip to the module.
void	addZScint (int scint, double length, double offset, double position)
	Add one z-measuring scintillator strip to the module.
double	getPhiScintHalfLength (int scint) const
	Get the half-length (within the scintillator envelope) of a given phi-measuring scintillator.
double	getPhiScintOffset (int scint) const
	Get the longitudinal offset (within the scintillator envelope) of a given phi-measuring scintillator.
double	getPhiScintPosition (int scint) const
	Get the transverse position (within the scintillator envelope) of a given phi-measuring scintillator.
double	getZScintHalfLength (int scint) const
	Get the half-length (within the scintillator envelope) of a given z-measuring scintillator.
double	getZScintOffset (int scint) const
	Get the longitudinal offset (within the scintillator envelope) of a given z-measuring scintillator.
double	getZScintPosition (int scint) const
	Get the transverse position (within the scintillator envelope) of a given z-measuring scintillator.
double	getStripLength (int plane, int strip) const
	Get scintillator length.
const CLHEP::Hep3Vector	getLocalPosition (double phiStripAve, double zStripAve) const
	Convert 2D strip position (0..nStrips along each axis) to local coordinates.
const CLHEP::Hep3Vector	getPropagationDistance (const CLHEP::Hep3Vector &) const
	Convert local coordinates to signal-propagation distance (cm).
double	getPropagationDistance (const CLHEP::Hep3Vector &local, int strip, bool phiReadout) const
	Convert local coordinates to signal-propagation distance (cm) Version for scintillators.
const CLHEP::Hep3Vector	getPropagationDistance (const CLHEP::Hep3Vector &, int stripZ, int stripPhi) const
	Convert local coordinates to signal-propagation distance (cm) Version for scintillators.
const CLHEP::Hep3Vector	getPropagationTimes (const CLHEP::Hep3Vector &) const
	Convert local coordinates to signal-propagation time (ns) Version for RPCs.
double	getPropagationTime (const CLHEP::Hep3Vector &local, int strip, bool phiReadout) const
	Convert local coordinates to signal-propagation time (ns) Version for scintillators.
const CLHEP::Hep3Vector	getPropagationTimes (const CLHEP::Hep3Vector &, int stripZ, int stripPhi) const
	Convert local coordinates to signal-propagation time (ns) Version for scintillators.
double	getPhiStrip (const CLHEP::Hep3Vector &p) const
	Return phi strip (including fractional part) corresponding to local phi coordinate.
double	getZStrip (const CLHEP::Hep3Vector &p) const
	Return z strip (including fractional part) corresponding to local z coordinate.
int	getPhiStripNumber (const CLHEP::Hep3Vector &p) const
	Get phi strip corresponding to local phi coordinate.
int	getZStripNumber (const CLHEP::Hep3Vector &p) const
	Get z strip corresponding to local z coordinate.
const CLHEP::Hep3Vector	localToGlobal (const CLHEP::Hep3Vector &v, bool reco=false) const
	Transform space-point within this module from local to global coordinates.
const CLHEP::Hep3Vector	RotateToLocal (const CLHEP::Hep3Vector &v) const
	Rotate a vector from global to local system.
const CLHEP::Hep3Vector	RotateToGlobal (const CLHEP::Hep3Vector &v) const
	Rotate a vector from local to global system.
const CLHEP::Hep3Vector	globalToLocal (const CLHEP::Hep3Vector &v, bool reco=false) const
	Transform space-point within this module from global to local coordinates.
const CLHEP::Hep3Vector	getLocalReconstructionShift () const
	Return the local-coordinate real-vs-ideal translation of this module's sensitive volume; nominally (0,0,0)
const CLHEP::Hep3Vector	getGlobalOrigin () const
	Return the position (in global coordinates) of this module's sensitive-volume origin.
void	setAlignment (const HepGeom::Transform3D &moduleAlignment)
	Set the alignment Transformation.
void	setDisplacedGeo (const HepGeom::Transform3D &moduleDisplacedGeo)
	Set the displaced geometry Transformation.
const HepGeom::Transform3D	getAlignment () const
	Get the alignment Transformation.
const HepGeom::Transform3D	getDisplacedGeo () const
	Get the displaced geometry Transformation.
const CLHEP::HepRotation	getRotationFromTransform3D (const HepGeom::Transform3D &trans) const
	Get the rotation from Transform3D.
const CLHEP::Hep3Vector	getTranslationFromTransform3D (const HepGeom::Transform3D &trans) const
	Get the translation from Transform3D.

Private Attributes
bool	m_HasRPCs
	flag to indicate whether this module contains RPCs (true) or scintillators (false)
bool	m_IsFlipped
	flag to indicate if this module is flipped by 180 degrees about z axis within its air gap
double	m_PhiStripWidth
	to store the width (in cm) of each phi strip this module
int	m_PhiStripMin
	to store the minimum phi strip number in this module
int	m_PhiStripMax
	to store the maximum phi strip number in this module
double	m_PhiPositionBase
	to store the base position (in strip
double	m_ZStripWidth
	to store the width (in cm) of each z strip in this module
int	m_ZStripMin
	to store the minimum z strip number in this module
int	m_ZStripMax
	to store the maximum z strip number in this module
double	m_ZPositionBase
	to store the base position (in strip
int	m_PhiSensorSide
	to store the sensor side for phi scintillators
double	m_SignalSpeed
	to store the signal-propagation speed (cm/ns) along the strip
CLHEP::Hep3Vector	m_GlobalOrigin
	to store the position (in global coordinates) of this module's sensitive-volume origin
CLHEP::Hep3Vector	m_LocalReconstructionShift
	to store the local-coordinate real-vs-ideal translation of this module's sensitive volume
CLHEP::HepRotation	m_Rotation
	to store the rotation matrix (in global coordinates) of this module's sector
CLHEP::HepRotation	m_RotationInverse
	to store the inverse of the rotation matrix (in global coordinates) of this module's sector
HepGeom::Transform3D	m_Alignment
	alignment transformation (rotation + shift)
CLHEP::HepRotation	m_AlignmentRotation
	rotation of the alignment transformation
CLHEP::Hep3Vector	m_AlignmentTranslation
	translation of the alignment transformation
HepGeom::Transform3D	m_AlignmentInverse
	inverse of alignment transformation
CLHEP::HepRotation	m_AlignmentRotationInverse
	inverse of the rotation of the alignment transformation
HepGeom::Transform3D	m_DisplacedGeo
	displaced geometry w.r.t the nominal geometry, as transformation (rotation + shift)
CLHEP::HepRotation	m_DisplacedGeoRotation
	rotation of the displaced geometry transformation
CLHEP::Hep3Vector	m_DisplacedGeoTranslation
	translation of the displaced geometry transformation
HepGeom::Transform3D	m_DisplacedGeoInverse
	inverse of displaced geometry transformation
CLHEP::HepRotation	m_DisplacedGeoRotationInverse
	inverse of the rotation of displaced geometry transformation
std::vector< double >	m_PhiScintLengths
	to store the length of each phi-measuring scintillator
std::vector< double >	m_PhiScintPositions
	to store the transverse position (within scintillator envelope) of each phi-measuring scintillator
std::vector< double >	m_PhiScintOffsets
	to store the longitudinal offset (within scintillator envelope) of each phi-measuring scintillator
std::vector< double >	m_ZScintLengths
	to store the length of each z-measuring scintillator
std::vector< double >	m_ZScintPositions
	to store the transverse position (within scintillator envelope) of each z-measuring scintillator
std::vector< double >	m_ZScintOffsets
	to store the longitudinal offset (within scintillator envelope) of each z-measuring scintillator

Detailed Description

Define the geometry of a BKLM module Each sector [octant] contains Modules.

Sectors are numbered 1..8, moving counterclockwise around the global z axis in the global x-y plane. The local geometry of a sector and its modules is defined by the orientation of sector 1 (centred on the global +x axis).

 SECTOR 1 GLOBAL COORDINATES        SECTOR s LOCAL COORDINATES

+y _ +y _ ^ / | ^ / | | / | | / | | / | |/ | | / | /| | | | end | || end |

• - - - - - | view | - - > +x - - - - - |+ view | - - > +x | | | | \ | \ | \ | \ | \ | \ | _| _|

The sector's local origin is shifted along the global z axis so that it is at the boundary between the forward and backward barrel KLM.

The sector's local origin is shifted along the local +x axis so that it coincides with the middle of the layer-1 gap (=slot between iron layers); outer layers are at larger values of sector-local x. The module's local origin is shifted along the local x axis so that it is in the middle of the module's sensitive volume. The module's local origin is also shifted slightly along the local y and z axes so that it is in the middle of the sensitive volume along the local y axis and at the edge nearest the local origin of the sensitive volume along the local z axis.

For the backward sectors, the module is rotated by 180 degrees about the +x axis so that the orientation of the local z axis is flipped from the global orientation so that all modules extend along the local +z axis from the local z=0 (which is nearest the forward-backward boundary).

Strip numbering for RPCs: z-measuring strips: #1 is nearest the I.P., sensors are at the other end phi-measuring strips: #1 is on the local -y end, sensors are at the local +y end

Strip numbering for scintillatorss: z-measuring strips: #1 is nearest the I.P., sensors are at the other end phi-measuring strips: if phiSensorSide > 0: #1 is on the local -y end, sensors are at the local +y end if phiSensorSide < 0: #1 is on the local +y end, sensors are at the local -y end

Definition at line 76 of file Module.h.

Constructor & Destructor Documentation

Module() [1/4]

Module

(

void

)

Empty constructor does nothing.

Definition at line 24 of file Module.cc.

               :
  m_HasRPCs(false),
  m_IsFlipped(false),
  m_PhiStripWidth(0.0),
  m_PhiStripMin(0),
  m_PhiStripMax(0),
  m_PhiPositionBase(0.0),
  m_ZStripWidth(0.0),
  m_ZStripMin(0),
  m_ZStripMax(0),
  m_ZPositionBase(0.0),
  m_PhiSensorSide(0),
  m_SignalSpeed(0.0),
  m_GlobalOrigin(CLHEP::Hep3Vector()),
  m_LocalReconstructionShift(CLHEP::Hep3Vector()),
  m_Rotation(CLHEP::HepRotation()),
  m_Alignment(HepGeom::Transform3D()),
  m_AlignmentRotation(CLHEP::HepRotation()),
  m_AlignmentTranslation(CLHEP::Hep3Vector()),
  m_AlignmentInverse(HepGeom::Transform3D()),
  m_AlignmentRotationInverse(CLHEP::HepRotation()),
  m_DisplacedGeo(HepGeom::Transform3D()),
  m_DisplacedGeoRotation(CLHEP::HepRotation()),
  m_DisplacedGeoTranslation(CLHEP::Hep3Vector()),
  m_DisplacedGeoInverse(HepGeom::Transform3D()),
  m_DisplacedGeoRotationInverse(CLHEP::HepRotation())
{
  m_RotationInverse = m_Rotation.inverse();
  m_PhiScintPositions.clear();
  m_PhiScintLengths.clear();
  m_PhiScintOffsets.clear();
  m_ZScintPositions.clear();
  m_ZScintLengths.clear();
  m_ZScintOffsets.clear();
}

Module() [2/4]

Module	(	double	phiStripWidth,
		int	phiStripMin,
		int	phiStripMax,
		double	zStripWidth,
		int	zStripNumber,
		const CLHEP::Hep3Vector &	globalOrigin,
		const CLHEP::Hep3Vector &	localReconstructionShift,
		const CLHEP::HepRotation &	rotation
	)

Constructor with explicit values (for RPC module)

Definition at line 61 of file Module.cc.

                                                 :
  m_HasRPCs(true),
  m_IsFlipped(false),
  m_PhiStripWidth(phiStripWidth),
  m_PhiStripMin(phiStripMin),
  m_PhiStripMax(phiStripMax),
  m_PhiPositionBase(0.5 * (phiStripMin + phiStripMax - 1) + 1.0), // start at #1
  m_ZStripWidth(zStripWidth),
  m_ZStripMin(1),
  m_ZStripMax(zStripNumber),
  m_ZPositionBase(1.0), // start at #1
  m_PhiSensorSide(1),
  m_SignalSpeed(0.5 * Const::speedOfLight),
  m_GlobalOrigin(globalOrigin),
  m_LocalReconstructionShift(localReconstructionShift),
  m_Rotation(rotation),
  m_Alignment(HepGeom::Transform3D()),
  m_AlignmentRotation(CLHEP::HepRotation()),
  m_AlignmentTranslation(CLHEP::Hep3Vector()),
  m_AlignmentInverse(HepGeom::Transform3D()),
  m_AlignmentRotationInverse(CLHEP::HepRotation()),
  m_DisplacedGeo(HepGeom::Transform3D()),
  m_DisplacedGeoRotation(CLHEP::HepRotation()),
  m_DisplacedGeoTranslation(CLHEP::Hep3Vector()),
  m_DisplacedGeoInverse(HepGeom::Transform3D()),
  m_DisplacedGeoRotationInverse(CLHEP::HepRotation())
{
  m_RotationInverse = m_Rotation.inverse();
  m_PhiScintLengths.clear();
  m_PhiScintPositions.clear();
  m_PhiScintOffsets.clear();
  m_ZScintLengths.clear();
  m_ZScintPositions.clear();
  m_ZScintOffsets.clear();
}

Module() [3/4]

Module	(	double	stripWidth,
		int	phiStripNumber,
		int	phiSensorSide,
		int	zStripNumber,
		const CLHEP::Hep3Vector &	globalOrigin,
		const CLHEP::Hep3Vector &	localReconstructionShift,
		const CLHEP::HepRotation &	rotation,
		bool	isFlipped
	)

Constructor with explicit values (for scint module)

Definition at line 105 of file Module.cc.

                                                    :
  m_HasRPCs(false),
  m_IsFlipped(isFlipped),
  m_PhiStripWidth(stripWidth),
  m_PhiStripMin(1),
  m_PhiStripMax(phiStripNumber),
  m_PhiPositionBase(0.5 * phiStripNumber + 1.0), // start at #1
  m_ZStripWidth(stripWidth),
  m_ZStripMin(1),
  m_ZStripMax(zStripNumber),
  m_ZPositionBase(1.0), // start at #1
  m_PhiSensorSide(phiSensorSide),
  m_SignalSpeed(0.5671 * Const::speedOfLight), // m_firstPhotonlightSpeed, from EKLM
  m_GlobalOrigin(globalOrigin),
  m_LocalReconstructionShift(localReconstructionShift),
  m_Rotation(rotation),
  m_Alignment(HepGeom::Transform3D()),
  m_AlignmentRotation(CLHEP::HepRotation()),
  m_AlignmentTranslation(CLHEP::Hep3Vector()),
  m_AlignmentInverse(HepGeom::Transform3D()),
  m_AlignmentRotationInverse(CLHEP::HepRotation()),
  m_DisplacedGeo(HepGeom::Transform3D()),
  m_DisplacedGeoRotation(CLHEP::HepRotation()),
  m_DisplacedGeoTranslation(CLHEP::Hep3Vector()),
  m_DisplacedGeoInverse(HepGeom::Transform3D()),
  m_DisplacedGeoRotationInverse(CLHEP::HepRotation())
{
  if (isFlipped)
    m_Rotation.rotateZ(M_PI);
  m_RotationInverse = m_Rotation.inverse();
  m_PhiScintLengths.clear();
  m_PhiScintPositions.clear();
  m_PhiScintOffsets.clear();
  m_ZScintLengths.clear();
  m_ZScintPositions.clear();
  m_ZScintOffsets.clear();
}

Module() [4/4]

Module

(

const Module &

m

)

Copy constructor.

Definition at line 151 of file Module.cc.

                              :
  m_HasRPCs(m.m_HasRPCs),
  m_IsFlipped(m.m_IsFlipped),
  m_PhiStripWidth(m.m_PhiStripWidth),
  m_PhiStripMin(m.m_PhiStripMin),
  m_PhiStripMax(m.m_PhiStripMax),
  m_PhiPositionBase(m.m_PhiPositionBase),
  m_ZStripWidth(m.m_ZStripWidth),
  m_ZStripMin(m.m_ZStripMin),
  m_ZStripMax(m.m_ZStripMax),
  m_ZPositionBase(m.m_ZPositionBase),
  m_PhiSensorSide(m.m_PhiSensorSide),
  m_SignalSpeed(m.m_SignalSpeed),
  m_GlobalOrigin(m.m_GlobalOrigin),
  m_LocalReconstructionShift(m.m_LocalReconstructionShift),
  m_Rotation(m.m_Rotation),
  m_RotationInverse(m.m_RotationInverse),
  m_Alignment(m.m_Alignment),
  m_AlignmentRotation(m.m_AlignmentRotation),
  m_AlignmentTranslation(m.m_AlignmentTranslation),
  m_AlignmentInverse(m.m_AlignmentInverse),
  m_AlignmentRotationInverse(m.m_AlignmentRotationInverse),
  m_DisplacedGeo(m.m_DisplacedGeo),
  m_DisplacedGeoRotation(m.m_DisplacedGeoRotation),
  m_DisplacedGeoTranslation(m.m_DisplacedGeoTranslation),
  m_DisplacedGeoInverse(m.m_DisplacedGeoInverse),
  m_DisplacedGeoRotationInverse(m.m_DisplacedGeoRotationInverse),
  m_PhiScintLengths(m.m_PhiScintLengths),
  m_PhiScintPositions(m.m_PhiScintPositions),
  m_PhiScintOffsets(m.m_PhiScintOffsets),
  m_ZScintLengths(m.m_ZScintLengths),
  m_ZScintPositions(m.m_ZScintPositions),
  m_ZScintOffsets(m.m_ZScintOffsets)
{
}

~Module()

~Module

(

)

Destructor.

Definition at line 227 of file Module.cc.

{
}

Member Function Documentation

addPhiScint()

void addPhiScint	(	int	scint,
		double	length,
		double	offset,
		double	position
	)

Add one phi-measuring scintillator strip to the module.

Definition at line 231 of file Module.cc.

{
  while (m_PhiScintLengths.size() <= (unsigned int)scint) {
    m_PhiScintLengths.push_back(0.0);
    m_PhiScintOffsets.push_back(0.0);
    m_PhiScintPositions.push_back(0.0);
  }
  m_PhiScintLengths[scint] = length;
  m_PhiScintOffsets[scint] = offset;
  m_PhiScintPositions[scint] = position;
}

addZScint()

void addZScint	(	int	scint,
		double	length,
		double	offset,
		double	position
	)

Add one z-measuring scintillator strip to the module.

Definition at line 243 of file Module.cc.

{
  while (m_ZScintLengths.size() <= (unsigned int)scint) {
    m_ZScintLengths.push_back(0.0);
    m_ZScintOffsets.push_back(0.0);
    m_ZScintPositions.push_back(0.0);
  }
  m_ZScintLengths[scint] = length;
  m_ZScintOffsets[scint] = offset;
  m_ZScintPositions[scint] = position;
}

getAlignment()

const HepGeom::Transform3D getAlignment ( ) const

inline

Get the alignment Transformation.

Definition at line 297 of file Module.h.

      {
        return m_Alignment;
      }

getDisplacedGeo()

const HepGeom::Transform3D getDisplacedGeo ( ) const

inline

Get the displaced geometry Transformation.

Definition at line 303 of file Module.h.

      {
        return m_DisplacedGeo;
      }

getGlobalOrigin()

const CLHEP::Hep3Vector getGlobalOrigin ( ) const

inline

Return the position (in global coordinates) of this module's sensitive-volume origin.

Definition at line 285 of file Module.h.

      {
        return m_GlobalOrigin;
      }

getLocalPosition()

const CLHEP::Hep3Vector getLocalPosition	(	double	phiStripAve,
		double	zStripAve
	)		const

Convert 2D strip position (0..nStrips along each axis) to local coordinates.

Definition at line 265 of file Module.cc.

{
  // "+0.5" assures that the local position is in the middle of the strip
  return CLHEP::Hep3Vector(0.0,
                           (phiStripAve - m_PhiPositionBase + 0.5) * m_PhiStripWidth,
                           (zStripAve - m_ZPositionBase + 0.5) * m_ZStripWidth);
}

getLocalReconstructionShift()

const CLHEP::Hep3Vector getLocalReconstructionShift ( ) const

inline

Return the local-coordinate real-vs-ideal translation of this module's sensitive volume; nominally (0,0,0)

Definition at line 279 of file Module.h.

      {
        return m_LocalReconstructionShift;
      }

getPhiScintHalfLength()

double getPhiScintHalfLength ( int  scint ) const

inline

Get the half-length (within the scintillator envelope) of a given phi-measuring scintillator.

Definition at line 167 of file Module.h.

      {
        return 0.5 * m_PhiScintLengths[scint];
      }

getPhiScintOffset()

double getPhiScintOffset ( int  scint ) const

inline

Get the longitudinal offset (within the scintillator envelope) of a given phi-measuring scintillator.

Definition at line 173 of file Module.h.

      {
        return m_PhiScintOffsets[scint];
      }

getPhiScintPosition()

double getPhiScintPosition ( int  scint ) const

inline

Get the transverse position (within the scintillator envelope) of a given phi-measuring scintillator.

Definition at line 179 of file Module.h.

      {
        return m_PhiScintPositions[scint];
      }

getPhiStrip()

double getPhiStrip ( const CLHEP::Hep3Vector &  p ) const

inline

Return phi strip (including fractional part) corresponding to local phi coordinate.

Definition at line 237 of file Module.h.

      {
        return p.y() / m_PhiStripWidth + m_PhiPositionBase;
      }

getPhiStripMax()

int getPhiStripMax ( ) const

inline

Get module's phi-strip maximum index.

Definition at line 131 of file Module.h.

      {
        return m_PhiStripMax;
      }

getPhiStripMin()

int getPhiStripMin ( ) const

inline

Get module's phi-strip minimum index.

Definition at line 125 of file Module.h.

      {
        return m_PhiStripMin;
      }

getPhiStripNumber()

int getPhiStripNumber

(

const CLHEP::Hep3Vector &

p

)

const

Get phi strip corresponding to local phi coordinate.

Returns

Strip number, -1 if not found.

Definition at line 349 of file Module.cc.

{
  int strip = std::floor(getPhiStrip(p));
  if (strip < m_PhiStripMin || strip > m_PhiStripMax)
    return -1;
  return strip;
}

getPhiStripWidth()

double getPhiStripWidth ( ) const

inline

Get phi-strip width.

Definition at line 137 of file Module.h.

      {
        return m_PhiStripWidth;
      }

getPropagationDistance() [1/3]

const CLHEP::Hep3Vector getPropagationDistance

(

const CLHEP::Hep3Vector &

local

)

const

Convert local coordinates to signal-propagation distance (cm).

Version for RPCs.

Definition at line 290 of file Module.cc.

{
  double dy = m_PhiPositionBase * m_PhiStripWidth - m_PhiSensorSide * local.y();
  double dz = m_ZStripMax * m_ZStripWidth - local.z();
  return CLHEP::Hep3Vector(0.0, dz, dy);
}

getPropagationDistance() [2/3]

const CLHEP::Hep3Vector getPropagationDistance	(	const CLHEP::Hep3Vector &	local,
		int	stripZ,
		int	stripPhi
	)		const

Convert local coordinates to signal-propagation distance (cm) Version for scintillators.

Definition at line 297 of file Module.cc.

{
  double distanceZ = getPropagationDistance(local, stripZ, false);
  double distancePhi = getPropagationDistance(local, stripPhi, true);
  return CLHEP::Hep3Vector(0.0, distancePhi, distanceZ);
}

getPropagationDistance() [3/3]

double getPropagationDistance	(	const CLHEP::Hep3Vector &	local,
		int	strip,
		bool	phiReadout
	)		const

Convert local coordinates to signal-propagation distance (cm) Version for scintillators.

The value m_PhiSensorSide == -1 corresponds to SiPMs at positive local coordinate (and vice versa). Consequently, the sign is negative.

Definition at line 273 of file Module.cc.

{
  double distance;
  if (phiReadout) {
    distance = m_ZStripMax * m_ZStripWidth - local.z();
  } else {
    distance = fabs(m_ZScintOffsets[strip] -
                    0.5 * m_PhiSensorSide * m_ZScintLengths[strip] - local.y());
  }
  return distance;
}

getPropagationTime()

double getPropagationTime	(	const CLHEP::Hep3Vector &	local,
		int	strip,
		bool	phiReadout
	)		const

Convert local coordinates to signal-propagation time (ns) Version for scintillators.

Definition at line 311 of file Module.cc.

{
  double distance = getPropagationDistance(local, strip, phiReadout);
  return distance / m_SignalSpeed;
}

getPropagationTimes() [1/2]

const CLHEP::Hep3Vector getPropagationTimes

(

const CLHEP::Hep3Vector &

local

)

const

Convert local coordinates to signal-propagation time (ns) Version for RPCs.

Definition at line 305 of file Module.cc.

{
  const CLHEP::Hep3Vector proDist = getPropagationDistance(local);
  return CLHEP::Hep3Vector(0.0, proDist[1] / m_SignalSpeed, proDist[2] / m_SignalSpeed);
}

getPropagationTimes() [2/2]

const CLHEP::Hep3Vector getPropagationTimes	(	const CLHEP::Hep3Vector &	local,
		int	stripZ,
		int	stripPhi
	)		const

Convert local coordinates to signal-propagation time (ns) Version for scintillators.

Definition at line 318 of file Module.cc.

{
  double distanceZ = getPropagationDistance(local, stripZ, false);
  double distancePhi = getPropagationDistance(local, stripPhi, true);
  return CLHEP::Hep3Vector(0.0, distancePhi / m_SignalSpeed, distanceZ / m_SignalSpeed);
}

getRotationFromTransform3D()

const CLHEP::HepRotation getRotationFromTransform3D

(

const HepGeom::Transform3D &

trans

)

const

Get the rotation from Transform3D.

Definition at line 393 of file Module.cc.

{
  HepGeom::Scale3D scale;
  HepGeom::Rotate3D rotation;
  HepGeom::Translate3D translation;
  trans.getDecomposition(scale, rotation, translation);
  CLHEP::HepRep3x3 rRep(rotation.xx(), rotation.xy(), rotation.xz(),
                        rotation.yx(), rotation.yy(), rotation.yz(),
                        rotation.zx(), rotation.zy(), rotation.zz()
                       );
  CLHEP::HepRotation r;
  r.set(rRep);
  return r;
}

getStripLength()

double getStripLength	(	int	plane,
		int	strip
	)		const

Get scintillator length.

Definition at line 255 of file Module.cc.

{
  if (plane == BKLMElementNumbers::c_ZPlane)
    return m_ZScintLengths[strip];
  else if (plane == BKLMElementNumbers::c_PhiPlane)
    return m_PhiScintLengths[strip];
  else
    B2FATAL("Incorrect plane number.");
}

getTranslationFromTransform3D()

const CLHEP::Hep3Vector getTranslationFromTransform3D

(

const HepGeom::Transform3D &

trans

)

const

Get the translation from Transform3D.

Definition at line 383 of file Module.cc.

{
  HepGeom::Scale3D scale;
  HepGeom::Rotate3D rotation;
  HepGeom::Translate3D translation;
  trans.getDecomposition(scale, rotation, translation);
  CLHEP::Hep3Vector t(translation.dx(), translation.dy(), translation.dz());
  return t;
}

getZScintHalfLength()

double getZScintHalfLength ( int  scint ) const

inline

Get the half-length (within the scintillator envelope) of a given z-measuring scintillator.

Definition at line 185 of file Module.h.

      {
        return 0.5 * m_ZScintLengths[scint];
      }

getZScintOffset()

double getZScintOffset ( int  scint ) const

inline

Get the longitudinal offset (within the scintillator envelope) of a given z-measuring scintillator.

Definition at line 191 of file Module.h.

      {
        return m_ZScintOffsets[scint];
      }

getZScintPosition()

double getZScintPosition ( int  scint ) const

inline

Get the transverse position (within the scintillator envelope) of a given z-measuring scintillator.

Definition at line 197 of file Module.h.

      {
        return m_ZScintPositions[scint];
      }

getZStrip()

double getZStrip ( const CLHEP::Hep3Vector &  p ) const

inline

Return z strip (including fractional part) corresponding to local z coordinate.

Definition at line 243 of file Module.h.

      {
        return p.z() / m_ZStripWidth + m_ZPositionBase;
      }

getZStripMax()

int getZStripMax ( ) const

inline

Get module's z-strip maximum index.

Definition at line 149 of file Module.h.

      {
        return m_ZStripMax;
      }

getZStripMin()

int getZStripMin ( ) const

inline

Get module's z-strip minimum index.

Definition at line 143 of file Module.h.

      {
        return m_ZStripMin;
      }

getZStripNumber()

int getZStripNumber

(

const CLHEP::Hep3Vector &

p

)

const

Get z strip corresponding to local z coordinate.

Returns

Strip number, -1 if not found.

Definition at line 357 of file Module.cc.

{
  int strip = std::floor(getZStrip(p));
  if (strip < m_ZStripMin || strip > m_ZStripMax)
    return -1;
  return strip;
}

getZStripWidth()

double getZStripWidth ( ) const

inline

Get z-strip width.

Definition at line 155 of file Module.h.

      {
        return m_ZStripWidth;
      }

globalToLocal()

const CLHEP::Hep3Vector globalToLocal	(	const CLHEP::Hep3Vector &	v,
		bool	reco = false
	)		const

Transform space-point within this module from global to local coordinates.

Parameters

[in]	v	Point in global coordinates.
[in]	reco	Apply alignment correction (true) or return nominal position (false).

Definition at line 339 of file Module.cc.

{
  CLHEP::Hep3Vector vlocal = m_RotationInverse * (v - m_GlobalOrigin); //now in nominal local
  vlocal = m_DisplacedGeoRotationInverse * (vlocal - m_DisplacedGeoTranslation); //now in displaced local
  if (reco) {
    vlocal = m_AlignmentRotationInverse * (vlocal - m_AlignmentTranslation); //now in real local
  }
  return vlocal;
}

hasRPCs()

bool hasRPCs ( ) const

inline

Determine if this module contains RPCs (true) or scintillators (false)

Definition at line 119 of file Module.h.

      {
        return m_HasRPCs;
      }

isFlipped()

bool isFlipped ( ) const

inline

Determine if this module is flipped by 180 degrees about z axis within its air gap.

Definition at line 113 of file Module.h.

      {
        return m_IsFlipped;
      }

localToGlobal()

const CLHEP::Hep3Vector localToGlobal	(	const CLHEP::Hep3Vector &	v,
		bool	reco = false
	)		const

Transform space-point within this module from local to global coordinates.

Parameters

[in]	v	Point in local coordinates.
[in]	reco	Apply alignment correction (true) or return nominal position (false).

Definition at line 326 of file Module.cc.

{
  CLHEP::Hep3Vector vlocal(v.x(), v.y(), v.z());
  if (m_reco) {
    vlocal = m_AlignmentRotation * vlocal + m_AlignmentTranslation; // to nominal + displaced local
    vlocal = m_DisplacedGeoRotation * vlocal + m_DisplacedGeoTranslation; //to nominal local
    return m_Rotation * vlocal + m_GlobalOrigin; //to global
  } else {
    vlocal = m_DisplacedGeoRotation * vlocal + m_DisplacedGeoTranslation; // to nominal local
    return m_Rotation * vlocal + m_GlobalOrigin; //to global
  }
}

operator=()

Module & operator=

(

const Module &

m

)

Assignment operator: utilizes copy constructor.

Definition at line 188 of file Module.cc.

{
  if (this != &m) {
    m_HasRPCs = m.m_HasRPCs;
    m_IsFlipped = m.m_IsFlipped;
    m_PhiStripWidth = m.m_PhiStripWidth;
    m_PhiStripMin = m.m_PhiStripMin;
    m_PhiStripMax = m.m_PhiStripMax;
    m_PhiPositionBase = m.m_PhiPositionBase;
    m_ZStripWidth = m.m_ZStripWidth;
    m_ZStripMin = m.m_ZStripMin;
    m_ZStripMax = m.m_ZStripMax;
    m_ZPositionBase = m.m_ZPositionBase;
    m_PhiSensorSide = m.m_PhiSensorSide;
    m_SignalSpeed = m.m_SignalSpeed;
    m_GlobalOrigin = m.m_GlobalOrigin;
    m_LocalReconstructionShift = m.m_LocalReconstructionShift;
    m_Rotation = m.m_Rotation;
    m_RotationInverse = m.m_RotationInverse;
    m_Alignment = m.m_Alignment;
    m_AlignmentRotation = m.m_AlignmentRotation;
    m_AlignmentTranslation = m.m_AlignmentTranslation;
    m_AlignmentInverse = m.m_AlignmentInverse;
    m_AlignmentRotationInverse = m.m_AlignmentRotationInverse;
    m_DisplacedGeo = m.m_DisplacedGeo;
    m_DisplacedGeoRotation = m.m_DisplacedGeoRotation;
    m_DisplacedGeoTranslation = m.m_DisplacedGeoTranslation;
    m_DisplacedGeoInverse = m.m_DisplacedGeoInverse;
    m_DisplacedGeoRotationInverse = m.m_DisplacedGeoRotationInverse;
    m_PhiScintLengths = m.m_PhiScintLengths;
    m_PhiScintPositions = m.m_PhiScintPositions;
    m_PhiScintOffsets = m.m_PhiScintOffsets;
    m_ZScintLengths = m.m_ZScintLengths;
    m_ZScintPositions = m.m_ZScintPositions;
    m_ZScintOffsets = m.m_ZScintOffsets;
  }
  return *this;
}

RotateToGlobal()

const CLHEP::Hep3Vector RotateToGlobal ( const CLHEP::Hep3Vector &  v ) const

inline

Rotate a vector from local to global system.

Definition at line 268 of file Module.h.

      {
        return m_Rotation * v;
      }

RotateToLocal()

const CLHEP::Hep3Vector RotateToLocal ( const CLHEP::Hep3Vector &  v ) const

inline

Rotate a vector from global to local system.

Definition at line 262 of file Module.h.

      {
        return m_RotationInverse * v;
      }

setAlignment()

void setAlignment

(

const HepGeom::Transform3D &

moduleAlignment

)

Set the alignment Transformation.

Definition at line 365 of file Module.cc.

{
  m_Alignment = moduleAlignment;
  m_AlignmentRotation = getRotationFromTransform3D(moduleAlignment);
  m_AlignmentTranslation = getTranslationFromTransform3D(moduleAlignment);
  m_AlignmentInverse = moduleAlignment.inverse();
  m_AlignmentRotationInverse = getRotationFromTransform3D(m_AlignmentInverse);
}

setDisplacedGeo()

void setDisplacedGeo

(

const HepGeom::Transform3D &

moduleDisplacedGeo

)

Set the displaced geometry Transformation.

Definition at line 374 of file Module.cc.

{
  m_DisplacedGeo = moduleDisplacedGeo;
  m_DisplacedGeoRotation = getRotationFromTransform3D(moduleDisplacedGeo);
  m_DisplacedGeoTranslation = getTranslationFromTransform3D(moduleDisplacedGeo);
  m_DisplacedGeoInverse = moduleDisplacedGeo.inverse();
  m_DisplacedGeoRotationInverse = getRotationFromTransform3D(m_DisplacedGeoInverse);
}

Member Data Documentation

m_Alignment

HepGeom::Transform3D m_Alignment

private

alignment transformation (rotation + shift)

Definition at line 365 of file Module.h.

m_AlignmentInverse

HepGeom::Transform3D m_AlignmentInverse

private

inverse of alignment transformation

Definition at line 374 of file Module.h.

m_AlignmentRotation

CLHEP::HepRotation m_AlignmentRotation

private

rotation of the alignment transformation

Definition at line 368 of file Module.h.

m_AlignmentRotationInverse

CLHEP::HepRotation m_AlignmentRotationInverse

private

inverse of the rotation of the alignment transformation

Definition at line 377 of file Module.h.

m_AlignmentTranslation

CLHEP::Hep3Vector m_AlignmentTranslation

private

translation of the alignment transformation

Definition at line 371 of file Module.h.

m_DisplacedGeo

HepGeom::Transform3D m_DisplacedGeo

private

displaced geometry w.r.t the nominal geometry, as transformation (rotation + shift)

Definition at line 380 of file Module.h.

m_DisplacedGeoInverse

HepGeom::Transform3D m_DisplacedGeoInverse

private

inverse of displaced geometry transformation

Definition at line 389 of file Module.h.

m_DisplacedGeoRotation

CLHEP::HepRotation m_DisplacedGeoRotation

private

rotation of the displaced geometry transformation

Definition at line 383 of file Module.h.

m_DisplacedGeoRotationInverse

CLHEP::HepRotation m_DisplacedGeoRotationInverse

private

inverse of the rotation of displaced geometry transformation

Definition at line 392 of file Module.h.

m_DisplacedGeoTranslation

CLHEP::Hep3Vector m_DisplacedGeoTranslation

private

translation of the displaced geometry transformation

Definition at line 386 of file Module.h.

m_GlobalOrigin

CLHEP::Hep3Vector m_GlobalOrigin

private

to store the position (in global coordinates) of this module's sensitive-volume origin

Definition at line 353 of file Module.h.

m_HasRPCs

bool m_HasRPCs

private

flag to indicate whether this module contains RPCs (true) or scintillators (false)

Definition at line 317 of file Module.h.

m_IsFlipped

bool m_IsFlipped

private

flag to indicate if this module is flipped by 180 degrees about z axis within its air gap

Definition at line 320 of file Module.h.

m_LocalReconstructionShift

CLHEP::Hep3Vector m_LocalReconstructionShift

private

to store the local-coordinate real-vs-ideal translation of this module's sensitive volume

Definition at line 356 of file Module.h.

m_PhiPositionBase

double m_PhiPositionBase

private

to store the base position (in strip

1. units) along phi coordinate of the edge of first phi-measuring strip

Definition at line 332 of file Module.h.

m_PhiScintLengths

std::vector<double> m_PhiScintLengths

private

to store the length of each phi-measuring scintillator

Definition at line 395 of file Module.h.

m_PhiScintOffsets

std::vector<double> m_PhiScintOffsets

private

to store the longitudinal offset (within scintillator envelope) of each phi-measuring scintillator

Definition at line 401 of file Module.h.

m_PhiScintPositions

std::vector<double> m_PhiScintPositions

private

to store the transverse position (within scintillator envelope) of each phi-measuring scintillator

Definition at line 398 of file Module.h.

m_PhiSensorSide

int m_PhiSensorSide

private

to store the sensor side for phi scintillators

Definition at line 347 of file Module.h.

m_PhiStripMax

int m_PhiStripMax

private

to store the maximum phi strip number in this module

Definition at line 329 of file Module.h.

m_PhiStripMin

int m_PhiStripMin

private

to store the minimum phi strip number in this module

Definition at line 326 of file Module.h.

m_PhiStripWidth

double m_PhiStripWidth

private

to store the width (in cm) of each phi strip this module

Definition at line 323 of file Module.h.

m_Rotation

CLHEP::HepRotation m_Rotation

private

to store the rotation matrix (in global coordinates) of this module's sector

Definition at line 359 of file Module.h.

m_RotationInverse

CLHEP::HepRotation m_RotationInverse

private

to store the inverse of the rotation matrix (in global coordinates) of this module's sector

Definition at line 362 of file Module.h.

m_SignalSpeed

double m_SignalSpeed

private

to store the signal-propagation speed (cm/ns) along the strip

Definition at line 350 of file Module.h.

m_ZPositionBase

double m_ZPositionBase

private

to store the base position (in strip

1. units) along z coordinate of the edge of first z-measuring strip

Definition at line 344 of file Module.h.

m_ZScintLengths

std::vector<double> m_ZScintLengths

private

to store the length of each z-measuring scintillator

Definition at line 404 of file Module.h.

m_ZScintOffsets

std::vector<double> m_ZScintOffsets

private

to store the longitudinal offset (within scintillator envelope) of each z-measuring scintillator

Definition at line 410 of file Module.h.

m_ZScintPositions

std::vector<double> m_ZScintPositions

private

to store the transverse position (within scintillator envelope) of each z-measuring scintillator

Definition at line 407 of file Module.h.

m_ZStripMax

int m_ZStripMax

private

to store the maximum z strip number in this module

Definition at line 341 of file Module.h.

m_ZStripMin

int m_ZStripMin

private

to store the minimum z strip number in this module

Definition at line 338 of file Module.h.

m_ZStripWidth

double m_ZStripWidth

private

to store the width (in cm) of each z strip in this module

Definition at line 335 of file Module.h.

---

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

• klm/bklm/geometry/include/Module.h
• klm/bklm/geometry/src/Module.cc