Pixel cluster – collection of neighboring pixels above threshold. More...

#include <SiPixelCluster.h>

Classes
class	Pixel

class	PixelPos

class	Shift

Public Types
typedef std::vector< PixelDigi >::const_iterator	PixelDigiIter

typedef std::pair< PixelDigiIter, PixelDigiIter >	PixelDigiRange

Public Member Functions
void	add (const PixelPos &pix, int adc)

int	charge () const

int	colSpan () const

float	getSplitClusterErrorX () const

float	getSplitClusterErrorY () const

int	maxPixelCol () const

int	maxPixelRow () const

int	minPixelCol () const

int	minPixelRow () const

bool	overflow () const

bool	overflowCol () const

bool	overflowRow () const

void	packCol (uint16_t ymin, uint16_t yspan)

void	packRow (uint16_t xmin, uint16_t xspan)

Pixel	pixel (int i) const

const std::vector< uint16_t > &	pixelADC () const

const std::vector< uint8_t > &	pixelOffset () const

const std::vector< Pixel >	pixels () const

int	rowSpan () const

void	setSplitClusterErrorX (float errx)

void	setSplitClusterErrorY (float erry)

	SiPixelCluster ()

	SiPixelCluster (const PixelPos &pix, int adc)

	SiPixelCluster (unsigned int isize, uint16_t const adcs, uint16_t const xpos, uint16_t const *ypos, uint16_t const xmin, uint16_t const ymin)

int	size () const

int	sizeX () const

int	sizeY () const

float	x () const

float	y () const

Static Public Attributes
static constexpr unsigned int	MAXPOS = 2047

static constexpr unsigned int	MAXSPAN = 255

Static Private Member Functions
static int	overflow_ (uint16_t span)

Private Attributes
float	err_x = -99999.9f

float	err_y = -99999.9f

uint16_t	theMinPixelCol = MAXPOS

uint16_t	theMinPixelRow = MAXPOS

std::vector< uint16_t >	thePixelADC

uint8_t	thePixelColSpan = 0

std::vector< uint8_t >	thePixelOffset

uint8_t	thePixelRowSpan = 0

Detailed Description

Pixel cluster – collection of neighboring pixels above threshold.

Pixel cluster – collection of pixels with ADC counts.

Class to contain and store all the topological information of pixel clusters: charge, global size, size and the barycenter in x and y local directions. It builds a vector of SiPixel (which is an inner class) and a container of channels.

March 2007: Edge methods moved to RectangularPixelTopology class (V.Chiochia) Feb 2008: Modify the Pixel class from float to shorts May 2008: Offset based packing (D.Fehling / A. Rizzi) Sep 2012: added Max back, removed detId (V.I.) sizeX and sizeY now clipped at 127 July 2017 make it compatible with PhaseII, remove errs....

Class to contain and store all the topological information of pixel clusters: charge, global size, size and the barycenter in x and y local directions. It builds a vector of SiPixel (which is an inner class) and a container of channels.

March 2007: Edge pixel methods moved to RectangularPixelTopology (V.Chiochia) May 2008: Offset based packing (D.Fehling / A. Rizzi)

Author: Petar Maksimovic, JHU

Definition at line 27 of file SiPixelCluster.h.

Member Typedef Documentation

◆ PixelDigiIter

typedef std::vector<PixelDigi>::const_iterator SiPixelCluster::PixelDigiIter

Definition at line 65 of file SiPixelCluster.h.

◆ PixelDigiRange

typedef std::pair<PixelDigiIter, PixelDigiIter> SiPixelCluster::PixelDigiRange

Definition at line 66 of file SiPixelCluster.h.

Constructor & Destructor Documentation

◆ SiPixelCluster() [1/3]

SiPixelCluster::SiPixelCluster ( )

inline

Construct from a range of digis that form a cluster and from a DetID. The range is assumed to be non-empty.

Definition at line 75 of file SiPixelCluster.h.

75 {}

