Helper class to convert between offline column, row and hardware chip, column, row coordinates. More...

#include <PixelModuleHelper.h>

Collaboration diagram for InDet::PixelModuleHelper:

Public Member Functions
	PixelModuleHelper (const InDetDD::SiDetectorDesign &design)

	operator bool () const

unsigned int	columns () const

unsigned int	rows () const

unsigned int	columnsPerCircuit () const

unsigned int	rowsPerCircuit () const

unsigned int	circuitsPerColumn () const

unsigned int	circuitsPerRow () const

bool	swapOfflineRowsColumns () const

unsigned int	hardwareCoordinates (unsigned int row, unsigned int column) const
	compute "hardware" coordinates from offline coordinates. More...

unsigned int	columnGroupDefect (unsigned int row, unsigned int column) const
	Create a "column group" defect for the given offline coordinates. More...

unsigned int	nPixels () const

unsigned int	nColumns () const

unsigned int	nRows () const

std::array< unsigned int, 4 >	offlineRange (unsigned int key) const
	Convenience function to return oflline column and row ranges matching the defect-area of the given key. More...

Static Public Member Functions
static constexpr unsigned int	getChip (unsigned int hardware_coordinates)

static constexpr unsigned int	getRow (unsigned int hardware_coordinates)

static constexpr unsigned int	getColumn (unsigned int hardware_coordinates)

static constexpr bool	isColumnGroupDefect (unsigned int key)
	Test whether the column group flag is set in the packed hardware coordinate tripplet. More...

static constexpr bool	inSameColumnGroup (unsigned int key_ref, unsigned int key_test)
	Test whether the two packed hardware coorindates refer to the same column group. More...

constexpr static bool	isSameDefect (unsigned int key_ref, unsigned int key_test)
	Test whether the given packed hardware coordinates refer to the same pixel. More...

constexpr static bool	isSameDefectWithGroups (unsigned int key_ref, unsigned int key_test)
	Convenience function to test whether the given packed hardware coordinates refer to overlapping defects. More...

Static Public Attributes
static constexpr unsigned int	COLGROUP_DEFECT_BIT_MASK = (1u<<31)

static constexpr unsigned int	CHIP_MASK = MaskUtils::createMask<24,28>()

static constexpr unsigned int	COL_MASK = MaskUtils::createMask<12,24>()

static constexpr unsigned int	ROW_MASK = MaskUtils::createMask<0,12>()

static constexpr unsigned int	CHIP_SHIFT = 24

static constexpr unsigned int	COL_SHIFT = 12

static constexpr unsigned int	ROW_SHIFT = 0

static constexpr unsigned int	N_COLS_PER_GROUP = 8

static constexpr unsigned int	COL_MASK_FOR_GROUP = MaskUtils::createMask<12,3+12>()

Private Attributes
const InDetDD::PixelModuleDesign *	m_pixelModuleDesign =nullptr

unsigned short	m_rows = 0

unsigned short	m_columns = 0

unsigned short	m_rowsPerCircuit = 0

unsigned short	m_columnsPerCircuit = 0

unsigned char	m_circuitsPerRow = 0

unsigned char	m_circuitsPerColumn = 0

bool	m_swapOfflineRowsColumns =false

Detailed Description

Helper class to convert between offline column, row and hardware chip, column, row coordinates.

Definition at line 33 of file PixelModuleHelper.h.

Constructor & Destructor Documentation

◆ PixelModuleHelper()

InDet::PixelModuleHelper::PixelModuleHelper ( const InDetDD::SiDetectorDesign & design )

inline

