SiStripCluster Class Reference

#include <SiStripCluster.h>

Public Types
typedef std::vector< SiStripDigi >::const_iterator	SiStripDigiIter
typedef std::pair< SiStripDigiIter, SiStripDigiIter >	SiStripDigiRange

Public Member Functions
SiStripCluster const &	amplitudes () const
float	barycenter () const
auto const *	begin () const
int	charge () const
bool	empty () const
auto const *	end () const
uint16_t	endStrip () const
template<typename Iter >
void	extend (Iter begin, Iter end)
bool	filter () const
uint16_t	firstStrip () const
bool	full () const
float	getSplitClusterError () const
bool	isFromApprox () const
bool	isMerged () const
auto	operator[] (int i) const
void	setMerged (bool mergedState)
void	setSplitClusterError (float errx)
	SiStripCluster ()
	SiStripCluster (const SiStripDigiRange &range)
	SiStripCluster (uint16_t firstStrip, std::vector< uint8_t > &&data)
template<typename Iter >
	SiStripCluster (const uint16_t &firstStrip, Iter begin, Iter end)
template<typename Iter >
	SiStripCluster (const uint16_t &firstStrip, Iter begin, Iter end, bool merged)
	SiStripCluster (const SiStripApproximateCluster cluster, const uint16_t maxStrips)
auto	size () const

Static Public Attributes
static const uint16_t	mergedValueMask = 0x8000
static const uint16_t	stripIndexMask = 0x7FFF

Private Attributes
std::vector< uint8_t >	amplitudes_
float	barycenter_ = 0
int	charge_ = 0
float	error_x = -99999.9
bool	filter_ = false
uint16_t	firstStrip_ = 0

Detailed Description

Definition at line 12 of file SiStripCluster.h.

Member Typedef Documentation

SiStripDigiIter

typedef std::vector<SiStripDigi>::const_iterator SiStripCluster::SiStripDigiIter

Definition at line 14 of file SiStripCluster.h.

SiStripDigiRange

typedef std::pair<SiStripDigiIter, SiStripDigiIter> SiStripCluster::SiStripDigiRange

Definition at line 15 of file SiStripCluster.h.

Constructor & Destructor Documentation

SiStripCluster() [1/6]

SiStripCluster::SiStripCluster ( )

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 24 of file SiStripCluster.h.

{}

SiStripCluster() [2/6]

SiStripCluster::SiStripCluster ( const SiStripDigiRange &  range )

explicit

check if digis consecutive

Definition at line 4 of file SiStripCluster.cc.

References amplitudes_, mps_fire::i, dqmiolumiharvest::j, FastTimerService_cff::range, and findQualityFiles::v.

                                                            : firstStrip_(range.first->strip()), error_x(-99999.9) {
  std::vector<uint8_t> v;
  v.reserve(range.second - range.first);

  uint16_t lastStrip = 0;
  bool firstInloop = true;
  for (SiStripDigiIter i = range.first; i != range.second; i++) {
    if (!firstInloop && i->strip() != lastStrip + 1) {
      for (int j = 0; j < i->strip() - (lastStrip + 1); j++) {
        v.push_back(0);
      }
    }
    lastStrip = i->strip();
    firstInloop = false;

    v.push_back(i->adc());
  }
  amplitudes_ = v;
}

SiStripCluster() [3/6]

SiStripCluster::SiStripCluster ( uint16_t  firstStrip, std::vector< uint8_t > &&  data  )

inline

Definition at line 28 of file SiStripCluster.h.

      : amplitudes_(std::move(data)), firstStrip_(firstStrip) {}

SiStripCluster() [4/6]

template<typename Iter >

SiStripCluster::SiStripCluster ( const uint16_t &  firstStrip, Iter  begin, Iter  end  )

inline

Definition at line 32 of file SiStripCluster.h.

: amplitudes_(begin, end), firstStrip_(firstStrip) {}

SiStripCluster() [5/6]

template<typename Iter >

