Base class for the SCT module side design, extended by the Forward and Barrel module design. More...

#include <SCT_ModuleSideDesign.h>

Inheritance diagram for SCT_ModuleSideDesign:

Collaboration diagram for SCT_ModuleSideDesign:

Public Member Functions
	SCT_ModuleSideDesign (const double thickness, const bool phiSymmetric, const bool etaSymmetric, const bool depthSymmetric, const int crystals, const int diodes, const int cells, const int shift, const bool swapStripReadout, InDetDD::CarrierType carrierType, int readoutSide)
	Constructor with parameters: local axis corresponding to eta direction local axis corresponding to phi direction local axis corresponding to depth direction thickness of silicon sensor number of crystals within module side number of diodes within crystal number of cells within module side index of diode connected to cell with index 0.
	SCT_ModuleSideDesign (const double thickness, const bool phiSymmetric, const bool etaSymmetric, const bool depthSymmetric, const int crystals, const int diodes, const int cells, const int shift, const bool swapStripReadout, InDetDD::CarrierType carrierType, int readoutSide, const SiDetectorDesign::Axis stripDirection, const SiDetectorDesign::Axis thicknessDirection)
	Constructor with parameters with access to enum Axis: local axis corresponding to eta direction local axis corresponding to phi direction local axis corresponding to depth direction thickness of silicon sensor number of crystals within module side number of diodes within crystal number of cells within module side index of diode connected to cell with index 0.
virtual	~SCT_ModuleSideDesign ()=default
	Destructor:
virtual int	numberOfConnectedCells (const SiReadoutCellId &readoutId) const override
	readout id -> id of connected diodes Not particularly useful for the SCT but implemented to keep a uniform interface.
virtual SiCellId	connectedCell (const SiReadoutCellId &readoutId, int number) const override
	readout id -> id of connected diodes.
virtual SiCellId	gangedCell (const SiCellId &cellId) const override
	If cell is ganged return the other cell, otherwise return an invalid id.
virtual SiReadoutCellId	readoutIdOfCell (const SiCellId &cellId) const override
	diode id -> readout id
virtual SiReadoutCellId	readoutIdOfPosition (const SiLocalPosition &localPos) const override
	position -> id
virtual SiLocalPosition	localPositionOfCell (const SiCellId &cellId) const override=0
	id -> position
virtual SiLocalPosition	localPositionOfCluster (const SiCellId &cellId, int cluserSize) const=0
virtual SiCellId	cellIdInRange (const SiCellId &cellId) const override
	Check if cell is in range.
virtual void	neighboursOfCell (const SiCellId &cellId, std::vector< SiCellId > &neighbours) const override
	Get the neighbouring diodes of a given diode: Cell for which the neighbours must be found List of cells which are neighbours of the given one.
virtual bool	inActiveArea (const SiLocalPosition &chargePos, bool checkBondGap=true) const=0
	check if the position is in active area
virtual double	scaledDistanceToNearestDiode (const SiLocalPosition &chargePos) const=0
	give distance to the nearest diode in units of pitch, from 0.0 to 0.5, this method should be fast as it is called for every surface charge in the SCT_SurfaceChargesGenerator
virtual double	stripPitch (const SiLocalPosition &chargePos) const=0
	give the strip pitch (dependence on position needed for forward)
virtual double	stripPitch () const=0
	give the strip pitch (For Forward returns pitch at center)
virtual std::pair< SiLocalPosition, SiLocalPosition >	endsOfStrip (const SiLocalPosition &position) const override=0
	give the ends of strips
virtual SiLocalPosition	positionFromStrip (const int stripNumber) const
	gives position of strip center ALTERNATIVE/PREFERED way is to use localPositionOfCell(const SiCellId & cellId) or rawLocalPositionOfCell method in SiDetectorElement.
virtual double	deadAreaLength () const=0
	give length of dead area
virtual double	deadAreaUpperBoundary () const=0
	give upper boundary of dead area
virtual double	deadAreaLowerBoundary () const=0
	give lower boundary of dead area
int	crystals () const
	number of crystals within module side:
int	diodes () const
	number of strips within crystal:
virtual int	diodesInRow (const int row) const
int	cells () const
	number of readout stips within module side:
int	shift () const
	number of edge strips before first readout strip.
virtual bool	swapHitPhiReadoutDirection () const override
	Return true if hit local direction is the same as readout direction.
virtual bool	swapHitEtaReadoutDirection () const override
virtual int	row (int stripId1Dim) const
virtual int	strip (int stripId1Dim) const
virtual int	strip1Dim (int strip, int row) const override
	only relevant for SCT.
void	setMother (SCT_ModuleSideDesign *mother)
const SCT_ModuleSideDesign *	getMother () const
const std::map< int, const SCT_ModuleSideDesign * > &	getChildren () const
void	addChildDesign (int index, const SCT_ModuleSideDesign *element)
virtual std::pair< int, int >	getStripRow (SiCellId id) const
	Get the strip and row number of the cell.
virtual SiIntersect	inDetector (const SiLocalPosition &localPosition, double phiTol, double etaTol) const override
	Test if point is in the active part of the detector with specified tolerances.

Protected Attributes
SCT_ReadoutScheme	m_scheme
InDetDD::DetectorType	m_detectorType {Undefined}

Private Member Functions
	SCT_ModuleSideDesign ()
	SCT_ModuleSideDesign (const SCT_ModuleSideDesign &design)
SCT_ModuleSideDesign &	operator= (const SCT_ModuleSideDesign &design)

Private Attributes
bool	m_swapStripReadout
const SCT_ModuleSideDesign *	m_motherDesign {nullptr}
std::map< int, const SCT_ModuleSideDesign * >	m_childDesigns

Detailed Description

Base class for the SCT module side design, extended by the Forward and Barrel module design.

Author: Alessandro Fornaini, Grant Gorfine

Definition at line 40 of file SCT_ModuleSideDesign.h.

Constructor & Destructor Documentation

◆ SCT_ModuleSideDesign() [1/4]

InDetDD::SCT_ModuleSideDesign::SCT_ModuleSideDesign	(	const double	thickness,
		const bool	phiSymmetric,
		const bool	etaSymmetric,
		const bool	depthSymmetric,
		const int	crystals,
		const int	diodes,
		const int	cells,
		const int	shift,
		const bool	swapStripReadout,
		InDetDD::CarrierType	carrierType,
		int	readoutSide )

Constructor with parameters: local axis corresponding to eta direction local axis corresponding to phi direction local axis corresponding to depth direction thickness of silicon sensor number of crystals within module side number of diodes within crystal number of cells within module side index of diode connected to cell with index 0.

Definition at line 33 of file SCT_ModuleSideDesign.cxx.

                                                           :
    SiDetectorDesign(thickness, phiSymmetric, etaSymmetric, depthSymmetric, carrierType, readoutSide),
    m_scheme(crystals, diodes, cells, shift),
    m_swapStripReadout(swapStripReadout) {
}

◆ SCT_ModuleSideDesign() [2/4]

InDetDD::SCT_ModuleSideDesign::SCT_ModuleSideDesign	(	const double	thickness,
		const bool	phiSymmetric,
		const bool	etaSymmetric,
		const bool	depthSymmetric,
		const int	crystals,
		const int	diodes,
		const int	cells,
		const int	shift,
		const bool	swapStripReadout,
		InDetDD::CarrierType	carrierType,
		int	readoutSide,
		const SiDetectorDesign::Axis	stripDirection,
		const SiDetectorDesign::Axis	thicknessDirection )

Constructor with parameters with access to enum Axis: local axis corresponding to eta direction local axis corresponding to phi direction local axis corresponding to depth direction thickness of silicon sensor number of crystals within module side number of diodes within crystal number of cells within module side index of diode connected to cell with index 0.

Definition at line 49 of file SCT_ModuleSideDesign.cxx.

    :
    SiDetectorDesign(thickness, phiSymmetric, etaSymmetric, depthSymmetric, carrierType, readoutSide,
                     stripDirection, thicknessDirection),
    m_scheme(crystals, diodes, cells, shift),
    m_swapStripReadout(swapStripReadout) {
}