Definition at line 50 of file PixelModuleHelper.h.

          : m_pixelModuleDesign( dynamic_cast<const InDetDD::PixelModuleDesign *>(&design))
       {
          if (m_pixelModuleDesign->rowsPerCircuit()==400 /* @TODO find a better way to identify when to swap columns and rows*/ ) {
             // the front-ends of ITk ring triplet modules are rotated differently
             // wrt. the offline coordinate system compared to quads and
             // barrel triplets. Once these modules are identified, the translation
             // works in exactly the same way, but columns and rows need to be swapped,
             m_swapOfflineRowsColumns=true;
             m_columns = m_pixelModuleDesign->rows();
             m_rows = m_pixelModuleDesign->columns();
             m_columnsPerCircuit = m_pixelModuleDesign->rowsPerCircuit();
             m_rowsPerCircuit = m_pixelModuleDesign->columnsPerCircuit();
             m_circuitsPerColumn = m_pixelModuleDesign->numberOfCircuitsPerRow();
             m_circuitsPerRow = m_pixelModuleDesign->numberOfCircuitsPerColumn();
          }
          else {
             m_swapOfflineRowsColumns=false;
             m_rows = m_pixelModuleDesign->rows();
             m_columns = m_pixelModuleDesign->columns();
             m_rowsPerCircuit = m_pixelModuleDesign->rowsPerCircuit();
             m_columnsPerCircuit = m_pixelModuleDesign->columnsPerCircuit();
             m_circuitsPerRow = m_pixelModuleDesign->numberOfCircuitsPerRow();
             m_circuitsPerColumn = m_pixelModuleDesign->numberOfCircuitsPerColumn();
          }
  
       }

Member Function Documentation

◆ circuitsPerColumn()

unsigned int InDet::PixelModuleHelper::circuitsPerColumn ( ) const

inline

Definition at line 83 of file PixelModuleHelper.h.

83 { return m_circuitsPerColumn; }

◆ circuitsPerRow()

unsigned int InDet::PixelModuleHelper::circuitsPerRow ( ) const

inline

Definition at line 84 of file PixelModuleHelper.h.

84 { return m_circuitsPerRow; }

◆ columnGroupDefect()

unsigned int InDet::PixelModuleHelper::columnGroupDefect	(	unsigned int	row,
		unsigned int	column
	)		const

inline

Create a "column group" defect for the given offline coordinates.

Parameters

row	offline row aka. phi index of a pixel of the column group
column	offline column aka. eta index of a pixel of the column group

Returns: packed triplet chip, column, row of the first pixel in the column group and column group flag set Creates packed hardware coordinates for column group aka. ITk pixel core column which is the coordinate of the first pixel of that group and sets the column group flag.

Definition at line 127 of file PixelModuleHelper.h.

                                                                                   {
          return (hardwareCoordinates(row,column) & ((~COL_MASK_FOR_GROUP) & (~ROW_MASK))) | COLGROUP_DEFECT_BIT_MASK;
       }

◆ columns()

unsigned int InDet::PixelModuleHelper::columns ( ) const

inline

Definition at line 79 of file PixelModuleHelper.h.

79 { return m_columns; }

◆ columnsPerCircuit()

unsigned int InDet::PixelModuleHelper::columnsPerCircuit ( ) const

inline

Definition at line 81 of file PixelModuleHelper.h.

81 { return m_columnsPerCircuit; }

◆ getChip()

static constexpr unsigned int InDet::PixelModuleHelper::getChip ( unsigned int hardware_coordinates )

inlinestaticconstexpr

Definition at line 140 of file PixelModuleHelper.h.

                                                                                {
          return (hardware_coordinates & CHIP_MASK) >> CHIP_SHIFT;
       }

◆ getColumn()

static constexpr unsigned int InDet::PixelModuleHelper::getColumn ( unsigned int hardware_coordinates )

inlinestaticconstexpr

Definition at line 146 of file PixelModuleHelper.h.

                                                                                  {
          return (hardware_coordinates & COL_MASK) >> COL_SHIFT;
       }

◆ getRow()

static constexpr unsigned int InDet::PixelModuleHelper::getRow ( unsigned int hardware_coordinates )

inlinestaticconstexpr

Definition at line 143 of file PixelModuleHelper.h.

                                                                               {
          return (hardware_coordinates & ROW_MASK) >> ROW_SHIFT;
       }

◆ hardwareCoordinates()

unsigned int InDet::PixelModuleHelper::hardwareCoordinates	(	unsigned int	row,
		unsigned int	column
	)		const

inline

compute "hardware" coordinates from offline coordinates.

Parameters

row	offline row aka. phi index
column	offline column aka. eta index

Returns: packed triplet of chip, column, row.

