FTLCluster Class Reference

#include <FTLCluster.h>

Classes
class	FTLHit
class	FTLHitPos
class	Shift

Public Types
typedef DetId	key_type

Public Member Functions
int	colSpan () const
const DetId &	detid () const
float	energy () const
	FTLCluster ()
	FTLCluster (DetId id, unsigned int isize, float const *energys, float const *times, float const *time_errors, uint16_t const *xpos, uint16_t const *ypos, uint16_t const xmin, uint16_t const ymin)
float	getClusterErrorTime () const
float	getClusterErrorX () const
float	getClusterPosX () const
FTLHit	hit (int i) const
const std::vector< float > &	hitENERGY () const
const std::vector< uint8_t > &	hitOffset () const
const std::vector< float > &	hitTIME () const
const std::vector< float > &	hitTIME_ERROR () const
const DetId &	id () const
int	maxHitCol () const
int	maxHitRow () const
int	minHitCol () const
int	minHitRow () 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)
float	positionError (const float sigmaPos) const
int	rowSpan () const
FTLHit	seed () const
void	setClusterErrorTime (float errtime)
void	setClusterErrorX (float errx)
void	setClusterPosX (float posx)
int	size () const
int	sizeX () const
int	sizeY () const
float	time () const
float	timeError () const
float	x () const
float	y () const

Static Public Attributes
static constexpr unsigned int	MAXPOS = 2047
static constexpr unsigned int	MAXSPAN = 255

Private Member Functions
template<typename Value >
float	weighted_mean (const std::vector< float > &weights, Value &&value) const
template<typename Err >
float	weighted_mean_error (const std::vector< float > &weights, Err &&err) const
template<typename SumFunc , typename OutFunc >
float	weighted_sum (const std::vector< float > &weights, SumFunc &&sumFunc, OutFunc &&outFunc) const

Static Private Member Functions
static int	overflow_ (uint16_t span)

Private Attributes
float	err_time = -99999.9f
float	err_x = -99999.9f
float	pos_x = -99999.9f
uint8_t	seed_
uint8_t	theHitColSpan = 0
std::vector< float >	theHitENERGY
std::vector< uint8_t >	theHitOffset
uint8_t	theHitRowSpan = 0
std::vector< float >	theHitTIME
std::vector< float >	theHitTIME_ERROR
DetId	theid
uint16_t	theMinHitCol = MAXPOS
uint16_t	theMinHitRow = MAXPOS

Detailed Description

based on SiPixelCluster

Author

Paolo Meridiani

Definition at line 20 of file FTLCluster.h.

Member Typedef Documentation

key_type

typedef DetId FTLCluster::key_type

Definition at line 22 of file FTLCluster.h.

Constructor & Destructor Documentation

FTLCluster() [1/2]

FTLCluster::FTLCluster ( )

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 FTLCluster.h.

{}

FTLCluster() [2/2]

FTLCluster::FTLCluster ( DetId  id, unsigned int  isize, float const *  energys, float const *  times, float const *  time_errors, uint16_t const *  xpos, uint16_t const *  ypos, uint16_t const  xmin, uint16_t const  ymin  )

inline

Definition at line 80 of file FTLCluster.h.