◆ SiPixelCluster() [2/3]

SiPixelCluster::SiPixelCluster	(	unsigned int	isize,
		uint16_t const *	adcs,
		uint16_t const *	xpos,
		uint16_t const *	ypos,
		uint16_t const	xmin,
		uint16_t const	ymin
	)

inline

Definition at line 77 of file SiPixelCluster.h.

       : thePixelOffset(2 * isize), thePixelADC(adcs, adcs + isize) {
     uint16_t maxCol = 0;
     uint16_t maxRow = 0;
     for (unsigned int i = 0; i != isize; ++i) {
       uint16_t xoffset = xpos[i] - xmin;
       uint16_t yoffset = ypos[i] - ymin;
       thePixelOffset[i * 2] = std::min(uint16_t(MAXSPAN), xoffset);
       thePixelOffset[i * 2 + 1] = std::min(uint16_t(MAXSPAN), yoffset);
       if (xoffset > maxRow)
         maxRow = xoffset;
       if (yoffset > maxCol)
         maxCol = yoffset;
     }
     packRow(xmin, maxRow);
     packCol(ymin, maxCol);
   }

References mps_fire::i, MAXSPAN, min(), packCol(), packRow(), thePixelOffset, TrackerOfflineValidation_Dqm_cff::xmin, HLT_FULL_cff::xoffset, L1TOccupancyClient_cfi::ymin, and HLT_FULL_cff::yoffset.

◆ SiPixelCluster() [3/3]

SiPixelCluster::SiPixelCluster	(	const PixelPos &	pix,
		int	adc
	)

Definition at line 17 of file SiPixelCluster.cc.

     : theMinPixelRow(pix.row()), theMinPixelCol(pix.col()) {
   // First pixel in this cluster.
   thePixelADC.push_back(adc);
   thePixelOffset.push_back(0);
   thePixelOffset.push_back(0);
 }

References ecalLiteDTU::adc(), thePixelADC, and thePixelOffset.

Member Function Documentation

◆ add()

void SiPixelCluster::add	(	const PixelPos &	pix,
		int	adc
	)

Definition at line 25 of file SiPixelCluster.cc.

                                                                    {
   int ominRow = minPixelRow();
   int ominCol = minPixelCol();
   bool recalculate = false;
  
   int minRow = ominRow;
   int minCol = ominCol;
  
   if (pix.row() < minRow) {
     minRow = pix.row();
     recalculate = true;
   }
   if (pix.col() < minCol) {
     minCol = pix.col();
     recalculate = true;
   }
  
   if (recalculate) {
     int maxCol = 0;
     int maxRow = 0;
     int isize = thePixelADC.size();
     for (int i = 0; i < isize; ++i) {
       int xoffset = thePixelOffset[i * 2] + ominRow - minRow;
       int yoffset = thePixelOffset[i * 2 + 1] + ominCol - minCol;
       thePixelOffset[i * 2] = std::min(int(MAXSPAN), xoffset);
       thePixelOffset[i * 2 + 1] = std::min(int(MAXSPAN), yoffset);
       if (xoffset > maxRow)
         maxRow = xoffset;
       if (yoffset > maxCol)
         maxCol = yoffset;
     }
     packRow(minRow, maxRow);
     packCol(minCol, maxCol);
   }
  
   if ((!overflowRow()) && pix.row() > maxPixelRow())
     packRow(minRow, pix.row() - minRow);
  
   if ((!overflowCol()) && pix.col() > maxPixelCol())
     packCol(minCol, pix.col() - minCol);
  
   thePixelADC.push_back(adc);
   thePixelOffset.push_back(std::min(int(MAXSPAN), pix.row() - minRow));
   thePixelOffset.push_back(std::min(int(MAXSPAN), pix.col() - minCol));
 }

