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	getClusterErrorY () 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)
int	rowSpan () const
FTLHit	seed () const
void	setClusterErrorTime (float errtime)
void	setClusterErrorX (float errx)
void	setClusterErrorY (float erry)
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
float	weighted_mean (const std::vector< float > &weights, const std::function< float(unsigned int)> &value) const
float	weighted_mean_error (const std::vector< float > &weights, const std::function< float(unsigned int)> &err) const
float	weighted_sum (const std::vector< float > &weights, const std::function< float(unsigned int i)> &sumFunc, const std::function< float(float, float)> &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	err_y = -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 21 of file FTLCluster.h.

Member Typedef Documentation

typedef DetId FTLCluster::key_type

Definition at line 23 of file FTLCluster.h.

Constructor & Destructor Documentation

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 79 of file FTLCluster.h.

{}

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 81 of file FTLCluster.h.

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

      : 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

int FTLCluster::colSpan ( ) const

inline

Definition at line 175 of file FTLCluster.h.

References theHitColSpan.

Referenced by maxHitCol(), and sizeY().

{ return theHitColSpan; }

const DetId& FTLCluster::detid ( ) const

inline

Definition at line 180 of file FTLCluster.h.

References id().

Referenced by operator<().

{ return id(); }

float FTLCluster::energy ( ) const

inline

Definition at line 150 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.

float FTLCluster::getClusterErrorTime ( ) const

inline

Definition at line 202 of file FTLCluster.h.

References err_time.

{ return err_time; }

float FTLCluster::getClusterErrorX ( ) const

inline

Definition at line 200 of file FTLCluster.h.

References err_x.

{ return err_x; }

float FTLCluster::getClusterErrorY ( ) const

inline

Definition at line 201 of file FTLCluster.h.

References err_y.

{ return err_y; }

FTLHit FTLCluster::hit ( int  i ) const

inline

Definition at line 165 of file FTLCluster.h.

References FTLCluster::FTLHit::FTLHit(), 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]);
  }

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

inline

Definition at line 160 of file FTLCluster.h.

References theHitENERGY.

{ return theHitENERGY; }

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

inline

Definition at line 159 of file FTLCluster.h.

References theHitOffset.

{ return theHitOffset; }

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

inline

Definition at line 161 of file FTLCluster.h.

References theHitTIME.

{ return theHitTIME; }

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

inline

Definition at line 162 of file FTLCluster.h.

References theHitTIME_ERROR.

{ return theHitTIME_ERROR; }

const DetId& FTLCluster::id ( ) const

inline

Definition at line 179 of file FTLCluster.h.

References theid.

Referenced by detid().

{ return theid; }

int FTLCluster::maxHitCol ( ) const

inline

Definition at line 157 of file FTLCluster.h.

References colSpan(), and minHitCol().

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

int FTLCluster::maxHitRow ( ) const

inline

Definition at line 155 of file FTLCluster.h.

References minHitRow(), and rowSpan().

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

int FTLCluster::minHitCol ( ) const

inline

Definition at line 156 of file FTLCluster.h.

References theMinHitCol.

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

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

int FTLCluster::minHitRow ( ) const

inline

Definition at line 154 of file FTLCluster.h.

References theMinHitRow.

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

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

bool FTLCluster::overflow ( ) const

inline

Definition at line 186 of file FTLCluster.h.

References overflowCol(), and overflowRow().

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

static int FTLCluster::overflow_ ( uint16_t  span )

inlinestaticprivate

Definition at line 257 of file FTLCluster.h.

Referenced by overflowCol(), and overflowRow().

{ return span == uint16_t(MAXSPAN); }

bool FTLCluster::overflowCol ( ) const

inline

Definition at line 182 of file FTLCluster.h.

References overflow_(), and theHitColSpan.

Referenced by overflow().

{ return overflow_(theHitColSpan); }

bool FTLCluster::overflowRow ( ) const

inline

Definition at line 184 of file FTLCluster.h.

References overflow_(), and theHitRowSpan.

Referenced by overflow().

{ return overflow_(theHitRowSpan); }

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

inline

Definition at line 188 of file FTLCluster.h.

References min(), theHitColSpan, theMinHitCol, and L1TOccupancyClient_cfi::ymin.

Referenced by FTLCluster().

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

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

inline

Definition at line 192 of file FTLCluster.h.

References min(), theHitRowSpan, theMinHitRow, and TrackerOfflineValidation_Dqm_cff::xmin.

Referenced by FTLCluster().

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

int FTLCluster::rowSpan ( ) const

inline

Definition at line 177 of file FTLCluster.h.

References theHitRowSpan.

Referenced by maxHitRow(), and sizeX().

{ return theHitRowSpan; }

FTLHit FTLCluster::seed ( ) const

inline

Definition at line 173 of file FTLCluster.h.

References hit(), and seed_.

{ return hit(seed_); }

void FTLCluster::setClusterErrorTime ( float  errtime )

inline

Definition at line 199 of file FTLCluster.h.

References err_time.

{ err_time = errtime; }

void FTLCluster::setClusterErrorX ( float  errx )

inline

Definition at line 197 of file FTLCluster.h.

References err_x.

{ err_x = errx; }

void FTLCluster::setClusterErrorY ( float  erry )

inline

Definition at line 198 of file FTLCluster.h.