References mps_fire::i, particleFlowClusterECALTimeSelected_cfi::maxEnergy, MTVHistoProducerAlgoForTrackerBlock_cfi::maxHit, MAXSPAN, SiStripPI::min, packCol(), packRow(), seed_, theHitENERGY, theHitOffset, TrackerOfflineValidation_Dqm_cff::xmin, EcalSCDynamicDPhiParametersESProducer_cfi::xoffset, L1TOccupancyClient_cfi::ymin, and EcalSCDynamicDPhiParametersESProducer_cfi::yoffset.

      : theid(id),
        theHitOffset(2 * isize),
        theHitENERGY(energys, energys + isize),
        theHitTIME(times, times + isize),
        theHitTIME_ERROR(time_errors, time_errors + isize) {
    uint16_t maxCol = 0;
    uint16_t maxRow = 0;
    int maxHit = -1;
    float maxEnergy = -99999;
    for (unsigned int i = 0; i != isize; ++i) {
      uint16_t xoffset = xpos[i] - xmin;
      uint16_t yoffset = ypos[i] - ymin;
      theHitOffset[i * 2] = std::min(uint16_t(MAXSPAN), xoffset);
      theHitOffset[i * 2 + 1] = std::min(uint16_t(MAXSPAN), yoffset);
      if (xoffset > maxRow)
        maxRow = xoffset;
      if (yoffset > maxCol)
        maxCol = yoffset;
      if (theHitENERGY[i] > maxEnergy) {
        maxHit = i;
        maxEnergy = theHitENERGY[i];
      }
    }
    packRow(xmin, maxRow);
    packCol(ymin, maxCol);

    if (maxHit >= 0)
      seed_ = std::min(uint8_t(MAXSPAN), uint8_t(maxHit));
  }

Member Function Documentation

colSpan()

int FTLCluster::colSpan ( ) const

inline

Definition at line 186 of file FTLCluster.h.

References theHitColSpan.

Referenced by maxHitCol(), and sizeY().

{ return theHitColSpan; }

detid()

const DetId& FTLCluster::detid ( ) const

inline

Definition at line 191 of file FTLCluster.h.

References id().

{ return id(); }

energy()

float FTLCluster::energy ( ) const

inline

Definition at line 161 of file FTLCluster.h.

References theHitENERGY.

Referenced by MTDThresholdClusterizer::clusterize(), MTDTrackingRecHit::energy(), and Jet.Jet::rawEnergy().

                              {
    return std::accumulate(theHitENERGY.begin(), theHitENERGY.end(), 0.f);
  }  // Return total cluster energy.

getClusterErrorTime()

float FTLCluster::getClusterErrorTime ( ) const

inline

Definition at line 213 of file FTLCluster.h.

References err_time.

{ return err_time; }

getClusterErrorX()

float FTLCluster::getClusterErrorX ( ) const

inline

Definition at line 212 of file FTLCluster.h.

References err_x.

Referenced by MTDThresholdClusterizer::clusterize().

{ return err_x; }

getClusterPosX()

float FTLCluster::getClusterPosX ( ) const

inline

Definition at line 211 of file FTLCluster.h.

References pos_x.

Referenced by MTDThresholdClusterizer::clusterize().

{ return pos_x; }

hit()

FTLHit FTLCluster::hit ( int  i ) const

inline

Definition at line 176 of file FTLCluster.h.

References mps_fire::i, minHitCol(), minHitRow(), theHitENERGY, theHitOffset, theHitTIME, and theHitTIME_ERROR.

Referenced by seed().

                          {
    return FTLHit(minHitRow() + theHitOffset[i * 2],
                  minHitCol() + theHitOffset[i * 2 + 1],
                  theHitENERGY[i],
                  theHitTIME[i],
                  theHitTIME_ERROR[i]);
  }

hitENERGY()

const std::vector<float>& FTLCluster::hitENERGY ( ) const

inline

Definition at line 171 of file FTLCluster.h.

References theHitENERGY.

{ return theHitENERGY; }

hitOffset()

const std::vector<uint8_t>& FTLCluster::hitOffset ( ) const

inline

Definition at line 170 of file FTLCluster.h.

References theHitOffset.

{ return theHitOffset; }

hitTIME()

const std::vector<float>& FTLCluster::hitTIME ( ) const

inline

Definition at line 172 of file FTLCluster.h.

References theHitTIME.

{ return theHitTIME; }

hitTIME_ERROR()

const std::vector<float>& FTLCluster::hitTIME_ERROR ( ) const

inline

Definition at line 173 of file FTLCluster.h.

References theHitTIME_ERROR.

{ return theHitTIME_ERROR; }

id()

const DetId& FTLCluster::id ( ) const

inline

Definition at line 190 of file FTLCluster.h.

References theid.

Referenced by detid(), EtlLocalRecoValidation::isSameCluster(), and BtlLocalRecoValidation::isSameCluster().

{ return theid; }