Definition at line 92 of file PixelModuleHelper.h.

                                                                                     {
          unsigned int chip =0;
          if (swapOfflineRowsColumns()) {
             unsigned int tmp=row;
             row=column;
             column=tmp;
          }
          if (circuitsPerColumn()>1) {
             assert( circuitsPerColumn() == 2);
             chip += (row/rowsPerCircuit()) * circuitsPerRow();
             row = row % rowsPerCircuit();
             if (chip>0) {
                row = rowsPerCircuit() - row -1;
                column = columns() - column -1;
             }
          }
          if (circuitsPerRow()>1) {
             chip += column/columnsPerCircuit();
             column = column%columnsPerCircuit();
          }
          assert( (chip   & (CHIP_MASK >> CHIP_SHIFT)) == chip);
          assert( (column & (COL_MASK  >> COL_SHIFT))  == column);
          assert( (row    & (ROW_MASK  >> ROW_SHIFT))  == row);
  
          return (chip << CHIP_SHIFT)  | (column << COL_SHIFT) | (row << ROW_SHIFT);
       }

◆ inSameColumnGroup()

static constexpr bool InDet::PixelModuleHelper::inSameColumnGroup	(	unsigned int	key_ref,
		unsigned int	key_test
	)

inlinestaticconstexpr

Test whether the two packed hardware coorindates refer to the same column group.

Definition at line 158 of file PixelModuleHelper.h.

                                                                                            {
          constexpr unsigned int mask_out_rows_and_cols_per_group = (CHIP_MASK|(COL_MASK & (~COL_MASK_FOR_GROUP)));
          return     (key_ref  & mask_out_rows_and_cols_per_group)
             ==  (key_test & mask_out_rows_and_cols_per_group);
       }

◆ isColumnGroupDefect()

static constexpr bool InDet::PixelModuleHelper::isColumnGroupDefect ( unsigned int key )

inlinestaticconstexpr

Test whether the column group flag is set in the packed hardware coordinate tripplet.

Definition at line 152 of file PixelModuleHelper.h.

                                                                   {
          return key & COLGROUP_DEFECT_BIT_MASK;
       }

◆ isSameDefect()

constexpr static bool InDet::PixelModuleHelper::isSameDefect	(	unsigned int	key_ref,
		unsigned int	key_test
	)

inlinestaticconstexpr

Test whether the given packed hardware coordinates refer to the same pixel.

Definition at line 166 of file PixelModuleHelper.h.

                                                                                        {
          return (key_ref & (CHIP_MASK | ROW_MASK | COL_MASK)) == key_test;
       }

◆ isSameDefectWithGroups()

constexpr static bool InDet::PixelModuleHelper::isSameDefectWithGroups	(	unsigned int	key_ref,
		unsigned int	key_test
	)

inlinestaticconstexpr

Convenience function to test whether the given packed hardware coordinates refer to overlapping defects.

Parameters

key_ref	packed hardware coordinates referring either to a single pixel defect or a column group defect
key_test	packed hardware coordinates referring to a single pixel defect

Returns: true if the defects overlap If key_ref refers to a single pixel defect and key_test refers to a column group defect the defects are only considered as overlapping if the pixel addressed by the two coordinates are identical, not if key_ref only is contained in the column group addressed by key_test. If key_ref and key test both could address exclusively a column group defect use : <verb> isSameDefect(key_ref, key_test) || ( (isColumnGroupDefect(key_ref)|| isColumnGroupDefect(key_test)) && inSameColumnGroup(key_ref, key_test)); </verb> instead.

Definition at line 184 of file PixelModuleHelper.h.

                                                                                                  {
          return isSameDefect(key_ref, key_test) || (isColumnGroupDefect(key_ref) && inSameColumnGroup(key_ref, key_test));
       }

◆ nColumns()

unsigned int InDet::PixelModuleHelper::nColumns ( ) const

inline

Definition at line 134 of file PixelModuleHelper.h.

                                     {
          return m_pixelModuleDesign->columns();
       }

◆ nPixels()

unsigned int InDet::PixelModuleHelper::nPixels ( ) const

inline

Definition at line 131 of file PixelModuleHelper.h.

                                    {
          return m_pixelModuleDesign->columns() * m_pixelModuleDesign->rows();
       }

◆ nRows()

unsigned int InDet::PixelModuleHelper::nRows ( ) const

