EcalUncalibratedRecHit Class Reference

#include <EcalUncalibratedRecHit.h>

Public Types
enum	Flags {   kGood = -1, kPoorReco, kSaturated, kOutOfTime,   kLeadingEdgeRecovered, kHasSwitchToGain6, kHasSwitchToGain1 }
typedef DetId	key_type

Public Member Functions
float	amplitude () const
float	amplitudeError () const
bool	checkFlag (Flags flag) const
float	chi2 () const
	EcalUncalibratedRecHit ()
	EcalUncalibratedRecHit (const DetId &id, float ampl, float ped, float jit, float chi2, uint32_t flags=0, uint32_t aux=0)
uint32_t	flags () const
DetId	id () const
bool	isJitterErrorValid () const
bool	isJitterValid () const
bool	isSaturated () const
float	jitter () const
float	jitterError () const
uint8_t	jitterErrorBits () const
float	outOfTimeAmplitude (int bx) const
float	pedestal () const
void	setAmplitude (float amplitude)
void	setAmplitudeError (float amplitudeerror)
void	setAux (uint32_t aux)
void	setChi2 (float chi2)
void	setFlagBit (Flags flag)
void	setFlags (uint32_t flags)
void	setId (DetId id)
void	setJitter (float jitter)
void	setJitterError (float jitterErr)
void	setOutOfTimeAmplitude (int bx, float amplitude)
void	setPedestal (float pedestal)

Private Attributes
float	amplitude_
float	amplitudeError_
uint32_t	aux_
float	chi2_
uint32_t	flags_
DetId	id_
float	jitter_
float	OOTamplitudes_ [EcalDataFrame::MAXSAMPLES]
float	OOTchi2_
float	pedestal_

Detailed Description

Definition at line 8 of file EcalUncalibratedRecHit.h.

Member Typedef Documentation

key_type

typedef DetId EcalUncalibratedRecHit::key_type

Definition at line 10 of file EcalUncalibratedRecHit.h.

Member Enumeration Documentation

Flags

enum EcalUncalibratedRecHit::Flags

Enumerator
kGood
kPoorReco
kSaturated
kOutOfTime
kLeadingEdgeRecovered
kHasSwitchToGain6
kHasSwitchToGain1

Definition at line 12 of file EcalUncalibratedRecHit.h.

             {
    kGood = -1,  // channel is good (mutually exclusive with other states)  setFlagBit(kGood) reset flags_ to zero
    kPoorReco,   // channel has been badly reconstructed (e.g. bad shape, bad chi2 etc.)
    kSaturated,  // saturated channel
    kOutOfTime,  // channel out of time
    kLeadingEdgeRecovered,  // saturated channel: energy estimated from the leading edge before saturation
    kHasSwitchToGain6,      // at least one data frame is in G6
    kHasSwitchToGain1       // at least one data frame is in G1

  };

Constructor & Destructor Documentation

EcalUncalibratedRecHit() [1/2]

EcalUncalibratedRecHit::EcalUncalibratedRecHit

(

)

Definition at line 5 of file EcalUncalibratedRecHit.cc.

References EcalDataFrame::MAXSAMPLES, and OOTamplitudes_.

    : amplitude_(0.), amplitudeError_(0.), pedestal_(0.), jitter_(0.), chi2_(10000.), flags_(0), aux_(0) {
  const unsigned int nsample = EcalDataFrame::MAXSAMPLES;
  for (unsigned int ibx = 0; ibx < nsample; ++ibx)
    OOTamplitudes_[ibx] = 0.;
}

EcalUncalibratedRecHit() [2/2]

EcalUncalibratedRecHit::EcalUncalibratedRecHit	(	const DetId &	id,
		float	ampl,
		float	ped,
		float	jit,
		float	chi2,
		uint32_t	flags = 0,
		uint32_t	aux = 0
	)

Definition at line 12 of file EcalUncalibratedRecHit.cc.

References EcalDataFrame::MAXSAMPLES, and OOTamplitudes_.

    : amplitude_(ampl),
      amplitudeError_(0.),
      pedestal_(ped),
      jitter_(jit),
      chi2_(chi2),
      flags_(flags),
      aux_(aux),
      id_(id) {
  const unsigned int nsample = EcalDataFrame::MAXSAMPLES;
  for (unsigned int ibx = 0; ibx < nsample; ++ibx)
    OOTamplitudes_[ibx] = 0.;
}

