FTLRecHit Class Reference

#include <FTLRecHit.h>

Public Types
enum	Flags { kGood =0, kKilled, kUnknown }
typedef DetId	key_type

Public Member Functions
bool	checkFlag (int flag) const
	check if the flag is true More...
bool	checkFlags (const std::vector< int > &flagsvec) const
	check if one of the flags in a set is true More...
int	column () const
const DetId &	detid () const
float	energy () const
	get the id More...
	FTLRecHit ()
	FTLRecHit (const DetId &id, float energy, float time, float timeError, uint32_t flagBits=0)
	FTLRecHit (const DetId &id, uint8_t row, uint8_t column, float energy, float time, float timeError, uint32_t flagBits=0)
const DetId &	id () const
bool	isTimeErrorValid () const
bool	isTimeValid () const
const MTDDetId	mtdId () const
int	row () const
void	setEnergy (float energy)
void	setFlag (int flag)
	set the flags (from Flags or ESFlags) More...
void	setTime (float time)
void	setTimeError (float err)
float	time () const
float	timeError () const
void	unsetFlag (int flag)

Private Attributes
uint8_t	column_
float	energy_
unsigned char	flagBits_
	store rechit condition (see Flags enum) in a bit-wise way More...
DetId	id_
uint8_t	row_
float	time_
float	timeError_

Detailed Description

based on EcalRecHit

Author

Lindsey Gray

Definition at line 15 of file FTLRecHit.h.

Member Typedef Documentation

typedef DetId FTLRecHit::key_type

Definition at line 17 of file FTLRecHit.h.

Member Enumeration Documentation

enum FTLRecHit::Flags

Enumerator
kGood
kKilled
kUnknown

Definition at line 20 of file FTLRecHit.h.

               { 
          kGood=0,                   // channel ok, the energy and time measurement are reliable          
          kKilled,                   // MC only flag: the channel is killed in the real detector
          kUnknown                   // to ease the interface with functions returning flags. 
  };

Constructor & Destructor Documentation

FTLRecHit::FTLRecHit

(

)

bit structure of CaloRecHit::flags_ used in FTLRecHit:

| 32 | 31...25 | 24...12 | 11...5 | 4...1 | | | | | | | | | | +–> reco flags ( 4 bits) | | | +–> chi2 for in time events ( 7 bits) | | +–> energy for out-of-time events (13 bits) | +–> chi2 for out-of-time events ( 7 bits) +–> spare ( 1 bit )

Definition at line 11 of file FTLRecHit.cc.

                     : id_(DetId()), energy_(-1.f), time_(-1.f), timeError_(-1.f), row_(0), column_(0), flagBits_(std::numeric_limits<unsigned char>::max()) 
{}

FTLRecHit::FTLRecHit	(	const DetId &	id,
		float	energy,
		float	time,
		float	timeError,
		uint32_t	flagBits = 0
	)

Definition at line 14 of file FTLRecHit.cc.

                                                                                                  :
  id_(id), energy_(energy), time_(time), timeError_(timeError), row_(0), column_(0), flagBits_(flagBits) 
{}

FTLRecHit::FTLRecHit	(	const DetId &	id,
		uint8_t	row,
		uint8_t	column,
		float	energy,
		float	time,
		float	timeError,
		uint32_t	flagBits = 0
	)

Definition at line 18 of file FTLRecHit.cc.

                                                             :
  id_(id), energy_(energy), time_(time), timeError_(timeError), row_(row), column_(column), flagBits_(flagBits)
{}

Member Function Documentation

bool FTLRecHit::checkFlag ( int  flag ) const

inline

check if the flag is true

Definition at line 71 of file FTLRecHit.h.

References checkFlags(), RemoveAddSevLevel::flag, and flagBits_.

Referenced by checkFlags().

{return flagBits_ & ( 0x1<<flag);}

bool FTLRecHit::checkFlags

(

const std::vector< int > &

flagsvec

)

const

check if one of the flags in a set is true

Definition at line 40 of file FTLRecHit.cc.

References checkFlag().