SiStripCluster::SiStripCluster ( const uint16_t &  firstStrip, Iter  begin, Iter  end, bool  merged  )

inline

Definition at line 35 of file SiStripCluster.h.

References firstStrip_, and mergedValueMask.

      : amplitudes_(begin, end), firstStrip_(firstStrip) {
    if (merged)
      firstStrip_ |= mergedValueMask;  // if this is a candidate merged cluster
  }

SiStripCluster() [6/6]

SiStripCluster::SiStripCluster	(	const SiStripApproximateCluster	cluster,
		const uint16_t	maxStrips
	)

Definition at line 25 of file SiStripCluster.cc.

References amplitudes_, SiStripApproximateCluster::avgCharge(), SiStripApproximateCluster::barycenter(), barycenter_, charge_, f, SiStripApproximateCluster::filter(), filter_, firstStrip_, nano_mu_digi_cff::float, SiStripPI::max, UNLIKELY, and SiStripApproximateCluster::width().

                                                                                                : error_x(-99999.9) {
  barycenter_ = cluster.barycenter() / 10.0;
  charge_ = cluster.width() * cluster.avgCharge();
  amplitudes_.resize(cluster.width(), cluster.avgCharge());
  filter_ = cluster.filter();

  float halfwidth_ = 0.5f * float(cluster.width());

  //initialize firstStrip_
  firstStrip_ = std::max(barycenter_ - halfwidth_, 0.f);

  if UNLIKELY (firstStrip_ + cluster.width() > maxStrips) {
    firstStrip_ = maxStrips - cluster.width();
  }
}

Member Function Documentation

amplitudes()

SiStripCluster const& SiStripCluster::amplitudes ( ) const

inline

Definition at line 67 of file SiStripCluster.h.

Referenced by TrackerHitAssociator::associateSimpleRecHitCluster(), SimpleCosmicBONSeeder::checkCharge(), ClusterVariables::clusterSize(), SiStripGainFromData::ComputeChargeOverPath(), deDxTools::getCharge(), ClusterShapeHitFilter::getSizes(), SiStripRecHitConverterAlgorithm::isMasked(), StMeasurementConditionSet::isMasked(), CalibrationTrackSelector::isOkCharge(), StripCPEfromTrackAngle::localParameters(), PrintRecoObjects::print(), ClusterTPAssociationProducer::produce(), ShallowGainCalibration::produce(), deDxTools::shapeSelection(), SiStripApproximateCluster::SiStripApproximateCluster(), ClusterVariables::stripCharges(), SiStripClusterInfo::stripCharges(), StripSubClusterShapeFilterBase::testLastHit(), reco::InverseCrosstalkMatrix::unfold(), and SiStripClusterInfo::width().

{ return *this; }

barycenter()

float SiStripCluster::barycenter

(

)

const

The barycenter of the cluster, not corrected for Lorentz shift; should not be used as position estimate for tracking.

Definition at line 47 of file SiStripCluster.cc.

References amplitudes_, barycenter_, firstStrip_, nano_mu_digi_cff::float, mps_fire::i, size(), stripIndexMask, and mitigatedMETSequence_cff::U.

Referenced by SiStripMonitorApproximateCluster::analyze(), SiStripClusterInfo::baryStrip(), SiStripFineDelayHit::closestCluster(), SiStripRecHitConverterAlgorithm::isMasked(), StMeasurementConditionSet::isMasked(), StripCPE::localParameters(), StripCPEfromTrackAngle::localParameters(), PrintRecoObjects::print(), and SiStripApproximateCluster::SiStripApproximateCluster().

                                       {
  if (barycenter_ > 0)
    return barycenter_;

  int sumx = 0;
  int suma = 0;
  auto asize = size();
  for (auto i = 0U; i < asize; ++i) {
    sumx += i * amplitudes_[i];
    suma += amplitudes_[i];
  }

  // strip centers are offcet by half pitch w.r.t. strip numbers,
  // so one has to add 0.5 to get the correct barycenter position.
  // Need to mask off the high bit of firstStrip_, which contains the merged status.
  return float((firstStrip_ & stripIndexMask)) + float(sumx) / float(suma) + 0.5f;
}