Member Function Documentation

amplitude()

float EcalUncalibratedRecHit::amplitude ( ) const

inline

Definition at line 28 of file EcalUncalibratedRecHit.h.

References amplitude_.

Referenced by CosmicClusterAlgo::makeCluster(), CosmicClusterAlgo::makeClusters(), EcalRecHitSimpleAlgo::makeRecHit(), EcalTBWeightUncalibRecHitProducer::produce(), EcalUncalibRecHitWorkerAnalFit::run(), EcalUncalibRecHitWorkerGlobal::run(), setAmplitude(), and setOutOfTimeAmplitude().

{ return amplitude_; }

amplitudeError()

float EcalUncalibratedRecHit::amplitudeError ( ) const

inline

Definition at line 29 of file EcalUncalibratedRecHit.h.

References amplitudeError_.

Referenced by EcalRecHitSimpleAlgo::makeRecHit().

{ return amplitudeError_; }

checkFlag()

bool EcalUncalibratedRecHit::checkFlag

(

EcalUncalibratedRecHit::Flags

flag

)

const

Definition at line 109 of file EcalUncalibratedRecHit.cc.

References RemoveAddSevLevel::flag, flags_, and kGood.

Referenced by isSaturated(), and EcalRecHitSimpleAlgo::makeRecHit().

                                                                             {
  if (flag == kGood) {
    if (!flags_)
      return true;
    else
      return false;
  }  // if all flags are unset, then hit is good
  return flags_ & (0x1 << flag);
}

chi2()

float EcalUncalibratedRecHit::chi2 ( void  ) const

inline

Definition at line 32 of file EcalUncalibratedRecHit.h.

References chi2_.

Referenced by EcalRecHitSimpleAlgo::makeRecHit(), and setChi2().

{ return chi2_; }

flags()

uint32_t EcalUncalibratedRecHit::flags ( ) const

inline

Definition at line 35 of file EcalUncalibratedRecHit.h.

References flags_.

Referenced by EcalRecHitWorkerRecover::run(), and setFlags().

{ return flags_; }

id()

DetId EcalUncalibratedRecHit::id ( ) const

inline

Definition at line 38 of file EcalUncalibratedRecHit.h.

References id_.

Referenced by CosmicClusterAlgo::makeCluster(), EcalRecHitSimpleAlgo::makeRecHit(), EcalRecHitWorkerSimple::run(), EcalRecHitWorkerRecover::run(), and setId().

{ return id_; }

isJitterErrorValid()

bool EcalUncalibratedRecHit::isJitterErrorValid

(

)

const

Definition at line 85 of file EcalUncalibratedRecHit.cc.

References isJitterValid(), and jitterError().

                                                      {
  if (!isJitterValid())
    return false;
  if (jitterError() >= 10000)
    return false;

  return true;
}

isJitterValid()

bool EcalUncalibratedRecHit::isJitterValid

(

)

const

Definition at line 78 of file EcalUncalibratedRecHit.cc.

References jitterError().

Referenced by isJitterErrorValid().

                                                 {
  if (jitterError() <= 0)
    return false;
  else
    return true;
}

isSaturated()

bool EcalUncalibratedRecHit::isSaturated

(

)

const

Definition at line 27 of file EcalUncalibratedRecHit.cc.

References checkFlag(), and kSaturated.

Referenced by EcalRecHitSimpleAlgo::makeRecHit().

{ return EcalUncalibratedRecHit::checkFlag(kSaturated); }

jitter()

float EcalUncalibratedRecHit::jitter ( ) const

inline

Definition at line 31 of file EcalUncalibratedRecHit.h.

References jitter_.

Referenced by EcalRecHitSimpleAlgo::makeRecHit(), EcalUncalibRecHitWorkerGlobal::run(), and setJitter().

{ return jitter_; }

jitterError()

float EcalUncalibratedRecHit::jitterError

(

)

const

Definition at line 29 of file EcalUncalibratedRecHit.cc.

References aux_, HLT_2022v11_cff::exponent, jitterErrorBits(), and funct::pow().

