SiPixelCluster Class Reference

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 (unsigned int isize, uint16_t const *adcs, uint16_t const *xpos, uint16_t const *ypos, uint16_t const xmin, uint16_t const ymin)
	SiPixelCluster (const PixelPos &pix, int adc)
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

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

Definition at line 67 of file SiPixelCluster.h.

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

Definition at line 68 of file SiPixelCluster.h.

Constructor & Destructor Documentation

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 78 of file SiPixelCluster.h.

Referenced by SiPixelCluster().

{}

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 80 of file SiPixelCluster.h.

References SiPixelCluster::Pixel::adc, add(), mps_fire::i, min(), packCol(), packRow(), SiPixelCluster(), thePixelOffset, TrackerOfflineValidation_Dqm_cff::xmin, and Phase2TrackerMonitorDigi_cff::ymin.

                                                      :   
    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);
  }

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

Definition at line 18 of file SiPixelCluster.cc.

References thePixelADC, and thePixelOffset.

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

Member Function Documentation

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

Definition at line 28 of file SiPixelCluster.cc.

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

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

                                                                    {
  
  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) );
}

int SiPixelCluster::charge ( ) const

inline

Definition at line 130 of file SiPixelCluster.h.

References mps_fire::i, and thePixelADC.

Referenced by PixelThresholdClusterizer::clusterizeDetUnitT(), SiPixelTrackResidualModule::fill(), ApeEstimator::fillHitVariables(), PixelCPEGeneric::localPosition(), PixelThresholdClusterizer::make_cluster(), JetCoreClusterSplitter::produce(), FastPrimaryVertexWithWeightsProducer::produce(), JetCoreClusterSplitter::split(), TrackClusterSplitter::splitCluster(), x(), and y().

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

int SiPixelCluster::colSpan ( ) const

inline

Definition at line 172 of file SiPixelCluster.h.

References thePixelColSpan.

Referenced by maxPixelCol(), and sizeY().

{return thePixelColSpan; }

float SiPixelCluster::getSplitClusterErrorX ( ) const

inline

Definition at line 196 of file SiPixelCluster.h.

References err_x.

{ return err_x; }

float SiPixelCluster::getSplitClusterErrorY ( ) const

inline

Definition at line 197 of file SiPixelCluster.h.

References err_y.

{ return err_y; }

int SiPixelCluster::maxPixelCol ( ) const

inline

Definition at line 141 of file SiPixelCluster.h.

References colSpan(), and minPixelCol().

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

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

int SiPixelCluster::maxPixelRow ( ) const

inline

Definition at line 139 of file SiPixelCluster.h.

References minPixelRow(), and rowSpan().

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

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

int SiPixelCluster::minPixelCol ( ) const

inline

Definition at line 140 of file SiPixelCluster.h.

References theMinPixelCol.

Referenced by add(), PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), PixelCPEGeneric::localError(), PixelCPEGeneric::localPosition(), maxPixelCol(), operator<(), pixel(), ClusterTPAssociationProducer::produce(), ShallowGainCalibration::produce(), fireworks::pushPixelCluster(), PixelCPEBase::setTheClu(), TrackClusterSplitter::splitCluster(), and y().

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

int SiPixelCluster::minPixelRow ( ) const

inline

Definition at line 138 of file SiPixelCluster.h.

References theMinPixelRow.

Referenced by add(), PixelThresholdClusterizer::clusterizeDetUnitT(), PixelCPEGeneric::collect_edge_charges(), ClusterShape::determineShape(), PixelCPEGeneric::localError(), PixelCPEGeneric::localPosition(), PixelThresholdClusterizer::make_cluster(), maxPixelRow(), operator<(), pixel(), JetCoreClusterSplitter::produce(), ClusterTPAssociationProducer::produce(), ShallowGainCalibration::produce(), fireworks::pushPixelCluster(), PixelCPEBase::setTheClu(), JetCoreClusterSplitter::split(), TrackClusterSplitter::splitCluster(), and x().

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

bool SiPixelCluster::overflow ( ) const

inline

Definition at line 181 of file SiPixelCluster.h.

References overflowCol(), and overflowRow().

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

static int SiPixelCluster::overflow_ ( uint16_t  span )

inlinestaticprivate

Definition at line 168 of file SiPixelCluster.h.

Referenced by overflowCol(), and overflowRow().

{ return span==uint16_t(MAXSPAN);}

bool SiPixelCluster::overflowCol ( ) const

inline

Definition at line 177 of file SiPixelCluster.h.

References overflow_(), and thePixelColSpan.

Referenced by add(), and overflow().

{ return overflow_(thePixelColSpan); }

bool SiPixelCluster::overflowRow ( ) const

inline

Definition at line 179 of file SiPixelCluster.h.

References overflow_(), and thePixelRowSpan.

Referenced by add(), and overflow().

{ return overflow_(thePixelRowSpan); }

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

inline

Definition at line 183 of file SiPixelCluster.h.

References min(), theMinPixelCol, thePixelColSpan, and Phase2TrackerMonitorDigi_cff::ymin.

Referenced by add(), and SiPixelCluster().

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

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

inline

Definition at line 187 of file SiPixelCluster.h.

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