References err_y.

{ err_y = erry; }

int FTLCluster::size ( void  ) const

inline

Definition at line 142 of file FTLCluster.h.

References theHitENERGY.

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

{ return theHitENERGY.size(); }

int FTLCluster::sizeX ( ) const

inline

Definition at line 145 of file FTLCluster.h.

References rowSpan().

{ return rowSpan() + 1; }

int FTLCluster::sizeY ( ) const

inline

Definition at line 148 of file FTLCluster.h.

References colSpan().

{ return colSpan() + 1; }

float FTLCluster::time ( ) const

inline

Definition at line 131 of file FTLCluster.h.

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

Referenced by MTDThresholdClusterizer::clusterize(), MTDCPEBase::clusterTime(), and MTDTrackingRecHit::time().

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

float FTLCluster::timeError ( ) const

inline

Definition at line 136 of file FTLCluster.h.

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

Referenced by MTDCPEBase::clusterTimeError(), and MTDTrackingRecHit::timeError().

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

float FTLCluster::weighted_mean ( const std::vector< float > &  weights, const std::function< float(unsigned int)> &  value  ) const

inlineprivate

Definition at line 235 of file FTLCluster.h.

References mps_fire::i, relativeConstraints::value, weighted_sum(), HGCalRecHit_cfi::weights, FTLCluster::FTLHit::x(), and FTLCluster::FTLHit::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);
  }

float FTLCluster::weighted_mean_error ( const std::vector< float > &  weights, const std::function< float(unsigned int)> &  err  ) const

inlineprivate

Definition at line 246 of file FTLCluster.h.

References runTheMatrix::err, mps_fire::i, mathSSE::sqrt(), weighted_sum(), HGCalRecHit_cfi::weights, FTLCluster::FTLHit::x(), and FTLCluster::FTLHit::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);
  }

float FTLCluster::weighted_sum ( const std::vector< float > &  weights, const std::function< float(unsigned int i)> &  sumFunc, const std::function< float(float, float)> &  outFunc  ) const

inlineprivate

Definition at line 223 of file FTLCluster.h.

References mps_fire::i.

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

float FTLCluster::x ( ) const

inline

Definition at line 121 of file FTLCluster.h.

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

Referenced by svgfig.Curve.Sample::__repr__(), svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), MTDThresholdClusterizer::clusterize(), MTDCPEBase::localError(), MTDCPEBase::localPosition(), geometryXMLparser.Alignable::pos(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), ntupleDataFormat._HitObject::r(), and ntupleDataFormat._HitObject::r3D().

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

float FTLCluster::y ( ) const

inline

Definition at line 126 of file FTLCluster.h.

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

Referenced by svgfig.Ellipse::__repr__(), Vispa.Gui.WidgetContainer.WidgetContainer::autosize(), Vispa.Gui.VispaWidget.VispaWidget::boundingRect(), MTDThresholdClusterizer::clusterize(), MTDCPEBase::localError(), MTDCPEBase::localPosition(), geometryXMLparser.Alignable::pos(), Vispa.Gui.ConnectableWidget.ConnectableWidget::positionizeMenuWidget(), ntupleDataFormat._HitObject::r(), and ntupleDataFormat._HitObject::r3D().

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

Member Data Documentation

float FTLCluster::err_time = -99999.9f

private

Definition at line 219 of file FTLCluster.h.

Referenced by getClusterErrorTime(), and setClusterErrorTime().

float FTLCluster::err_x = -99999.9f

private

Definition at line 217 of file FTLCluster.h.

Referenced by getClusterErrorX(), and setClusterErrorX().

float FTLCluster::err_y = -99999.9f

private

Definition at line 218 of file FTLCluster.h.

Referenced by getClusterErrorY(), and setClusterErrorY().

constexpr unsigned int FTLCluster::MAXPOS = 2047

static

Definition at line 74 of file FTLCluster.h.

constexpr unsigned int FTLCluster::MAXSPAN = 255

static

Definition at line 73 of file FTLCluster.h.

uint8_t FTLCluster::seed_

private

Definition at line 221 of file FTLCluster.h.

Referenced by FTLCluster(), and seed().

uint8_t FTLCluster::theHitColSpan = 0

private

Definition at line 215 of file FTLCluster.h.

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

std::vector<float> FTLCluster::theHitENERGY

private

Definition at line 208 of file FTLCluster.h.

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

std::vector<uint8_t> FTLCluster::theHitOffset

private

Definition at line 207 of file FTLCluster.h.

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

uint8_t FTLCluster::theHitRowSpan = 0

private

Definition at line 214 of file FTLCluster.h.

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

std::vector<float> FTLCluster::theHitTIME

private

Definition at line 209 of file FTLCluster.h.

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

std::vector<float> FTLCluster::theHitTIME_ERROR

private

Definition at line 210 of file FTLCluster.h.

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

DetId FTLCluster::theid

private

Definition at line 205 of file FTLCluster.h.

Referenced by id().

uint16_t FTLCluster::theMinHitCol = MAXPOS

private

Definition at line 213 of file FTLCluster.h.

Referenced by minHitCol(), and packCol().

uint16_t FTLCluster::theMinHitRow = MAXPOS

private

Definition at line 212 of file FTLCluster.h.

Referenced by minHitRow(), and packRow().