Referenced by isJitterErrorValid(), and isJitterValid().

                                                {
  // stored in ps, but return BXs to match with jitter units
  uint32_t jitterErrorBits = 0xFF & aux_;
  // all bits off --> time reco bailed out (return negative value)
  if ((0xFF & jitterErrorBits) == 0x00)
    return -1;
  // all bits on  --> time error over 5 ns (return large value)
  if ((0xFF & jitterErrorBits) == 0xFF)
    return 10000;

  float LSB = 1.26008;
  uint8_t exponent = jitterErrorBits >> 5;
  uint8_t significand = jitterErrorBits & ~(0x7 << 5);
  return (float)(std::pow(2, exponent) * significand * LSB) / (25. * 1000);
}

jitterErrorBits()

uint8_t EcalUncalibratedRecHit::jitterErrorBits

(

)

const

Definition at line 94 of file EcalUncalibratedRecHit.cc.

References aux_.

Referenced by jitterError(), EcalRecHitSimpleAlgo::makeRecHit(), and setJitterError().

                                                      {
  uint8_t jitterErrorBits = 0xFF & aux_;
  return jitterErrorBits;
}

outOfTimeAmplitude()

float EcalUncalibratedRecHit::outOfTimeAmplitude ( int  bx ) const

inline

Definition at line 33 of file EcalUncalibratedRecHit.h.

References simKBmtfDigis_cfi::bx, and OOTamplitudes_.

{ return OOTamplitudes_[bx]; }

pedestal()

float EcalUncalibratedRecHit::pedestal ( ) const

inline

Definition at line 30 of file EcalUncalibratedRecHit.h.

References pedestal_.

Referenced by setPedestal().

{ return pedestal_; }

setAmplitude()

void EcalUncalibratedRecHit::setAmplitude ( float  amplitude )

inline

Definition at line 40 of file EcalUncalibratedRecHit.h.

References amplitude(), and amplitude_.

Referenced by EcalUncalibRecHitWorkerRatio::run().

{ amplitude_ = amplitude; }

setAmplitudeError()

void EcalUncalibratedRecHit::setAmplitudeError ( float  amplitudeerror )

inline

Definition at line 41 of file EcalUncalibratedRecHit.h.

References amplitudeError_.

Referenced by EcalUncalibRecHitMultiFitAlgo::makeRecHit(), and EcalUncalibRecHitPhase2WeightsProducer::produce().

{ amplitudeError_ = amplitudeerror; }

setAux()

void EcalUncalibratedRecHit::setAux ( uint32_t  aux )

inline

Definition at line 50 of file EcalUncalibratedRecHit.h.

References printConversionInfo::aux, and aux_.

{ aux_ = aux; }

setChi2()

void EcalUncalibratedRecHit::setChi2 ( float  chi2 )

inline

Definition at line 44 of file EcalUncalibratedRecHit.h.

References chi2(), and chi2_.

Referenced by EcalUncalibRecHitWorkerGlobal::run().

{ chi2_ = chi2; }

setFlagBit()

void EcalUncalibratedRecHit::setFlagBit

(

EcalUncalibratedRecHit::Flags

flag

)

Definition at line 99 of file EcalUncalibratedRecHit.cc.

References RemoveAddSevLevel::flag, flags_, and kGood.

Referenced by EcalUncalibRecHitPhase2WeightsProducer::produce(), EcalUncalibRecHitWorkerWeights::run(), and EcalUncalibRecHitWorkerGlobal::run().

                                                                        {
  if (flag == kGood) {
    //then set all bits to zero;
    flags_ = 0;
    return;
  }
  // else set the flagbit
  flags_ |= 0x1 << flag;
}

setFlags()

void EcalUncalibratedRecHit::setFlags ( uint32_t  flags )

inline

Definition at line 48 of file EcalUncalibratedRecHit.h.

References flags(), and flags_.

{ flags_ = flags; }

setId()

void EcalUncalibratedRecHit::setId ( DetId  id )

inline

Definition at line 49 of file EcalUncalibratedRecHit.h.

References id(), and id_.

{ id_ = id; }

setJitter()

void EcalUncalibratedRecHit::setJitter ( float  jitter )

inline

Definition at line 43 of file EcalUncalibratedRecHit.h.

References jitter(), and jitter_.

Referenced by EcalUncalibRecHitWorkerRatio::run(), and EcalUncalibRecHitWorkerGlobal::run().

{ jitter_ = jitter; }

setJitterError()

void EcalUncalibratedRecHit::setJitterError

(

float

jitterErr

)