maxHitCol()

int FTLCluster::maxHitCol ( ) const

inline

Definition at line 168 of file FTLCluster.h.

References colSpan(), and minHitCol().

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

maxHitRow()

int FTLCluster::maxHitRow ( ) const

inline

Definition at line 166 of file FTLCluster.h.

References minHitRow(), and rowSpan().

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

minHitCol()

int FTLCluster::minHitCol ( ) const

inline

Definition at line 167 of file FTLCluster.h.

References theMinHitCol.

Referenced by hit(), maxHitCol(), and y().

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

minHitRow()

int FTLCluster::minHitRow ( ) const

inline

Definition at line 165 of file FTLCluster.h.

References theMinHitRow.

Referenced by hit(), maxHitRow(), and x().

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

overflow()

bool FTLCluster::overflow ( ) const

inline

Definition at line 197 of file FTLCluster.h.

References overflowCol(), and overflowRow().

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

overflow_()

static int FTLCluster::overflow_ ( uint16_t  span )

inlinestaticprivate

Definition at line 269 of file FTLCluster.h.

References MAXSPAN.

Referenced by overflowCol(), and overflowRow().

{ return span == uint16_t(MAXSPAN); }

overflowCol()

bool FTLCluster::overflowCol ( ) const

inline

Definition at line 193 of file FTLCluster.h.

References overflow_(), and theHitColSpan.

Referenced by overflow().

{ return overflow_(theHitColSpan); }

overflowRow()

bool FTLCluster::overflowRow ( ) const

inline

Definition at line 195 of file FTLCluster.h.

References overflow_(), and theHitRowSpan.

Referenced by overflow().

{ return overflow_(theHitRowSpan); }

packCol()

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

inline

Definition at line 199 of file FTLCluster.h.

References MAXSPAN, SiStripPI::min, theHitColSpan, theMinHitCol, and L1TOccupancyClient_cfi::ymin.

Referenced by FTLCluster().

                                              {
    theMinHitCol = ymin;
    theHitColSpan = std::min(yspan, uint16_t(MAXSPAN));
  }

packRow()

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

inline

Definition at line 203 of file FTLCluster.h.

References MAXSPAN, SiStripPI::min, theHitRowSpan, theMinHitRow, and TrackerOfflineValidation_Dqm_cff::xmin.

Referenced by FTLCluster().

                                              {
    theMinHitRow = xmin;
    theHitRowSpan = std::min(xspan, uint16_t(MAXSPAN));
  }

positionError()

float FTLCluster::positionError ( const float  sigmaPos ) const

inline

Definition at line 130 of file FTLCluster.h.

References f, mathSSE::sqrt(), and theHitENERGY.

                                                         {
    float sumW2(0.f), sumW(0.f);
    for (const auto& hitW : theHitENERGY) {
      sumW2 += hitW * hitW;
      sumW += hitW;
    }
    if (sumW > 0)
      return sigmaPos * std::sqrt(sumW2) / sumW;
    else
      return -999.f;
  }

rowSpan()

int FTLCluster::rowSpan ( ) const

inline

Definition at line 188 of file FTLCluster.h.

References theHitRowSpan.

Referenced by maxHitRow(), and sizeX().

{ return theHitRowSpan; }

seed()

FTLHit FTLCluster::seed ( ) const

inline

Definition at line 184 of file FTLCluster.h.

References hit(), and seed_.

{ return hit(seed_); }

setClusterErrorTime()

void FTLCluster::setClusterErrorTime ( float  errtime )

inline

Definition at line 210 of file FTLCluster.h.

References err_time.

{ err_time = errtime; }

setClusterErrorX()

void FTLCluster::setClusterErrorX ( float  errx )

inline

Definition at line 209 of file FTLCluster.h.

References err_x.

{ err_x = errx; }

setClusterPosX()

void FTLCluster::setClusterPosX ( float  posx )

inline

Definition at line 208 of file FTLCluster.h.

References pos_x.

{ pos_x = posx; }

size()

int FTLCluster::size ( void  ) const

inline

Definition at line 153 of file FTLCluster.h.