begin()

auto const* SiStripCluster::begin ( void  ) const

inline

Definition at line 61 of file SiStripCluster.h.

References amplitudes_.

Referenced by charge(), SimpleCosmicBONSeeder::checkCharge(), end(), extend(), CalibrationTrackSelector::isOkCharge(), and operator[]().

{ return amplitudes_.data(); }

charge()

int SiStripCluster::charge

(

)

const

total charge

Definition at line 41 of file SiStripCluster.cc.

References barycenter_, begin(), charge_, and end().

Referenced by SiStripApproximateCluster::SiStripApproximateCluster().

                                 {
  if (barycenter_ > 0)
    return charge_;
  return std::accumulate(begin(), end(), int(0));
}

empty()

bool SiStripCluster::empty ( ) const

inline

Definition at line 64 of file SiStripCluster.h.

References amplitudes_.

{ return amplitudes_.empty(); }

end()

auto const* SiStripCluster::end ( void  ) const

inline

Definition at line 62 of file SiStripCluster.h.

References begin(), and size().

Referenced by charge(), SimpleCosmicBONSeeder::checkCharge(), Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), extend(), and CalibrationTrackSelector::isOkCharge().

{ return begin() + size(); }

endStrip()

uint16_t SiStripCluster::endStrip ( ) const

inline

Definition at line 73 of file SiStripCluster.h.

References firstStrip(), and size().

{ return firstStrip() + size(); }

extend()

template<typename Iter >

void SiStripCluster::extend ( Iter  begin, Iter  end  )

inline

Definition at line 45 of file SiStripCluster.h.

References amplitudes_, begin(), and end().

Referenced by MatrixUtil.WF::__init__(), Config.Process::extend(), Config.Process::load(), and Mixins._ValidatingParameterListBase::setValue().

                                    {
    amplitudes_.insert(amplitudes_.end(), begin, end);
  }

filter()

bool SiStripCluster::filter

(

)

const

Definition at line 64 of file SiStripCluster.cc.

References barycenter_, and filter_.

Referenced by StripSubClusterShapeFilterBase::testLastHit().

                                  {
  if (barycenter_ > 0)
    return filter_;
  return false;
}

firstStrip()

uint16_t SiStripCluster::firstStrip ( ) const

inline

The number of the first strip in the cluster. The high bit of firstStrip_ indicates whether the cluster is a candidate for being merged.

Definition at line 72 of file SiStripCluster.h.

References firstStrip_, and stripIndexMask.

Referenced by fireworks::addSiStripClusters(), TrackerHitAssociator::associateSimpleRecHitCluster(), FWTrajectorySeedProxyBuilder::build(), SimpleCosmicBONSeeder::checkCharge(), SiStripGainFromData::ComputeChargeOverPath(), FakeCPE::Map::encode(), endStrip(), SiStripClusterInfo::firstStrip(), deDxTools::getCharge(), ClusterShapeHitFilter::getSizes(), SiStripRecHitConverterAlgorithm::isMasked(), StMeasurementConditionSet::isMasked(), StripCPEgeometric::localParameters(), operator<(), PrintRecoObjects::print(), ShallowTrackClustersProducer::produce(), ClusterTPAssociationProducer::produce(), ShallowGainCalibration::produce(), and StripSubClusterShapeFilterBase::testLastHit().

{ return firstStrip_ & stripIndexMask; }

full()

bool SiStripCluster::full ( ) const

inline

Definition at line 65 of file SiStripCluster.h.

{ return false; }

getSplitClusterError()

float SiStripCluster::getSplitClusterError ( ) const

inline

Definition at line 95 of file SiStripCluster.h.

References error_x.

{ return error_x; }

isFromApprox()

bool SiStripCluster::isFromApprox

(

)

const

Definition at line 70 of file SiStripCluster.cc.

References barycenter_.

Referenced by StripSubClusterShapeFilterBase::testLastHit().