Referenced by add(), and SiPixelCluster().

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

Pixel SiPixelCluster::pixel ( int  i ) const

inline

Definition at line 159 of file SiPixelCluster.h.

References minPixelCol(), minPixelRow(), SiPixelCluster::Pixel::Pixel(), thePixelADC, and thePixelOffset.

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

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

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

inline

Definition at line 145 of file SiPixelCluster.h.

References thePixelADC.

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

{ return thePixelADC;}

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

inline

Definition at line 144 of file SiPixelCluster.h.

References thePixelOffset.

{ return thePixelOffset;}

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

inline

Definition at line 148 of file SiPixelCluster.h.

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

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

                                        {
    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;
  }

int SiPixelCluster::rowSpan ( ) const

inline

Definition at line 174 of file SiPixelCluster.h.

References thePixelRowSpan.

Referenced by maxPixelRow(), and sizeX().

{ return thePixelRowSpan; }

void SiPixelCluster::setSplitClusterErrorX ( float  errx )

inline

Definition at line 194 of file SiPixelCluster.h.

References err_x.

Referenced by JetCoreClusterSplitter::produce(), and TrackClusterSplitter::splitCluster().

{ err_x = errx; }

void SiPixelCluster::setSplitClusterErrorY ( float  erry )

inline

Definition at line 195 of file SiPixelCluster.h.

References err_y.

Referenced by JetCoreClusterSplitter::produce(), and TrackClusterSplitter::splitCluster().

{ err_y = erry; }

int SiPixelCluster::size ( void  ) const

inline

Definition at line 121 of file SiPixelCluster.h.

References thePixelADC.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), SiStripMonitorCluster::analyze(), PixelCPEGeneric::collect_edge_charges(), TkPixelMeasurementDet::compHits(), SiPixelTrackResidualModule::fill(), SiPixelClusterShapeCacheProducer::produce(), and TrackClusterSplitter::splitCluster().

{ return thePixelADC.size();}

int SiPixelCluster::sizeX ( ) const

inline

Definition at line 124 of file SiPixelCluster.h.

References rowSpan().

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

{ return rowSpan() +1;}

int SiPixelCluster::sizeY ( ) const

inline

Definition at line 127 of file SiPixelCluster.h.

References colSpan().

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

{ return colSpan() +1;}

float SiPixelCluster::x ( ) const

inline

Definition at line 104 of file SiPixelCluster.h.

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

Referenced by svgfig.Curve.Sample::__repr__(), svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), SiPixelErrorEstimation::computeAnglesFromDetPosition(), PixelCPEBase::computeAnglesFromDetPosition(), ApeEstimator::fillHitVariables(), PixelCPEGeneric::localPosition(), SiPixelCoordinates::pixel_(), geometryXMLparser.Alignable::pos(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), ntupleDataFormat._HitObject::r(), ntupleDataFormat._HitObject::r3D(), and TrackClusterSplitter::splitCluster().

                  {
    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();
  }

float SiPixelCluster::y ( ) const

inline

Definition at line 112 of file SiPixelCluster.h.

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

Referenced by svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), SiPixelErrorEstimation::computeAnglesFromDetPosition(), PixelCPEBase::computeAnglesFromDetPosition(), ApeEstimator::fillHitVariables(), PixelCPEGeneric::localPosition(), SiPixelCoordinates::pixel_(), geometryXMLparser.Alignable::pos(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), ntupleDataFormat._HitObject::r(), ntupleDataFormat._HitObject::r3D(), and TrackClusterSplitter::splitCluster().

                  {
    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();
  }

Member Data Documentation

float SiPixelCluster::err_x =-99999.9f

private

Definition at line 211 of file SiPixelCluster.h.

Referenced by getSplitClusterErrorX(), and setSplitClusterErrorX().

float SiPixelCluster::err_y =-99999.9f

private

Definition at line 212 of file SiPixelCluster.h.

Referenced by getSplitClusterErrorY(), and setSplitClusterErrorY().

constexpr unsigned int SiPixelCluster::MAXPOS =2047

static

Definition at line 72 of file SiPixelCluster.h.

constexpr unsigned int SiPixelCluster::MAXSPAN =255

static

Definition at line 71 of file SiPixelCluster.h.

Referenced by add().

uint16_t SiPixelCluster::theMinPixelCol =MAXPOS

private

Definition at line 207 of file SiPixelCluster.h.

Referenced by minPixelCol(), and packCol().

uint16_t SiPixelCluster::theMinPixelRow =MAXPOS

private

Definition at line 206 of file SiPixelCluster.h.

Referenced by minPixelRow(), and packRow().

std::vector<uint16_t> SiPixelCluster::thePixelADC

private

Definition at line 203 of file SiPixelCluster.h.

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

uint8_t SiPixelCluster::thePixelColSpan =0

private

Definition at line 209 of file SiPixelCluster.h.

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

std::vector<uint8_t> SiPixelCluster::thePixelOffset

private

Definition at line 202 of file SiPixelCluster.h.

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

uint8_t SiPixelCluster::thePixelRowSpan =0

private

Definition at line 208 of file SiPixelCluster.h.

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