HGCUncalibratedRecHit Class Reference

#include <HGCUncalibratedRecHit.h>

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

Public Member Functions
float	amplitude () const
bool	checkFlag (Flags flag) const
float	chi2 () const
uint32_t	flags () const
	HGCUncalibratedRecHit ()
	HGCUncalibratedRecHit (const DetId &detId, float ampl, float ped, float jit, float chi2, uint32_t flags=0, uint32_t aux=0)
DetId	id () const
bool	isJitterErrorValid () const
bool	isJitterValid () const
bool	isSaturated () const
float	jitter () const
float	jitterError () const
uint8_t	jitterErrorBits () const
float	outOfTimeChi2 () const
float	outOfTimeEnergy () const
float	pedestal () const
void	setAmplitude (float amplitude)
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	setOutOfTimeChi2 (float chi2)
void	setOutOfTimeEnergy (float energy)
void	setPedestal (float pedestal)
virtual	~HGCUncalibratedRecHit ()

Private Attributes
float	amplitude_
uint32_t	aux_
float	chi2_
uint32_t	flags_
DetId	id_
float	jitter_
float	OOTamplitude_
float	OOTchi2_
float	pedestal_

Detailed Description

Definition at line 7 of file HGCUncalibratedRecHit.h.

Member Typedef Documentation

typedef DetId HGCUncalibratedRecHit::key_type

Definition at line 11 of file HGCUncalibratedRecHit.h.

Member Enumeration Documentation

enum HGCUncalibratedRecHit::Flags

Enumerator
kGood
kPoorReco
kSaturated
kOutOfTime

Definition at line 13 of file HGCUncalibratedRecHit.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
  };

Constructor & Destructor Documentation

HGCUncalibratedRecHit::HGCUncalibratedRecHit

(

)

Definition at line 4 of file HGCUncalibratedRecHit.cc.

                                             :
  amplitude_(0.), pedestal_(0.), jitter_(0.), chi2_(10000.), OOTamplitude_(0.), OOTchi2_(10000.), flags_(0), aux_(0) { }

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

Definition at line 7 of file HGCUncalibratedRecHit.cc.

                                                                              :
  amplitude_(ampl), pedestal_(ped), jitter_(jit), chi2_(chi2), OOTamplitude_(0.), OOTchi2_(10000.), flags_(flags), aux_(aux), id_(id) { }

HGCUncalibratedRecHit::~HGCUncalibratedRecHit ( )

virtual

Definition at line 11 of file HGCUncalibratedRecHit.cc.

                                              {
}

Member Function Documentation

float HGCUncalibratedRecHit::amplitude ( ) const

inline

Definition at line 25 of file HGCUncalibratedRecHit.h.

References amplitude_.

Referenced by HGCalRecHitSimpleAlgo::makeRecHit(), and setAmplitude().

{ return amplitude_; }

bool HGCUncalibratedRecHit::checkFlag

(

HGCUncalibratedRecHit::Flags

flag

)

const

Definition at line 102 of file HGCUncalibratedRecHit.cc.

References flags_, and kGood.

Referenced by isSaturated().

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

float HGCUncalibratedRecHit::chi2 ( void  ) const

inline

Definition at line 28 of file HGCUncalibratedRecHit.h.

References chi2_.

Referenced by setChi2(), and setOutOfTimeChi2().

{ return chi2_; }

uint32_t HGCUncalibratedRecHit::flags ( ) const

inline

Definition at line 32 of file HGCUncalibratedRecHit.h.

References flags_.

Referenced by setFlags().

{ return flags_; }

DetId HGCUncalibratedRecHit::id ( ) const

inline

Definition at line 35 of file HGCUncalibratedRecHit.h.

References id_.

Referenced by HGCalRecHitSimpleAlgo::makeRecHit(), HGCalRecHitWorkerSimple::run(), and setId().

{ return id_; }

bool HGCUncalibratedRecHit::isJitterErrorValid

(

)

const

Definition at line 75 of file HGCUncalibratedRecHit.cc.

References isJitterValid(), and jitterError().

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

bool HGCUncalibratedRecHit::isJitterValid

(

)

const

Definition at line 68 of file HGCUncalibratedRecHit.cc.

References jitterError().

Referenced by isJitterErrorValid().

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

bool HGCUncalibratedRecHit::isSaturated

(

)

const

Definition at line 14 of file HGCUncalibratedRecHit.cc.

References checkFlag(), and kSaturated.

                                              {
  return HGCUncalibratedRecHit::checkFlag(kSaturated);
}

float HGCUncalibratedRecHit::jitter ( ) const

inline

Definition at line 27 of file HGCUncalibratedRecHit.h.

References jitter_.

Referenced by HGCalRecHitSimpleAlgo::makeRecHit(), and setJitter().

{ return jitter_; }

float HGCUncalibratedRecHit::jitterError

(

)

const

Definition at line 19 of file HGCUncalibratedRecHit.cc.

References aux_, HLT_FULL_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)(pow(2.,exponent)*significand*LSB)/(25.*1000);
}