◆ SCT_ModuleSideDesign() [3/4]

InDetDD::SCT_ModuleSideDesign::SCT_ModuleSideDesign ( )

private

◆ SCT_ModuleSideDesign() [4/4]

InDetDD::SCT_ModuleSideDesign::SCT_ModuleSideDesign ( const SCT_ModuleSideDesign & design )

private

◆ ~SCT_ModuleSideDesign()

virtual InDetDD::SCT_ModuleSideDesign::~SCT_ModuleSideDesign ( )

virtualdefault

Destructor:

Member Function Documentation

◆ addChildDesign()

void InDetDD::SCT_ModuleSideDesign::addChildDesign	(	int	index,
		const SCT_ModuleSideDesign *	element )

inline

Definition at line 292 of file SCT_ModuleSideDesign.h.

                                                                                               {
   m_childDesigns.emplace(index,child);
 }

◆ cellIdInRange()

SiCellId InDetDD::SCT_ModuleSideDesign::cellIdInRange ( const SiCellId & cellId ) const

overridevirtual

Check if cell is in range.

Check if cell is in range. Returns the original cellId if it is in range, otherwise it.

Returns the original cellId if it is in range, otherwise it returns an invalid id.

Implements InDetDD::DetectorDesign.

Definition at line 101 of file SCT_ModuleSideDesign.cxx.

                                                                         {
    if (!cellId.isValid() ||
        cellId.strip() < 0 || cellId.strip() >= cells()) {
        return {}; // Invalid
    }
    return cellId;
}

◆ cells()

int InDetDD::SCT_ModuleSideDesign::cells ( ) const

inline

number of readout stips within module side:

Definition at line 228 of file SCT_ModuleSideDesign.h.

                                             {
    return m_scheme.cells();
}

◆ connectedCell()

SiCellId InDetDD::SCT_ModuleSideDesign::connectedCell	(	const SiReadoutCellId &	readoutId,
		int	number ) const

inlineoverridevirtual

readout id -> id of connected diodes.

parameter number = 0 will refer to the primary diode and in general the cell number will be the same. NB. SiCellId cellId = connectedCell(readoutId, 0) will in general be equivalent to SiCellId cellId = readoutId

Implements InDetDD::DetectorDesign.

Definition at line 241 of file SCT_ModuleSideDesign.h.

                                                                      {
    return m_scheme.connectedCell(readoutId, number);
}

◆ crystals()

int InDetDD::SCT_ModuleSideDesign::crystals ( ) const

inline

number of crystals within module side:

Definition at line 216 of file SCT_ModuleSideDesign.h.

                                                {
    return m_scheme.crystals();
}

◆ deadAreaLength()

virtual double InDetDD::SCT_ModuleSideDesign::deadAreaLength ( ) const

pure virtual

give length of dead area

◆ deadAreaLowerBoundary()

virtual double InDetDD::SCT_ModuleSideDesign::deadAreaLowerBoundary ( ) const

pure virtual

give lower boundary of dead area

◆ deadAreaUpperBoundary()

virtual double InDetDD::SCT_ModuleSideDesign::deadAreaUpperBoundary ( ) const

pure virtual

give upper boundary of dead area

◆ diodes()

int InDetDD::SCT_ModuleSideDesign::diodes ( ) const

inline

number of strips within crystal:

Definition at line 220 of file SCT_ModuleSideDesign.h.

                                              {
    return m_scheme.diodes();
}

◆ diodesInRow()

int InDetDD::SCT_ModuleSideDesign::diodesInRow ( const int row ) const

inlinevirtual

Definition at line 224 of file SCT_ModuleSideDesign.h.

                                                              {
    return m_scheme.diodes();
}

◆ endsOfStrip()

virtual std::pair< SiLocalPosition, SiLocalPosition > InDetDD::SCT_ModuleSideDesign::endsOfStrip ( const SiLocalPosition & position ) const

overridepure virtual

give the ends of strips