References ecalLiteDTU::adc(), SiPixelCluster::PixelPos::col(), mps_fire::i, maxPixelCol(), maxPixelRow(), MAXSPAN, min(), minPixelCol(), minPixelRow(), overflowCol(), overflowRow(), packCol(), packRow(), SiPixelCluster::PixelPos::row(), thePixelADC, thePixelOffset, HLT_FULL_cff::xoffset, and HLT_FULL_cff::yoffset.

Referenced by PixelThresholdClusterizer::make_cluster(), counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

◆ charge()

int SiPixelCluster::charge ( ) const

inline

Definition at line 130 of file SiPixelCluster.h.

                             {
     int qm = 0;
     int isize = thePixelADC.size();
     for (int i = 0; i < isize; ++i)
       qm += thePixelADC[i];
     return qm;
   }  // Return total cluster charge.

References mps_fire::i, and thePixelADC.

Referenced by SiPixelPhase1TrackClustersV::analyze(), PixelCPEClusterRepair::checkRecommend2D(), PixelThresholdClusterizer::clusterizeDetUnitT(), SiPixelTrackResidualModule::fill(), PixelCPEGeneric::localPosition(), PixelThresholdClusterizer::make_cluster(), JetCoreClusterSplitter::produce(), FastPrimaryVertexWithWeightsProducer::produce(), JetCoreClusterSplitter::split(), x(), and y().

◆ colSpan()

int SiPixelCluster::colSpan ( ) const

inline

Definition at line 166 of file SiPixelCluster.h.

166 { return thePixelColSpan; }

References thePixelColSpan.

Referenced by maxPixelCol(), and sizeY().

◆ getSplitClusterErrorX()

float SiPixelCluster::getSplitClusterErrorX ( ) const

inline

Definition at line 189 of file SiPixelCluster.h.

189 { return err_x; }

References err_x.

Referenced by PixelCPEClusterRepair::localError().

◆ getSplitClusterErrorY()

float SiPixelCluster::getSplitClusterErrorY ( ) const

inline

Definition at line 190 of file SiPixelCluster.h.

190 { return err_y; }

References err_y.

Referenced by PixelCPEClusterRepair::localError().

◆ maxPixelCol()

int SiPixelCluster::maxPixelCol ( ) const

inline

Definition at line 141 of file SiPixelCluster.h.

141 { return minPixelCol() + colSpan(); } // The max y index.

References colSpan(), and minPixelCol().

Referenced by add(), PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), PixelCPEGeneric::localError(), PixelCPEGeneric::localPosition(), ClusterTPAssociationProducer::produce(), and PixelCPEBase::setTheClu().

◆ maxPixelRow()

int SiPixelCluster::maxPixelRow ( ) const

inline

Definition at line 139 of file SiPixelCluster.h.

139 { return minPixelRow() + rowSpan(); } // The max x index.

References minPixelRow(), and rowSpan().

Referenced by add(), PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), PixelCPEGeneric::localError(), PixelCPEGeneric::localPosition(), ClusterTPAssociationProducer::produce(), and PixelCPEBase::setTheClu().

◆ minPixelCol()

int SiPixelCluster::minPixelCol ( ) const

inline

Definition at line 140 of file SiPixelCluster.h.

140 { return theMinPixelCol; } // The min y index.

References theMinPixelCol.

Referenced by add(), PixelCPEClusterRepair::checkRecommend2D(), PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), FakeCPE::Map::encode(), PixelCPEGeneric::localError(), PixelCPEClusterRepair::localPosition(), PixelCPEGeneric::localPosition(), maxPixelCol(), pixel(), ClusterTPAssociationProducer::produce(), ShallowGainCalibration::produce(), PixelCPEBase::setTheClu(), and y().

◆ minPixelRow()

int SiPixelCluster::minPixelRow ( ) const

inline

Definition at line 138 of file SiPixelCluster.h.

138 { return theMinPixelRow; } // The min x index.

References theMinPixelRow.