Referenced by checkFlag().

                                                                 {
  
  for (std::vector<int>::const_iterator flagPtr = flagsvec.begin(); 
       flagPtr!= flagsvec.end(); ++flagPtr) { // check if one of the flags is up
    if (checkFlag(*flagPtr)) return true;    
  }
  return false;
}

int FTLRecHit::column ( ) const

inline

Definition at line 55 of file FTLRecHit.h.

References column_.

{ return column_; }

const DetId& FTLRecHit::detid ( ) const

inline

Definition at line 50 of file FTLRecHit.h.

References id().

Referenced by operator<(), and operator<<().

{ return id(); }

float FTLRecHit::energy ( ) const

inline

get the id

Definition at line 46 of file FTLRecHit.h.

References energy_.

Referenced by operator<(), operator<<(), Jet.Jet::rawEnergy(), and setEnergy().

{ return energy_; }

const DetId& FTLRecHit::id ( ) const

inline

Definition at line 49 of file FTLRecHit.h.

References id_.

Referenced by detid().

{ return id_; }

bool FTLRecHit::isTimeErrorValid

(

)

const

Definition at line 30 of file FTLRecHit.cc.

References isTimeValid(), and timeError().

Referenced by setTime().

                                       {
  if(!isTimeValid())
    return false;
  if(timeError() >= timereso_max)
    return false;
  
  return true;
}

bool FTLRecHit::isTimeValid

(

)

const

Definition at line 23 of file FTLRecHit.cc.

References timeError().

Referenced by isTimeErrorValid(), and setTime().

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

const MTDDetId FTLRecHit::mtdId ( ) const

inline

Definition at line 52 of file FTLRecHit.h.

References id_.

{ return MTDDetId(id_); }

int FTLRecHit::row ( ) const

inline

Definition at line 54 of file FTLRecHit.h.

References row_.

{ return row_; }

void FTLRecHit::setEnergy ( float  energy )

inline

Definition at line 47 of file FTLRecHit.h.

References energy(), and energy_.

{ energy_=energy; }

void FTLRecHit::setFlag ( int  flag )

inline

set the flags (from Flags or ESFlags)

Definition at line 67 of file FTLRecHit.h.

References RemoveAddSevLevel::flag, and flagBits_.

{flagBits_|= (0x1 << flag);}

void FTLRecHit::setTime ( float  time )

inline

Definition at line 58 of file FTLRecHit.h.

References isTimeErrorValid(), isTimeValid(), time(), and time_.

{ time_=time; }

void FTLRecHit::setTimeError ( float  err )

inline

Definition at line 64 of file FTLRecHit.h.

References timeError_.

{ timeError_ = err; }

float FTLRecHit::time ( ) const

inline

Definition at line 57 of file FTLRecHit.h.

References time_.

Referenced by operator<<(), and setTime().

{ return time_; }

float FTLRecHit::timeError ( ) const

inline

Definition at line 63 of file FTLRecHit.h.

References timeError_.

Referenced by isTimeErrorValid(), and isTimeValid().

{ return timeError_; }

void FTLRecHit::unsetFlag ( int  flag )

inline

Definition at line 68 of file FTLRecHit.h.

References RemoveAddSevLevel::flag, and flagBits_.

{flagBits_ &= ~(0x1 << flag);}

Member Data Documentation

uint8_t FTLRecHit::column_

private

Definition at line 81 of file FTLRecHit.h.

Referenced by column().

float FTLRecHit::energy_

private

Definition at line 80 of file FTLRecHit.h.

Referenced by energy(), and setEnergy().

unsigned char FTLRecHit::flagBits_

private

store rechit condition (see Flags enum) in a bit-wise way

Definition at line 84 of file FTLRecHit.h.

Referenced by checkFlag(), setFlag(), and unsetFlag().

DetId FTLRecHit::id_

private

Definition at line 79 of file FTLRecHit.h.

Referenced by id(), and mtdId().

uint8_t FTLRecHit::row_

private

Definition at line 81 of file FTLRecHit.h.

Referenced by row().

float FTLRecHit::time_

private

Definition at line 80 of file FTLRecHit.h.

Referenced by setTime(), and time().

float FTLRecHit::timeError_

private

Definition at line 80 of file FTLRecHit.h.

Referenced by setTimeError(), and timeError().