References theHitENERGY.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), MTDThresholdClusterizer::clusterize(), EtlLocalRecoValidation::isSameCluster(), and BtlLocalRecoValidation::isSameCluster().

{ return theHitENERGY.size(); }

sizeX()

int FTLCluster::sizeX ( ) const

inline

Definition at line 156 of file FTLCluster.h.

References rowSpan().

{ return rowSpan() + 1; }

sizeY()

int FTLCluster::sizeY ( ) const

inline

Definition at line 159 of file FTLCluster.h.

References colSpan().

{ return colSpan() + 1; }

time()

float FTLCluster::time ( ) const

inline

Definition at line 142 of file FTLCluster.h.

References mps_fire::i, submitPVValidationJobs::t, theHitENERGY, theHitTIME, and weighted_mean().

Referenced by MTDThresholdClusterizer::clusterize(), EtlLocalRecoValidation::isSameCluster(), BtlLocalRecoValidation::isSameCluster(), and MTDTrackingRecHit::time().

                            {
    auto t = [this](unsigned int i) { return this->theHitTIME[i]; };
    return weighted_mean(this->theHitENERGY, t);
  }

timeError()

float FTLCluster::timeError ( ) const

inline

Definition at line 147 of file FTLCluster.h.

References mps_fire::i, theHitENERGY, theHitTIME_ERROR, and weighted_mean_error().

Referenced by MTDThresholdClusterizer::clusterize(), and MTDTrackingRecHit::timeError().

                                 {
    auto t_err = [this](unsigned int i) { return this->theHitTIME_ERROR[i]; };
    return weighted_mean_error(this->theHitENERGY, t_err);
  }

weighted_mean()

template<typename Value >

float FTLCluster::weighted_mean ( const std::vector< float > &  weights, Value &&  value  ) const

inlineprivate

Definition at line 246 of file FTLCluster.h.

References mps_fire::i, relativeConstraints::value, weighted_sum(), hltDeepSecondaryVertexTagInfosPFPuppi_cfi::weights, x(), and y().

Referenced by time(), x(), and y().

                                                                            {
    auto sumFunc = [&weights, value](unsigned int i) { return weights[i] * value(i); };
    auto outFunc = [](float x, float y) {
      if (y > 0)
        return (float)x / y;
      else
        return -999.f;
    };
    return weighted_sum(weights, sumFunc, outFunc);
  }

weighted_mean_error()

template<typename Err >

float FTLCluster::weighted_mean_error ( const std::vector< float > &  weights, Err &&  err  ) const

inlineprivate

Definition at line 258 of file FTLCluster.h.

References submitPVResolutionJobs::err, mps_fire::i, mathSSE::sqrt(), weighted_sum(), hltDeepSecondaryVertexTagInfosPFPuppi_cfi::weights, x(), and y().

Referenced by timeError().

                                                                              {
    auto sumFunc = [&weights, err](unsigned int i) { return weights[i] * weights[i] * err(i) * err(i); };
    auto outFunc = [](float x, float y) {
      if (y > 0)
        return (float)sqrt(x) / y;
      else
        return -999.f;
    };
    return weighted_sum(weights, sumFunc, outFunc);
  }

weighted_sum()

template<typename SumFunc , typename OutFunc >

float FTLCluster::weighted_sum ( const std::vector< float > &  weights, SumFunc &&  sumFunc, OutFunc &&  outFunc  ) const

inlineprivate

Definition at line 235 of file FTLCluster.h.

References mps_fire::i, compareTotals::tot, and hltDeepSecondaryVertexTagInfosPFPuppi_cfi::weights.

Referenced by weighted_mean(), and weighted_mean_error().

                                                                                                  {
    float tot = 0;
    float sumW = 0;
    for (unsigned int i = 0; i < weights.size(); ++i) {
      tot += sumFunc(i);
      sumW += weights[i];
    }
    return outFunc(tot, sumW);
  }

x()

float FTLCluster::x ( ) const

inline

Definition at line 120 of file FTLCluster.h.