Implements InDetDD::SiDetectorDesign.

◆ gangedCell()

SiCellId InDetDD::SCT_ModuleSideDesign::gangedCell ( const SiCellId & cellId ) const

inlineoverridevirtual

If cell is ganged return the other cell, otherwise return an invalid id.

Not particularly useful for the SCT but implemented to keep a uniform interface. For SCT always returns an invalid id.

Implements InDetDD::SiDetectorDesign.

Definition at line 246 of file SCT_ModuleSideDesign.h.

                                                                       {
    // No ganged cells in SCT so always return invalid id.
    return SiCellId();
}

◆ getChildren()

const std::map< int, const SCT_ModuleSideDesign * > & InDetDD::SCT_ModuleSideDesign::getChildren ( ) const

inline

Definition at line 287 of file SCT_ModuleSideDesign.h.

                                                                                                 {
   return m_childDesigns;
 }

◆ getMother()

const SCT_ModuleSideDesign * InDetDD::SCT_ModuleSideDesign::getMother ( ) const

inline

Definition at line 283 of file SCT_ModuleSideDesign.h.

                                                                           {
   return m_motherDesign;
 }

◆ getStripRow()

std::pair< int, int > InDetDD::SCT_ModuleSideDesign::getStripRow ( SiCellId id ) const

virtual

Get the strip and row number of the cell.

Can be used as auto [strip, row] = getStripRow(cellId); For SCT sensors, return 0 as there should only be one row; derived versions for ITk strip implement specializations

Parameters

cellId The SiCellId

Returns: std::pair<int,int> A pair of ints representing the strip ID and row ID. In this case, [0,0].

Definition at line 127 of file SCT_ModuleSideDesign.cxx.

                                                                   {
   return {0,0};
 }

◆ inActiveArea()

virtual bool InDetDD::SCT_ModuleSideDesign::inActiveArea	(	const SiLocalPosition &	chargePos,
		bool	checkBondGap = true ) const

pure virtual

check if the position is in active area

◆ inDetector()

SiIntersect InDetDD::SCT_ModuleSideDesign::inDetector	(	const SiLocalPosition &	localPosition,
		double	phiTol,
		double	etaTol ) const

overridevirtual

Test if point is in the active part of the detector with specified tolerances.

Reimplemented from InDetDD::DetectorDesign.

Definition at line 131 of file SCT_ModuleSideDesign.cxx.

                                                                                                                       {
 
    double etaDist = 0;
    double phiDist = 0;
 
    distanceToDetectorEdge(localPosition, etaDist, phiDist);
 
    SiIntersect state;
 
    if (phiDist < -phiTol || etaDist < -etaTol) {
        state.setOut();
        return state;
    }
 
    if (phiDist > phiTol && etaDist > etaTol) {
        state.setIn();
        return state;
    }
 
    // Near boundary.
    state.setNearBoundary();
    return state;
}

◆ localPositionOfCell()

virtual SiLocalPosition InDetDD::SCT_ModuleSideDesign::localPositionOfCell ( const SiCellId & cellId ) const

overridepure virtual

id -> position

◆ localPositionOfCluster()

virtual SiLocalPosition InDetDD::SCT_ModuleSideDesign::localPositionOfCluster	(	const SiCellId &	cellId,
		int	cluserSize ) const

pure virtual

◆ neighboursOfCell()

void InDetDD::SCT_ModuleSideDesign::neighboursOfCell	(	const SiCellId &	cellId,
		std::vector< SiCellId > &	neighbours ) const

overridevirtual

Get the neighbouring diodes of a given diode: Cell for which the neighbours must be found List of cells which are neighbours of the given one.

Implements InDetDD::DetectorDesign.

Definition at line 70 of file SCT_ModuleSideDesign.cxx.

                                                                                   {
    neighbours.clear();
    neighbours.reserve(2);
 
    if (!cellId.isValid()) {
        return;
    }
 
    int strip = cellId.strip();
    int stripM = strip - 1;
    int stripP = strip + 1;
 
    if (stripM >= m_scheme.shift()) {
        neighbours.emplace_back(stripM);
    }
    if (stripP < m_scheme.diodes() + m_scheme.shift()) {
        neighbours.emplace_back(stripP);
    }
}