uint8_t HGCUncalibratedRecHit::jitterErrorBits

(

)

const

Definition at line 84 of file HGCUncalibratedRecHit.cc.

References aux_.

Referenced by jitterError(), and setJitterError().

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

float HGCUncalibratedRecHit::outOfTimeChi2 ( ) const

inline

Definition at line 30 of file HGCUncalibratedRecHit.h.

References OOTchi2_.

{ return OOTchi2_; }

float HGCUncalibratedRecHit::outOfTimeEnergy ( ) const

inline

Definition at line 29 of file HGCUncalibratedRecHit.h.

References OOTamplitude_.

{ return OOTamplitude_; }

float HGCUncalibratedRecHit::pedestal ( ) const

inline

Definition at line 26 of file HGCUncalibratedRecHit.h.

References pedestal_.

Referenced by setPedestal().

{ return pedestal_; }

void HGCUncalibratedRecHit::setAmplitude ( float  amplitude )

inline

Definition at line 37 of file HGCUncalibratedRecHit.h.

References amplitude(), and amplitude_.

{ amplitude_ = amplitude; }

void HGCUncalibratedRecHit::setAux ( uint32_t  aux )

inline

Definition at line 47 of file HGCUncalibratedRecHit.h.

References printConversionInfo::aux, and aux_.

{ aux_ = aux; }

void HGCUncalibratedRecHit::setChi2 ( float  chi2 )

inline

Definition at line 40 of file HGCUncalibratedRecHit.h.

References chi2(), and chi2_.

{ chi2_ = chi2; }

void HGCUncalibratedRecHit::setFlagBit

(

HGCUncalibratedRecHit::Flags

flag

)

Definition at line 90 of file HGCUncalibratedRecHit.cc.

References flags_, and kGood.

                                                                      {

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

void HGCUncalibratedRecHit::setFlags ( uint32_t  flags )

inline

Definition at line 45 of file HGCUncalibratedRecHit.h.

References flags(), and flags_.

Referenced by Vispa.Plugins.EdmBrowser.EventContentView.LabelItem::__init__().

{ flags_ = flags; }

void HGCUncalibratedRecHit::setId ( DetId  id )

inline

Definition at line 46 of file HGCUncalibratedRecHit.h.

References id(), and id_.

{ id_ = id; }

void HGCUncalibratedRecHit::setJitter ( float  jitter )

inline

Definition at line 39 of file HGCUncalibratedRecHit.h.

References jitter(), and jitter_.

{ jitter_ = jitter; }

void HGCUncalibratedRecHit::setJitterError

(

float

jitterErr

)

Definition at line 35 of file HGCUncalibratedRecHit.cc.

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

                                                            {
  // 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) ( lround( quantityInLSB / 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);

}

void HGCUncalibratedRecHit::setOutOfTimeChi2 ( float  chi2 )

inline

Definition at line 42 of file HGCUncalibratedRecHit.h.

References chi2(), and OOTchi2_.

{ OOTchi2_ = chi2; }

void HGCUncalibratedRecHit::setOutOfTimeEnergy ( float  energy )

inline

Definition at line 41 of file HGCUncalibratedRecHit.h.

References relval_parameters_module::energy, and OOTamplitude_.

{ OOTamplitude_ = energy; }

void HGCUncalibratedRecHit::setPedestal ( float  pedestal )

inline

Definition at line 38 of file HGCUncalibratedRecHit.h.

References pedestal(), and pedestal_.

{ pedestal_ = pedestal; }

Member Data Documentation

float HGCUncalibratedRecHit::amplitude_

private

Definition at line 56 of file HGCUncalibratedRecHit.h.

Referenced by amplitude(), and setAmplitude().

uint32_t HGCUncalibratedRecHit::aux_

private

Definition at line 63 of file HGCUncalibratedRecHit.h.

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

float HGCUncalibratedRecHit::chi2_

private

Definition at line 59 of file HGCUncalibratedRecHit.h.

Referenced by chi2(), and setChi2().

uint32_t HGCUncalibratedRecHit::flags_

private

Definition at line 62 of file HGCUncalibratedRecHit.h.

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

DetId HGCUncalibratedRecHit::id_

private

Definition at line 64 of file HGCUncalibratedRecHit.h.

Referenced by id(), and setId().

float HGCUncalibratedRecHit::jitter_

private

Definition at line 58 of file HGCUncalibratedRecHit.h.

Referenced by jitter(), and setJitter().

float HGCUncalibratedRecHit::OOTamplitude_

private

Definition at line 60 of file HGCUncalibratedRecHit.h.

Referenced by outOfTimeEnergy(), and setOutOfTimeEnergy().

float HGCUncalibratedRecHit::OOTchi2_

private

Definition at line 61 of file HGCUncalibratedRecHit.h.

Referenced by outOfTimeChi2(), and setOutOfTimeChi2().

float HGCUncalibratedRecHit::pedestal_

private

Definition at line 57 of file HGCUncalibratedRecHit.h.

Referenced by pedestal(), and setPedestal().