Definition at line 45 of file EcalUncalibratedRecHit.cc.

References aux_, HLT_2022v11_cff::exponent, createfilelist::int, jitterErrorBits(), and funct::pow().

Referenced by EcalUncalibRecHitPhase2WeightsProducer::produce(), EcalUncalibRecHitWorkerRatio::run(), and EcalUncalibRecHitWorkerGlobal::run().

                                                           {
  // use 8 bits (3 exp, 5 mant) and store in ps
  // has range of 5 ps - 5000 ps
  // expect input in BX units
  // all bits off --> time reco bailed out
  if (jitterErr <= 0) {
    aux_ = (~0xFF & aux_);
    return;
  }
  // all bits on  --> time error over 5 ns
  if (25 * jitterErr >= 5) {
    aux_ = (0xFF | aux_);
    return;
  }

  float LSB = 1.26008;
  float quantityInLSB = (1000 * 25 * jitterErr) / LSB;
  int log2OfQuantity = (int)(log2(quantityInLSB));
  int exponentTmp = log2OfQuantity - 4;
  uint8_t exponent = 0;
  if (exponentTmp > 0)
    exponent = exponentTmp;
  uint8_t significand = (int)(std::lround(quantityInLSB / std::pow(2, exponent)));
  uint32_t jitterErrorBits = exponent << 5 | significand;

  if ((0xFF & jitterErrorBits) == 0xFF)
    jitterErrorBits = 0xFE;
  if ((0xFF & jitterErrorBits) == 0x00)
    jitterErrorBits = 0x01;

  aux_ = (~0xFF & aux_) | (jitterErrorBits & 0xFF);
}

setOutOfTimeAmplitude()

void EcalUncalibratedRecHit::setOutOfTimeAmplitude ( int  bx, float  amplitude  )

inline

Definition at line 45 of file EcalUncalibratedRecHit.h.

References amplitude(), simKBmtfDigis_cfi::bx, and OOTamplitudes_.

{ OOTamplitudes_[bx] = amplitude; }

setPedestal()

void EcalUncalibratedRecHit::setPedestal ( float  pedestal )

inline

Definition at line 42 of file EcalUncalibratedRecHit.h.

References pedestal(), and pedestal_.

{ pedestal_ = pedestal; }

Member Data Documentation

amplitude_

float EcalUncalibratedRecHit::amplitude_

private

Definition at line 59 of file EcalUncalibratedRecHit.h.

Referenced by amplitude(), and setAmplitude().

amplitudeError_

float EcalUncalibratedRecHit::amplitudeError_

private

Definition at line 60 of file EcalUncalibratedRecHit.h.

Referenced by amplitudeError(), and setAmplitudeError().

aux_

uint32_t EcalUncalibratedRecHit::aux_

private

Definition at line 68 of file EcalUncalibratedRecHit.h.

Referenced by jitterError(), jitterErrorBits(), setAux(), and setJitterError().

chi2_

float EcalUncalibratedRecHit::chi2_

private

Definition at line 63 of file EcalUncalibratedRecHit.h.

Referenced by chi2(), and setChi2().

flags_

uint32_t EcalUncalibratedRecHit::flags_

private

Definition at line 67 of file EcalUncalibratedRecHit.h.

Referenced by checkFlag(), flags(), setFlagBit(), and setFlags().

id_

DetId EcalUncalibratedRecHit::id_

private

Definition at line 69 of file EcalUncalibratedRecHit.h.

Referenced by id(), and setId().

jitter_

float EcalUncalibratedRecHit::jitter_

private

Definition at line 62 of file EcalUncalibratedRecHit.h.

Referenced by jitter(), and setJitter().

OOTamplitudes_

float EcalUncalibratedRecHit::OOTamplitudes_[EcalDataFrame::MAXSAMPLES]

private

Definition at line 65 of file EcalUncalibratedRecHit.h.

Referenced by EcalUncalibratedRecHit(), outOfTimeAmplitude(), and setOutOfTimeAmplitude().

OOTchi2_

float EcalUncalibratedRecHit::OOTchi2_

private

Definition at line 66 of file EcalUncalibratedRecHit.h.

pedestal_

float EcalUncalibratedRecHit::pedestal_

private

Definition at line 61 of file EcalUncalibratedRecHit.h.

Referenced by pedestal(), and setPedestal().