◆ numberOfConnectedCells()

int InDetDD::SCT_ModuleSideDesign::numberOfConnectedCells ( const SiReadoutCellId & readoutId ) const

inlineoverridevirtual

readout id -> id of connected diodes Not particularly useful for the SCT but implemented to keep a uniform interface.

Implements InDetDD::DetectorDesign.

Definition at line 236 of file SCT_ModuleSideDesign.h.

      {
    return m_scheme.numberOfConnectedCells(readoutId);
}

◆ operator=()

SCT_ModuleSideDesign & InDetDD::SCT_ModuleSideDesign::operator= ( const SCT_ModuleSideDesign & design )

private

◆ positionFromStrip()

SiLocalPosition InDetDD::SCT_ModuleSideDesign::positionFromStrip ( const int stripNumber ) const

virtual

gives position of strip center ALTERNATIVE/PREFERED way is to use localPositionOfCell(const SiCellId & cellId) or rawLocalPositionOfCell method in SiDetectorElement.

DEPRECATED

Definition at line 95 of file SCT_ModuleSideDesign.cxx.

                                                                                   {
    return localPositionOfCell(SiCellId(stripNumber));
}

◆ readoutIdOfCell()

SiReadoutCellId InDetDD::SCT_ModuleSideDesign::readoutIdOfCell ( const SiCellId & cellId ) const

inlineoverridevirtual

diode id -> readout id

Implements InDetDD::DetectorDesign.

Definition at line 251 of file SCT_ModuleSideDesign.h.

{
    return m_scheme.readoutIdOfCell(cellId);
}

◆ readoutIdOfPosition()

SiReadoutCellId InDetDD::SCT_ModuleSideDesign::readoutIdOfPosition ( const SiLocalPosition & localPos ) const

inlineoverridevirtual

position -> id

Implements InDetDD::DetectorDesign.

Definition at line 256 of file SCT_ModuleSideDesign.h.

                                           {
    // Get the cellId then convert it to a readoutId.
    // NEED to think about active area and bond gap check
    return readoutIdOfCell(cellIdOfPosition(localPos));
}

◆ row()

int InDetDD::SCT_ModuleSideDesign::row ( int stripId1Dim ) const

inlinevirtual

Definition at line 271 of file SCT_ModuleSideDesign.h.

                                                {
    return -1; // Use -1 to realise this is an SCT module without rows
}

◆ scaledDistanceToNearestDiode()

virtual double InDetDD::SCT_ModuleSideDesign::scaledDistanceToNearestDiode ( const SiLocalPosition & chargePos ) const

pure virtual

give distance to the nearest diode in units of pitch, from 0.0 to 0.5, this method should be fast as it is called for every surface charge in the SCT_SurfaceChargesGenerator

◆ setMother()

void InDetDD::SCT_ModuleSideDesign::setMother ( SCT_ModuleSideDesign * mother )

Definition at line 109 of file SCT_ModuleSideDesign.cxx.

                                                                   {
    if(m_motherDesign){
      const std::string errMsg=std::string("SCT_ModuleSideDesign already has a mother set!");
    throw std::runtime_error(errMsg);
    } 
    m_motherDesign = mother;
 
  }

◆ shift()

int InDetDD::SCT_ModuleSideDesign::shift ( ) const

inline

number of edge strips before first readout strip.

Definition at line 232 of file SCT_ModuleSideDesign.h.

                                             {
    return m_scheme.shift();
}

◆ strip()

int InDetDD::SCT_ModuleSideDesign::strip ( int stripId1Dim ) const

inlinevirtual

Definition at line 275 of file SCT_ModuleSideDesign.h.

                                                            {
    return stripId1Dim;
}

◆ strip1Dim()

int InDetDD::SCT_ModuleSideDesign::strip1Dim	(	int	strip,
		int	row ) const

inlineoverridevirtual

only relevant for SCT.