Referenced by add(), PixelThresholdClusterizer::clusterizeDetUnitT(), PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), FakeCPE::Map::encode(), PixelCPEGeneric::localError(), PixelCPEClusterRepair::localPosition(), PixelCPEGeneric::localPosition(), PixelThresholdClusterizer::make_cluster(), maxPixelRow(), pixel(), JetCoreClusterSplitter::produce(), ClusterTPAssociationProducer::produce(), ShallowGainCalibration::produce(), PixelCPEBase::setTheClu(), JetCoreClusterSplitter::split(), and x().

◆ overflow()

bool SiPixelCluster::overflow ( ) const

inline

Definition at line 174 of file SiPixelCluster.h.

174 { return overflowCol() || overflowRow(); }

References overflowCol(), and overflowRow().

◆ overflow_()

static int SiPixelCluster::overflow_ ( uint16_t span )

inlinestaticprivate

Definition at line 163 of file SiPixelCluster.h.

163 { return span == uint16_t(MAXSPAN); }

References MAXSPAN.

Referenced by overflowCol(), and overflowRow().

◆ overflowCol()

bool SiPixelCluster::overflowCol ( ) const

inline

Definition at line 170 of file SiPixelCluster.h.

170 { return overflow_(thePixelColSpan); }

References overflow_(), and thePixelColSpan.

Referenced by add(), and overflow().

◆ overflowRow()

bool SiPixelCluster::overflowRow ( ) const

inline

Definition at line 172 of file SiPixelCluster.h.

172 { return overflow_(thePixelRowSpan); }

References overflow_(), and thePixelRowSpan.

Referenced by add(), and overflow().

◆ packCol()

void SiPixelCluster::packCol	(	uint16_t	ymin,
		uint16_t	yspan
	)

inline

Definition at line 176 of file SiPixelCluster.h.

                                               {
     theMinPixelCol = ymin;
     thePixelColSpan = std::min(yspan, uint16_t(MAXSPAN));
   }

References MAXSPAN, min(), theMinPixelCol, thePixelColSpan, and L1TOccupancyClient_cfi::ymin.

Referenced by add(), and SiPixelCluster().

◆ packRow()

void SiPixelCluster::packRow	(	uint16_t	xmin,
		uint16_t	xspan
	)

inline

Definition at line 180 of file SiPixelCluster.h.

                                               {
     theMinPixelRow = xmin;
     thePixelRowSpan = std::min(xspan, uint16_t(MAXSPAN));
   }

References MAXSPAN, min(), theMinPixelRow, thePixelRowSpan, and TrackerOfflineValidation_Dqm_cff::xmin.

Referenced by add(), and SiPixelCluster().

◆ pixel()

Pixel SiPixelCluster::pixel ( int i ) const

inline

Definition at line 158 of file SiPixelCluster.h.

                            {
     return Pixel(minPixelRow() + thePixelOffset[i * 2], minPixelCol() + thePixelOffset[i * 2 + 1], thePixelADC[i]);
   }

References mps_fire::i, minPixelCol(), minPixelRow(), align::Pixel, thePixelADC, and thePixelOffset.

Referenced by PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), PixelCPEClusterRepair::localPosition(), and pixels().

◆ pixelADC()

const std::vector<uint16_t>& SiPixelCluster::pixelADC ( ) const

inline

Definition at line 144 of file SiPixelCluster.h.

144 { return thePixelADC; }

References thePixelADC.

Referenced by ClusterShape::determineShape(), and ShallowGainCalibration::produce().

◆ pixelOffset()

const std::vector<uint8_t>& SiPixelCluster::pixelOffset ( ) const

inline

Definition at line 143 of file SiPixelCluster.h.

143 { return thePixelOffset; }

References thePixelOffset.

◆ pixels()

const std::vector<Pixel> SiPixelCluster::pixels ( ) const

inline

Definition at line 147 of file SiPixelCluster.h.

                                         {
     std::vector<Pixel> oldPixVector;
     int isize = thePixelADC.size();
     oldPixVector.reserve(isize);
     for (int i = 0; i < isize; ++i) {
       oldPixVector.push_back(pixel(i));
     }
     return oldPixVector;
   }