{ return (barycenter_ > 0); }

isMerged()

bool SiStripCluster::isMerged ( ) const

inline

Test (set) the merged status of the cluster

Definition at line 92 of file SiStripCluster.h.

References firstStrip_, and mergedValueMask.

Referenced by StripCPEfromTrackAngle::localParameters().

{ return (firstStrip_ & mergedValueMask) != 0; }

operator[]()

auto SiStripCluster::operator[] ( int  i ) const

inline

Definition at line 63 of file SiStripCluster.h.

References begin(), and mps_fire::i.

{ return *(begin() + i); }

setMerged()

void SiStripCluster::setMerged ( bool  mergedState )

inline

Definition at line 93 of file SiStripCluster.h.

References firstStrip_, mergedValueMask, and stripIndexMask.

{ mergedState ? firstStrip_ |= mergedValueMask : firstStrip_ &= stripIndexMask; }

setSplitClusterError()

void SiStripCluster::setSplitClusterError ( float  errx )

inline

Definition at line 96 of file SiStripCluster.h.

References error_x.

{ error_x = errx; }

size()

auto SiStripCluster::size ( void  ) const

inline

The amplitudes of the strips forming the cluster. The amplitudes are on consecutive strips; if a strip is missing the amplitude is set to zero. A strip may be missing in the middle of a cluster because of a clusterizer that accepts holes. A strip may also be missing anywhere in the cluster, including the edge, to record a dead/noisy channel.

You can find the special meanings of values { 0, 254, 255} in section 3.4.1 of http://www.te.rl.ac.uk/esdg/cms-fed/firmware/Documents/FE_FPGA_Technical_Description.pdf

Definition at line 60 of file SiStripCluster.h.

References amplitudes_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), SiStripMonitorCluster::analyze(), TrackerHitAssociator::associateSimpleRecHitCluster(), barycenter(), ClusterVariables::clusterSize(), end(), endStrip(), ClusterShapeHitFilter::getSizes(), SiStripRecHitConverterAlgorithm::isMasked(), StMeasurementConditionSet::isMasked(), StripCPEfromTrackAngle::localParameters(), PrintRecoObjects::print(), ClusterTPAssociationProducer::produce(), SiStripApproximateCluster::SiStripApproximateCluster(), and SiStripClusterInfo::width().

{ return amplitudes_.size(); }

Member Data Documentation

amplitudes_

std::vector<uint8_t> SiStripCluster::amplitudes_

private

Definition at line 99 of file SiStripCluster.h.

Referenced by barycenter(), begin(), empty(), extend(), SiStripCluster(), and size().

barycenter_

float SiStripCluster::barycenter_ = 0

private

Definition at line 104 of file SiStripCluster.h.

Referenced by barycenter(), charge(), filter(), isFromApprox(), and SiStripCluster().

charge_

int SiStripCluster::charge_ = 0

private

Definition at line 105 of file SiStripCluster.h.

Referenced by charge(), and SiStripCluster().

error_x

float SiStripCluster::error_x = -99999.9

private

Definition at line 116 of file SiStripCluster.h.

Referenced by getSplitClusterError(), and setSplitClusterError().

filter_

bool SiStripCluster::filter_ = false

private

Definition at line 106 of file SiStripCluster.h.

Referenced by filter(), and SiStripCluster().

firstStrip_

uint16_t SiStripCluster::firstStrip_ = 0

private

Definition at line 101 of file SiStripCluster.h.

Referenced by barycenter(), firstStrip(), isMerged(), setMerged(), and SiStripCluster().

mergedValueMask

const uint16_t SiStripCluster::mergedValueMask = 0x8000

static

Definition at line 18 of file SiStripCluster.h.

Referenced by isMerged(), setMerged(), and SiStripCluster().

stripIndexMask

const uint16_t SiStripCluster::stripIndexMask = 0x7FFF

static

Definition at line 17 of file SiStripCluster.h.

Referenced by barycenter(), firstStrip(), and setMerged().