Return strip1Dim(int strip, int row) if SCT; otherwise -1

Reimplemented from InDetDD::SiDetectorDesign.

Definition at line 279 of file SCT_ModuleSideDesign.h.

                                                                 {
    return strip;
}

◆ stripPitch() [1/2]

virtual double InDetDD::SCT_ModuleSideDesign::stripPitch ( ) const

pure virtual

give the strip pitch (For Forward returns pitch at center)

◆ stripPitch() [2/2]

virtual double InDetDD::SCT_ModuleSideDesign::stripPitch ( const SiLocalPosition & chargePos ) const

pure virtual

give the strip pitch (dependence on position needed for forward)

◆ swapHitEtaReadoutDirection()

bool InDetDD::SCT_ModuleSideDesign::swapHitEtaReadoutDirection ( ) const

inlineoverridevirtual

Implements InDetDD::DetectorDesign.

Definition at line 267 of file SCT_ModuleSideDesign.h.

                                                                   {
    return false;
}

◆ swapHitPhiReadoutDirection()

bool InDetDD::SCT_ModuleSideDesign::swapHitPhiReadoutDirection ( ) const

inlineoverridevirtual

Return true if hit local direction is the same as readout direction.

Implements InDetDD::DetectorDesign.

Definition at line 263 of file SCT_ModuleSideDesign.h.

                                                                   {
    return m_swapStripReadout;
}

Member Data Documentation

◆ m_childDesigns

std::map<int, const SCT_ModuleSideDesign *> InDetDD::SCT_ModuleSideDesign::m_childDesigns

private

Definition at line 210 of file SCT_ModuleSideDesign.h.

◆ m_detectorType

InDetDD::DetectorType InDetDD::SCT_ModuleSideDesign::m_detectorType {Undefined}

protected

Definition at line 197 of file SCT_ModuleSideDesign.h.

197{Undefined};

Undefined

@ Undefined

Definition MaterialTypes.h:8

◆ m_motherDesign

const SCT_ModuleSideDesign* InDetDD::SCT_ModuleSideDesign::m_motherDesign {nullptr}

private

Definition at line 208 of file SCT_ModuleSideDesign.h.

208{nullptr};

◆ m_scheme

SCT_ReadoutScheme InDetDD::SCT_ModuleSideDesign::m_scheme

protected

Definition at line 196 of file SCT_ModuleSideDesign.h.

◆ m_swapStripReadout

bool InDetDD::SCT_ModuleSideDesign::m_swapStripReadout

private

Definition at line 204 of file SCT_ModuleSideDesign.h.

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCT_ModuleSideDesign() [1/4]

◆ SCT_ModuleSideDesign() [2/4]

◆ SCT_ModuleSideDesign() [3/4]

◆ SCT_ModuleSideDesign() [4/4]

◆ ~SCT_ModuleSideDesign()

Member Function Documentation

◆ addChildDesign()

◆ cellIdInRange()

◆ cells()

◆ connectedCell()

◆ crystals()

◆ deadAreaLength()

◆ deadAreaLowerBoundary()

◆ deadAreaUpperBoundary()

◆ diodes()

◆ diodesInRow()

◆ endsOfStrip()

◆ gangedCell()

◆ getChildren()

◆ getMother()

◆ getStripRow()

◆ inActiveArea()

◆ inDetector()

◆ localPositionOfCell()

◆ localPositionOfCluster()

◆ neighboursOfCell()

◆ numberOfConnectedCells()

◆ operator=()

◆ positionFromStrip()

◆ readoutIdOfCell()

◆ readoutIdOfPosition()

◆ row()

◆ scaledDistanceToNearestDiode()

◆ setMother()

◆ shift()

◆ strip()

◆ strip1Dim()

◆ stripPitch() [1/2]

◆ stripPitch() [2/2]

◆ swapHitEtaReadoutDirection()

◆ swapHitPhiReadoutDirection()

Member Data Documentation

◆ m_childDesigns

◆ m_detectorType

◆ m_motherDesign

◆ m_scheme

◆ m_swapStripReadout