References mps_fire::i, pixel(), and thePixelADC.

Referenced by analyzer::SiPixelLorentzAngle::fillPix(), JetCoreClusterSplitter::fittingSplit(), and PixelThresholdClusterizer::make_cluster().

◆ rowSpan()

int SiPixelCluster::rowSpan ( ) const

inline

Definition at line 168 of file SiPixelCluster.h.

168 { return thePixelRowSpan; }

References thePixelRowSpan.

Referenced by maxPixelRow(), and sizeX().

◆ setSplitClusterErrorX()

void SiPixelCluster::setSplitClusterErrorX ( float errx )

inline

Definition at line 187 of file SiPixelCluster.h.

187 { err_x = errx; }

References err_x.

◆ setSplitClusterErrorY()

void SiPixelCluster::setSplitClusterErrorY ( float erry )

inline

Definition at line 188 of file SiPixelCluster.h.

188 { err_y = erry; }

References err_y.

◆ size()

int SiPixelCluster::size ( void ) const

inline

Definition at line 122 of file SiPixelCluster.h.

122 { return thePixelADC.size(); }

References thePixelADC.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), SiStripMonitorCluster::analyze(), PixelCPEGeneric::collect_edge_charges(), SiPixelTrackResidualModule::fill(), and PixelCPEClusterRepair::localPosition().

◆ sizeX()

int SiPixelCluster::sizeX ( ) const

inline

Definition at line 125 of file SiPixelCluster.h.

125 { return rowSpan() + 1; }

References rowSpan().

Referenced by SiPixelPhase1TrackClustersV::analyze(), SiPixelTrackResidualModule::fill(), PixelCPEClusterRepair::localError(), PixelCPEGeneric::localError(), PixelCPEGeneric::localPosition(), JetCoreClusterSplitter::produce(), FastPrimaryVertexWithWeightsProducer::produce(), and FastPrimaryVertexProducer::produce().

◆ sizeY()

int SiPixelCluster::sizeY ( ) const

inline

Definition at line 128 of file SiPixelCluster.h.

128 { return colSpan() + 1; }

References colSpan().

Referenced by SiPixelPhase1TrackClustersV::analyze(), PixelCPEClusterRepair::checkRecommend2D(), SiPixelTrackResidualModule::fill(), PixelCPEClusterRepair::localError(), PixelCPEGeneric::localError(), PixelCPEGeneric::localPosition(), JetCoreClusterSplitter::produce(), FastPrimaryVertexWithWeightsProducer::produce(), and FastPrimaryVertexProducer::produce().

◆ x()

float SiPixelCluster::x ( ) const

inline

Definition at line 105 of file SiPixelCluster.h.

                   {
     float qm = 0.0;
     int isize = thePixelADC.size();
     for (int i = 0; i < isize; ++i)
       qm += float(thePixelADC[i]) * (thePixelOffset[i * 2] + minPixelRow() + 0.5f);
     return qm / charge();
   }

References charge(), mps_fire::i, minPixelRow(), thePixelADC, and thePixelOffset.

Referenced by svgfig.Curve.Sample::__repr__(), svgfig.Ellipse::__repr__(), PixelCPEClusterRepair::callTempReco1D(), PixelCPEClusterRepair::callTempReco2D(), PixelCPEBase::computeAnglesFromDetPosition(), PixelCPEGeneric::localPosition(), SiPixelCoordinates::pixel_(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), and ntupleDataFormat._HitObject::r3D().

◆ y()

float SiPixelCluster::y ( ) const

inline

Definition at line 113 of file SiPixelCluster.h.

                   {
     float qm = 0.0;
     int isize = thePixelADC.size();
     for (int i = 0; i < isize; ++i)
       qm += float(thePixelADC[i]) * (thePixelOffset[i * 2 + 1] + minPixelCol() + 0.5f);
     return qm / charge();
   }

References charge(), mps_fire::i, minPixelCol(), thePixelADC, and thePixelOffset.