inline

Definition at line 137 of file PixelModuleHelper.h.

                                  {
          return m_pixelModuleDesign->rows();
       }

◆ offlineRange()

std::array<unsigned int,4> InDet::PixelModuleHelper::offlineRange ( unsigned int key ) const

inline

Convenience function to return oflline column and row ranges matching the defect-area of the given key.

Parameters

key	packed hardware coordinates addressing a single pixel or a column group defect

Returns: offline start column, end column, start row, end row, where the end is meant not to be inclusive i.e. [start, end)

Definition at line 192 of file PixelModuleHelper.h.

                                                                     {
          if (isColumnGroupDefect(key)) {
             if (getRow(key) !=0) {
                throw std::runtime_error("invalid key");
             };
  
             unsigned int chip=getChip(key);
             unsigned int row=getRow(key);
             unsigned int row_end=row + rowsPerCircuit()-1;
             unsigned int column=getColumn(key);
             unsigned int column_end= column + N_COLS_PER_GROUP-1;
  
             unsigned int chip_row = chip / circuitsPerRow();
             unsigned int chip_column = chip % circuitsPerRow();
  
             column += chip_column * columnsPerCircuit();
             column_end += chip_column * columnsPerCircuit();
             if (chip_row>=1) {
                column = columns() - column -1;
                column_end = columns() - column_end -1;
  
                row = rowsPerCircuit() - row -1 + chip_row * rowsPerCircuit();
                row_end = rowsPerCircuit() - row_end -1 + chip_row * rowsPerCircuit();
             }
             if (swapOfflineRowsColumns()) {
                return std::array<unsigned int,4>{ std::min(column, column_end), std::max(column,column_end)+1,
                                                   std::min(row, row_end),       std::max(row, row_end)+1 };
             }
             else {
                return std::array<unsigned int,4>{ std::min(row, row_end),       std::max(row, row_end)+1,
                                                   std::min(column, column_end), std::max(column,column_end)+1 };
             }
          }
          else {
             unsigned int chip=getChip(key);
             unsigned int row=getRow(key);
             unsigned int column=getColumn(key);
  
             unsigned int chip_row = chip / circuitsPerRow();
             unsigned int chip_column = chip % circuitsPerRow();
  
             column += chip_column * columnsPerCircuit();
             if (chip_row>=1) {
                column = columns() - column -1;
  
                row = rowsPerCircuit() - row -1 + chip_row * rowsPerCircuit();
             }
             if (swapOfflineRowsColumns()) {
                return std::array<unsigned int,4 >{ column, column + 1,
                                                    row, row +1 };
             }
             else {
                return std::array<unsigned int,4>{ row, row + 1,
                                                   column, column +1 };
             }
          }
       }

◆ operator bool()

InDet::PixelModuleHelper::operator bool ( ) const

inline

Definition at line 77 of file PixelModuleHelper.h.

77 { return m_pixelModuleDesign != nullptr; }

◆ rows()

unsigned int InDet::PixelModuleHelper::rows ( ) const

inline

Definition at line 80 of file PixelModuleHelper.h.

80 { return m_rows; }

◆ rowsPerCircuit()

unsigned int InDet::PixelModuleHelper::rowsPerCircuit ( ) const

inline

Definition at line 82 of file PixelModuleHelper.h.

82 { return m_rowsPerCircuit; }

◆ swapOfflineRowsColumns()

bool InDet::PixelModuleHelper::swapOfflineRowsColumns ( ) const

inline

Definition at line 85 of file PixelModuleHelper.h.

85 { return m_swapOfflineRowsColumns; }

Member Data Documentation

◆ CHIP_MASK

constexpr unsigned int InDet::PixelModuleHelper::CHIP_MASK = MaskUtils::createMask<24,28>()

staticconstexpr

Definition at line 40 of file PixelModuleHelper.h.

◆ CHIP_SHIFT

constexpr unsigned int InDet::PixelModuleHelper::CHIP_SHIFT = 24

staticconstexpr

Definition at line 43 of file PixelModuleHelper.h.

◆ COL_MASK

constexpr unsigned int InDet::PixelModuleHelper::COL_MASK = MaskUtils::createMask<12,24>()

staticconstexpr