References mps_fire::i, minHitRow(), theHitENERGY, theHitOffset, and weighted_mean().

Referenced by svgfig.Curve.Sample::__repr__(), svgfig.Ellipse::__repr__(), MTDThresholdClusterizer::clusterize(), EtlLocalRecoValidation::isSameCluster(), BtlLocalRecoValidation::isSameCluster(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), ntupleDataFormat._HitObject::r3D(), weighted_mean(), and weighted_mean_error().

                         {
    auto x_pos = [this](unsigned int i) { return this->theHitOffset[i * 2] + minHitRow(); };
    return weighted_mean(this->theHitENERGY, x_pos);
  }

y()

float FTLCluster::y ( ) const

inline

Definition at line 125 of file FTLCluster.h.

References mps_fire::i, minHitCol(), theHitENERGY, theHitOffset, and weighted_mean().

Referenced by svgfig.Ellipse::__repr__(), MTDThresholdClusterizer::clusterize(), EtlLocalRecoValidation::isSameCluster(), BtlLocalRecoValidation::isSameCluster(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), ntupleDataFormat._HitObject::r3D(), weighted_mean(), and weighted_mean_error().

                         {
    auto y_pos = [this](unsigned int i) { return this->theHitOffset[i * 2 + 1] + minHitCol(); };
    return weighted_mean(this->theHitENERGY, y_pos);
  }

Member Data Documentation

err_time

float FTLCluster::err_time = -99999.9f

private

Definition at line 230 of file FTLCluster.h.

Referenced by getClusterErrorTime(), and setClusterErrorTime().

err_x

float FTLCluster::err_x = -99999.9f

private

Definition at line 229 of file FTLCluster.h.

Referenced by getClusterErrorX(), and setClusterErrorX().

MAXPOS

constexpr unsigned int FTLCluster::MAXPOS = 2047

static

Definition at line 73 of file FTLCluster.h.

MAXSPAN

constexpr unsigned int FTLCluster::MAXSPAN = 255

static

Definition at line 72 of file FTLCluster.h.

Referenced by FTLCluster(), overflow_(), packCol(), and packRow().

pos_x

float FTLCluster::pos_x = -99999.9f

private

Definition at line 228 of file FTLCluster.h.

Referenced by getClusterPosX(), and setClusterPosX().

seed_

uint8_t FTLCluster::seed_

private

Definition at line 232 of file FTLCluster.h.

Referenced by FTLCluster(), and seed().

theHitColSpan

uint8_t FTLCluster::theHitColSpan = 0

private

Definition at line 226 of file FTLCluster.h.

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

theHitENERGY

std::vector<float> FTLCluster::theHitENERGY

private

Definition at line 219 of file FTLCluster.h.

Referenced by energy(), FTLCluster(), hit(), hitENERGY(), positionError(), size(), time(), timeError(), x(), and y().

theHitOffset

std::vector<uint8_t> FTLCluster::theHitOffset

private

Definition at line 218 of file FTLCluster.h.

Referenced by FTLCluster(), hit(), hitOffset(), x(), and y().

theHitRowSpan

uint8_t FTLCluster::theHitRowSpan = 0

private

Definition at line 225 of file FTLCluster.h.

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

theHitTIME

std::vector<float> FTLCluster::theHitTIME

private

Definition at line 220 of file FTLCluster.h.

Referenced by hit(), hitTIME(), and time().

theHitTIME_ERROR

std::vector<float> FTLCluster::theHitTIME_ERROR

private

Definition at line 221 of file FTLCluster.h.

Referenced by hit(), hitTIME_ERROR(), and timeError().

theid

DetId FTLCluster::theid

private

Definition at line 216 of file FTLCluster.h.

Referenced by id().

theMinHitCol

uint16_t FTLCluster::theMinHitCol = MAXPOS

private

Definition at line 224 of file FTLCluster.h.

Referenced by minHitCol(), and packCol().

theMinHitRow

uint16_t FTLCluster::theMinHitRow = MAXPOS

private

Definition at line 223 of file FTLCluster.h.

Referenced by minHitRow(), and packRow().