Referenced by svgfig.Ellipse::__repr__(), PixelCPEClusterRepair::callTempReco1D(), PixelCPEClusterRepair::callTempReco2D(), PixelCPEBase::computeAnglesFromDetPosition(), PixelCPEGeneric::localPosition(), SiPixelCoordinates::pixel_(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), and ntupleDataFormat._HitObject::r3D().

Member Data Documentation

◆ err_x

float SiPixelCluster::err_x = -99999.9f

private

Definition at line 201 of file SiPixelCluster.h.

Referenced by getSplitClusterErrorX(), and setSplitClusterErrorX().

◆ err_y

float SiPixelCluster::err_y = -99999.9f

private

Definition at line 202 of file SiPixelCluster.h.

Referenced by getSplitClusterErrorY(), and setSplitClusterErrorY().

◆ MAXPOS

constexpr unsigned int SiPixelCluster::MAXPOS = 2047

staticconstexpr

Definition at line 69 of file SiPixelCluster.h.

◆ MAXSPAN

constexpr unsigned int SiPixelCluster::MAXSPAN = 255

staticconstexpr

Definition at line 68 of file SiPixelCluster.h.

Referenced by add(), overflow_(), packCol(), packRow(), and SiPixelCluster().

◆ theMinPixelCol

uint16_t SiPixelCluster::theMinPixelCol = MAXPOS

private

Definition at line 197 of file SiPixelCluster.h.

Referenced by minPixelCol(), and packCol().

◆ theMinPixelRow

uint16_t SiPixelCluster::theMinPixelRow = MAXPOS

private

Definition at line 196 of file SiPixelCluster.h.

Referenced by minPixelRow(), and packRow().

◆ thePixelADC

std::vector<uint16_t> SiPixelCluster::thePixelADC

private

Definition at line 194 of file SiPixelCluster.h.

Referenced by add(), charge(), pixel(), pixelADC(), pixels(), SiPixelCluster(), size(), x(), and y().

◆ thePixelColSpan

uint8_t SiPixelCluster::thePixelColSpan = 0

private

Definition at line 199 of file SiPixelCluster.h.

Referenced by colSpan(), overflowCol(), and packCol().

◆ thePixelOffset

std::vector<uint8_t> SiPixelCluster::thePixelOffset

private

Definition at line 193 of file SiPixelCluster.h.

Referenced by add(), pixel(), pixelOffset(), SiPixelCluster(), x(), and y().

◆ thePixelRowSpan

uint8_t SiPixelCluster::thePixelRowSpan = 0

private

Definition at line 198 of file SiPixelCluster.h.

Referenced by overflowRow(), packRow(), and rowSpan().

Classes

Public Types

Public Member Functions

Static Public Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PixelDigiIter

◆ PixelDigiRange

Constructor & Destructor Documentation

◆ SiPixelCluster() [1/3]

◆ SiPixelCluster() [2/3]

◆ SiPixelCluster() [3/3]

Member Function Documentation

◆ add()

◆ charge()

◆ colSpan()

◆ getSplitClusterErrorX()

◆ getSplitClusterErrorY()

◆ maxPixelCol()

◆ maxPixelRow()

◆ minPixelCol()

◆ minPixelRow()

◆ overflow()

◆ overflow_()

◆ overflowCol()

◆ overflowRow()

◆ packCol()

◆ packRow()

◆ pixel()

◆ pixelADC()

◆ pixelOffset()

◆ pixels()

◆ rowSpan()

◆ setSplitClusterErrorX()

◆ setSplitClusterErrorY()

◆ size()

◆ sizeX()

◆ sizeY()

◆ x()

◆ y()

Member Data Documentation

◆ err_x

◆ err_y

◆ MAXPOS

◆ MAXSPAN

◆ theMinPixelCol

◆ theMinPixelRow

◆ thePixelADC

◆ thePixelColSpan

◆ thePixelOffset

◆ thePixelRowSpan