Definition at line 41 of file PixelModuleHelper.h.

◆ COL_MASK_FOR_GROUP

constexpr unsigned int InDet::PixelModuleHelper::COL_MASK_FOR_GROUP = MaskUtils::createMask<12,3+12>()

staticconstexpr

Definition at line 48 of file PixelModuleHelper.h.

◆ COL_SHIFT

constexpr unsigned int InDet::PixelModuleHelper::COL_SHIFT = 12

staticconstexpr

Definition at line 44 of file PixelModuleHelper.h.

◆ COLGROUP_DEFECT_BIT_MASK

constexpr unsigned int InDet::PixelModuleHelper::COLGROUP_DEFECT_BIT_MASK = (1u<<31)

staticconstexpr

Definition at line 39 of file PixelModuleHelper.h.

◆ m_circuitsPerColumn

unsigned char InDet::PixelModuleHelper::m_circuitsPerColumn = 0

private

Definition at line 257 of file PixelModuleHelper.h.

◆ m_circuitsPerRow

unsigned char InDet::PixelModuleHelper::m_circuitsPerRow = 0

private

Definition at line 256 of file PixelModuleHelper.h.

◆ m_columns

unsigned short InDet::PixelModuleHelper::m_columns = 0

private

Definition at line 253 of file PixelModuleHelper.h.

◆ m_columnsPerCircuit

unsigned short InDet::PixelModuleHelper::m_columnsPerCircuit = 0

private

Definition at line 255 of file PixelModuleHelper.h.

◆ m_pixelModuleDesign

const InDetDD::PixelModuleDesign* InDet::PixelModuleHelper::m_pixelModuleDesign =nullptr

private

Definition at line 251 of file PixelModuleHelper.h.

◆ m_rows

unsigned short InDet::PixelModuleHelper::m_rows = 0

private

Definition at line 252 of file PixelModuleHelper.h.

◆ m_rowsPerCircuit

unsigned short InDet::PixelModuleHelper::m_rowsPerCircuit = 0

private

Definition at line 254 of file PixelModuleHelper.h.

◆ m_swapOfflineRowsColumns

bool InDet::PixelModuleHelper::m_swapOfflineRowsColumns =false

private

Definition at line 258 of file PixelModuleHelper.h.

◆ N_COLS_PER_GROUP

constexpr unsigned int InDet::PixelModuleHelper::N_COLS_PER_GROUP = 8

staticconstexpr

Definition at line 47 of file PixelModuleHelper.h.

◆ ROW_MASK

constexpr unsigned int InDet::PixelModuleHelper::ROW_MASK = MaskUtils::createMask<0,12>()

staticconstexpr

Definition at line 42 of file PixelModuleHelper.h.

◆ ROW_SHIFT

constexpr unsigned int InDet::PixelModuleHelper::ROW_SHIFT = 0

staticconstexpr

Definition at line 45 of file PixelModuleHelper.h.

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

PixelModuleHelper.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PixelModuleHelper()

Member Function Documentation

◆ circuitsPerColumn()

◆ circuitsPerRow()

◆ columnGroupDefect()

◆ columns()

◆ columnsPerCircuit()

◆ getChip()

◆ getColumn()

◆ getRow()

◆ hardwareCoordinates()

◆ inSameColumnGroup()

◆ isColumnGroupDefect()

◆ isSameDefect()

◆ isSameDefectWithGroups()

◆ nColumns()

◆ nPixels()

◆ nRows()

◆ offlineRange()

◆ operator bool()

◆ rows()

◆ rowsPerCircuit()

◆ swapOfflineRowsColumns()

Member Data Documentation

◆ CHIP_MASK

◆ CHIP_SHIFT

◆ COL_MASK

◆ COL_MASK_FOR_GROUP

◆ COL_SHIFT

◆ COLGROUP_DEFECT_BIT_MASK

◆ m_circuitsPerColumn

◆ m_circuitsPerRow

◆ m_columns

◆ m_columnsPerCircuit

◆ m_pixelModuleDesign

◆ m_rows

◆ m_rowsPerCircuit

◆ m_swapOfflineRowsColumns

◆ N_COLS_PER_GROUP

◆ ROW_MASK

◆ ROW_SHIFT