l1t::CaloCluster Class Reference

#include <CaloCluster.h>

Inheritance diagram for l1t::CaloCluster:

Public Types
enum	ClusterFlag {   INCLUDE_SEED = 0, INCLUDE_NW = 1, INCLUDE_N = 2, INCLUDE_NE = 3,   INCLUDE_E = 4, INCLUDE_SE = 5, INCLUDE_S = 6, INCLUDE_SW = 7,   INCLUDE_W = 8, INCLUDE_NN = 9, INCLUDE_SS = 10, TRIM_LEFT = 11,   IS_SECONDARY = 12, MERGE_UPDOWN = 13, MERGE_LEFTRIGHT = 14 }
Public Types inherited from reco::LeafCandidate
typedef int	Charge
	electric charge type More...
typedef CandidateCollection	daughters
	collection of daughter candidates More...
typedef unsigned int	index
typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...
typedef math::XYZPoint	Point
	point in the space More...
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...
typedef math::XYZVector	Vector
	point in the space More...
Public Types inherited from reco::Candidate
enum	{ dimension = 3 }
enum	{ size = dimension * (dimension + 1) / 2 }
	matix size More...
typedef int	Charge
	electric charge type More...
typedef candidate::const_iterator	const_iterator
typedef math::Error< dimension > ::type	CovarianceMatrix
	covariance error matrix (3x3) More...
typedef unsigned int	index
	index type More...
typedef candidate::iterator	iterator
typedef math::XYZTLorentzVector	LorentzVector
	Lorentz vector. More...
typedef math::XYZPoint	Point
	point in the space More...
typedef math::PtEtaPhiMLorentzVector	PolarLorentzVector
	Lorentz vector. More...
typedef size_t	size_type
typedef math::XYZVector	Vector
	point in the space More...

Public Member Functions
	CaloCluster ()
	CaloCluster (const LorentzVector p4, int pt=0, int eta=0, int phi=0)
bool	checkClusterFlag (ClusterFlag flag) const
int	clusterFlags () const
int	fgECAL () const
int	fgEta () const
int	fgPhi () const
int	hOverE () const
int	hwPtEm () const
int	hwPtHad () const
int	hwSeedPt () const
bool	isValid () const
bool	operator< (const CaloCluster &cl) const
bool	operator<= (const CaloCluster &cl) const
bool	operator> (const CaloCluster &cl) const
bool	operator>= (const CaloCluster &cl) const
void	setClusterFlag (ClusterFlag flag, bool val=true)
void	setFgECAL (int fgECAL)
void	setFgEta (int fgEta)
void	setFgPhi (int fgPhi)
void	setHOverE (int hOverE)
void	setHwPtEm (int pt)
void	setHwPtHad (int pt)
void	setHwSeedPt (int pt)
	~CaloCluster () override
Public Member Functions inherited from l1t::L1Candidate
int	hwEta () const
int	hwIso () const
int	hwPhi () const
int	hwPt () const
int	hwQual () const
	L1Candidate ()
	L1Candidate (const LorentzVector &p4, int pt=0, int eta=0, int phi=0, int qual=0, int iso=0)
	L1Candidate (const PolarLorentzVector &p4, int pt=0, int eta=0, int phi=0, int qual=0, int iso=0)
virtual bool	operator!= (const l1t::L1Candidate &rhs) const
virtual bool	operator== (const l1t::L1Candidate &rhs) const
void	setHwEta (int eta)
void	setHwIso (int iso)
void	setHwPhi (int phi)
void	setHwPt (int pt)
void	setHwQual (int qual)
	~L1Candidate () override
Public Member Functions inherited from reco::LeafCandidate
Vector	boostToCM () const final
int	charge () const final
	electric charge More...
LeafCandidate *	clone () const override
	returns a clone of the Candidate object More...
void	construct (int qx3, float pt, float eta, float phi, float mass, const Point &vtx, int pdgId, int status)
const Candidate *	daughter (size_type) const override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (size_type) override
	return daughter at a given position (throws an exception) More...
Candidate *	daughter (const std::string &s) override
	return daughter with a specified role name More...
const Candidate *	daughter (const std::string &s) const override
	return daughter with a specified role name More...
double	energy () const final
	energy More...
double	et () const final
	transverse energy More...
double	et2 () const final
	transverse energy squared (use this for cut!) More...
double	eta () const final
	momentum pseudorapidity More...
void	fillVertexCovariance (CovarianceMatrix &v) const override
	fill SMatrix More...
template<typename T >
T	get () const
	get a component More...
template<typename T , typename Tag >
T	get () const
	get a component More...
template<typename T >
T	get (size_type i) const
	get a component More...
template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...
bool	hasMasterClone () const override
bool	hasMasterClonePtr () const override
bool	isCaloMuon () const override
bool	isConvertedPhoton () const override
bool	isElectron () const override
bool	isGlobalMuon () const override
bool	isJet () const override
bool	isMuon () const override
bool	isPhoton () const override
bool	isStandAloneMuon () const override
bool	isTrackerMuon () const override
	LeafCandidate ()
	LeafCandidate (const Candidate &c)
template<typename... Args>
	LeafCandidate (Args &&...args)
	LeafCandidate (LeafCandidate &rh)
	LeafCandidate (LeafCandidate &&)=default
	LeafCandidate (LeafCandidate const &)=default
bool	longLived () const final
	is long lived? More...
double	mass () const final
	mass More...
bool	massConstraint () const final
	do mass constraint? More...
double	massSqr () const final
	mass squared More...
const CandidateBaseRef &	masterClone () const override
const CandidatePtr &	masterClonePtr () const override
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
Vector	momentum () const final
	spatial momentum vector More...
const Candidate *	mother (size_type) const override
	return mother at a given position (throws an exception) More...
double	mt () const final
	transverse mass More...
double	mtSqr () const final
	transverse mass squared More...
template<typename T >
size_type	numberOf () const
	number of components More...
template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...
size_t	numberOfDaughters () const override
	number of daughters More...
size_t	numberOfMothers () const override
	number of mothers More...
size_t	numberOfSourceCandidatePtrs () const override
LeafCandidate &	operator= (LeafCandidate &&)=default
LeafCandidate &	operator= (LeafCandidate const &)=default
double	p () const final
	magnitude of momentum vector More...
const LorentzVector &	p4 () const final
	four-momentum Lorentz vector More...
int	pdgId () const final
	PDG identifier. More...
double	phi () const final
	momentum azimuthal angle More...
const PolarLorentzVector &	polarP4 () const final
	four-momentum Lorentz vector More...
double	pt () const final
	transverse momentum More...
double	px () const final
	x coordinate of momentum vector More...
double	py () const final
	y coordinate of momentum vector More...
double	pz () const final
	z coordinate of momentum vector More...
double	rapidity () const final
	rapidity More...
void	setCharge (Charge q) final
	set electric charge More...
void	setLongLived () final
void	setMass (double m) final
	set particle mass More...
void	setMassConstraint () final
void	setP4 (const LorentzVector &p4) final
	set 4-momentum More...
void	setP4 (const PolarLorentzVector &p4) final
	set 4-momentum More...
void	setPdgId (int pdgId) final
void	setPz (double pz) final
void	setStatus (int status) final
	set status word More...
void	setThreeCharge (Charge qx3) final
	set electric charge More...
void	setVertex (const Point &vertex) override
	set vertex More...
CandidatePtr	sourceCandidatePtr (size_type i) const override
int	status () const final
	status word More...
double	theta () const final
	momentum polar angle More...
int	threeCharge () const final
	electric charge More...
const Point &	vertex () const override
	vertex position (overwritten by PF...) More...
double	vertexChi2 () const override
	chi-squares More...
double	vertexCovariance (int i, int j) const override
	(i, j)-th element of error matrix, i, j = 0, ... 2 More...
CovarianceMatrix	vertexCovariance () const final
	return SMatrix More...
double	vertexNdof () const override
double	vertexNormalizedChi2 () const override
	chi-squared divided by n.d.o.f. More...
double	vx () const override
	x coordinate of vertex position More...
double	vy () const override
	y coordinate of vertex position More...
double	vz () const override
	z coordinate of vertex position More...
double	y () const final
	rapidity More...
	~LeafCandidate () override
	destructor More...
Public Member Functions inherited from reco::Candidate
const_iterator	begin () const
	first daughter const_iterator More...
iterator	begin ()
	first daughter iterator More...
virtual const Track *	bestTrack () const
	Candidate ()
	default constructor More...
virtual float	dxyError () const
	uncertainty on dxy More...
virtual float	dzError () const
	uncertainty on dz More...
const_iterator	end () const
	last daughter const_iterator More...
iterator	end ()
	last daughter iterator More...
template<typename T >
T	get () const
	get a component More...
template<typename T , typename Tag >
T	get () const
	get a component More...
template<typename T >
T	get (size_type i) const
	get a component More...
template<typename T , typename Tag >
T	get (size_type i) const
	get a component More...
template<typename Ref >
Ref	masterRef () const
	cast master clone reference to a concrete type More...
template<typename T >
size_type	numberOf () const
	number of components More...
template<typename T , typename Tag >
size_type	numberOf () const
	number of components More...
virtual void	setSourceCandidatePtr (const CandidatePtr &ptr)
	Set the ptr to the source Candidate. More...
virtual	~Candidate ()
	destructor More...

Private Attributes
int	m_clusterFlags
int	m_fgECAL
int	m_fgEta
int	m_fgPhi
int	m_hOverE
int	m_hwPtEm
int	m_hwPtHad
int	m_hwSeedPt

Additional Inherited Members

Detailed Description

Definition at line 9 of file CaloCluster.h.

Member Enumeration Documentation

enum l1t::CaloCluster::ClusterFlag

Enumerator
INCLUDE_SEED
INCLUDE_NW
INCLUDE_N
INCLUDE_NE
INCLUDE_E
INCLUDE_SE
INCLUDE_S
INCLUDE_SW
INCLUDE_W
INCLUDE_NN
INCLUDE_SS
TRIM_LEFT
IS_SECONDARY
MERGE_UPDOWN
MERGE_LEFTRIGHT

Definition at line 11 of file CaloCluster.h.

                     {
      INCLUDE_SEED = 0,
      INCLUDE_NW = 1,
      INCLUDE_N = 2,
      INCLUDE_NE = 3,
      INCLUDE_E = 4,
      INCLUDE_SE = 5,
      INCLUDE_S = 6,
      INCLUDE_SW = 7,
      INCLUDE_W = 8,
      INCLUDE_NN = 9,
      INCLUDE_SS = 10,
      TRIM_LEFT = 11,
      IS_SECONDARY = 12,
      MERGE_UPDOWN = 13,    // 0=up, 1=down
      MERGE_LEFTRIGHT = 14  // 0=left, 1=right
    };

Constructor & Destructor Documentation

l1t::CaloCluster::CaloCluster ( )

inline

Definition at line 30 of file CaloCluster.h.

{}

l1t::CaloCluster::CaloCluster	(	const LorentzVector	p4,
		int	pt = 0,
		int	eta = 0,
		int	phi = 0
	)

Definition at line 4 of file CaloCluster.cc.

    : L1Candidate(p4, pt, eta, phi),
      m_clusterFlags(0x7FF)  // first 11 flags at 1
{}

l1t::CaloCluster::~CaloCluster ( )

override

Definition at line 9 of file CaloCluster.cc.

{}

Member Function Documentation

bool l1t::CaloCluster::checkClusterFlag

(

ClusterFlag

flag

)

const

Definition at line 33 of file CaloCluster.cc.

Referenced by l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::calibratedPt(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::idShape(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::isoCalEgHwFootPrint(), l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::processEvent(), l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::returnShape(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::trimCluster().

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

int l1t::CaloCluster::clusterFlags ( ) const

inline

Definition at line 53 of file CaloCluster.h.

References m_clusterFlags.

{ return m_clusterFlags; }

int l1t::CaloCluster::fgECAL

(

)

const

Definition at line 49 of file CaloCluster.cc.

{ return m_fgECAL; }

int l1t::CaloCluster::fgEta

(

)

const

Definition at line 43 of file CaloCluster.cc.

{ return m_fgEta; }

int l1t::CaloCluster::fgPhi

(

)

const

Definition at line 45 of file CaloCluster.cc.

{ return m_fgPhi; }

int l1t::CaloCluster::hOverE

(

)

const

Definition at line 47 of file CaloCluster.cc.

{ return m_hOverE; }

int l1t::CaloCluster::hwPtEm

(

)

const

Definition at line 37 of file CaloCluster.cc.

{ return m_hwPtEm; }

int l1t::CaloCluster::hwPtHad

(

)

const

Definition at line 39 of file CaloCluster.cc.

{ return m_hwPtHad; }

int l1t::CaloCluster::hwSeedPt

(

)

const

Definition at line 41 of file CaloCluster.cc.

{ return m_hwSeedPt; }

bool l1t::CaloCluster::isValid

(

void

)

const

Definition at line 35 of file CaloCluster.cc.

Referenced by ntupleDataFormat._Object::_checkIsValid(), and core.AutoHandle.AutoHandle::ReallyLoad().

{ return (checkClusterFlag(INCLUDE_SEED)); }

bool l1t::CaloCluster::operator<

(

const CaloCluster &

cl

)

const

Definition at line 51 of file CaloCluster.cc.

References funct::abs(), l1t::L1Candidate::hwEta(), l1t::L1Candidate::hwPhi(), and l1t::L1Candidate::hwPt().

                                                          {
  bool res = false;
  // Favour high pT
  if (hwPt() < cl.hwPt())
    res = true;
  else if (hwPt() == cl.hwPt()) {
    // Favour central clusters
    if (abs(hwEta()) > abs(cl.hwEta()))
      res = true;
    else if (abs(hwEta()) == abs(cl.hwEta())) {
      // Favour small phi (arbitrary)
      if (hwPhi() > cl.hwPhi())
        res = true;
    }
  }
  return res;
}

bool l1t::CaloCluster::operator<= ( const CaloCluster &  cl ) const

inline

Definition at line 57 of file CaloCluster.h.

{ return !(cl > *this); };

bool l1t::CaloCluster::operator> ( const CaloCluster &  cl ) const

inline

Definition at line 56 of file CaloCluster.h.

{ return cl < *this; };

bool l1t::CaloCluster::operator>= ( const CaloCluster &  cl ) const

inline

Definition at line 58 of file CaloCluster.h.

{ return !(cl < *this); };

void l1t::CaloCluster::setClusterFlag	(	ClusterFlag	flag,
		bool	val = true
	)

Definition at line 11 of file CaloCluster.cc.

Referenced by l1t::Stage2Layer2TauAlgorithmFirmwareImp1::merging(), and l1t::Stage2Layer2EGammaAlgorithmFirmwareImp1::trimCluster().

                                                              {
  if (val) {
    m_clusterFlags |= (0x1 << flag);
  } else {
    m_clusterFlags &= ~(0x1 << flag);
  }
};

void l1t::CaloCluster::setFgECAL

(

int

fgECAL

)

Definition at line 31 of file CaloCluster.cc.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

{ m_fgECAL = fgECAL; }

void l1t::CaloCluster::setFgEta

(

int

fgEta

)

Definition at line 25 of file CaloCluster.cc.

{ m_fgEta = fgEta; }

void l1t::CaloCluster::setFgPhi

(

int

fgPhi

)

Definition at line 27 of file CaloCluster.cc.

{ m_fgPhi = fgPhi; }

void l1t::CaloCluster::setHOverE

(

int

hOverE

)

Definition at line 29 of file CaloCluster.cc.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

{ m_hOverE = hOverE; }

void l1t::CaloCluster::setHwPtEm

(

int

pt

)

Definition at line 19 of file CaloCluster.cc.

References DiDispStaMuonMonitor_cfi::pt.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

{ m_hwPtEm = pt; }

void l1t::CaloCluster::setHwPtHad

(

int

pt

)

Definition at line 21 of file CaloCluster.cc.

References DiDispStaMuonMonitor_cfi::pt.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

{ m_hwPtHad = pt; }

void l1t::CaloCluster::setHwSeedPt

(

int

pt

)

Definition at line 23 of file CaloCluster.cc.

References DiDispStaMuonMonitor_cfi::pt.

Referenced by l1t::Stage2Layer2ClusterAlgorithmFirmwareImp1::clustering().

{ m_hwSeedPt = pt; }

Member Data Documentation

int l1t::CaloCluster::m_clusterFlags

private

Definition at line 58 of file CaloCluster.h.

Referenced by clusterFlags().

int l1t::CaloCluster::m_fgECAL

private

Definition at line 75 of file CaloCluster.h.

int l1t::CaloCluster::m_fgEta

private

Definition at line 70 of file CaloCluster.h.

int l1t::CaloCluster::m_fgPhi

private

Definition at line 71 of file CaloCluster.h.

int l1t::CaloCluster::m_hOverE

private

Definition at line 74 of file CaloCluster.h.

int l1t::CaloCluster::m_hwPtEm

private

Definition at line 65 of file CaloCluster.h.

int l1t::CaloCluster::m_hwPtHad

private

Definition at line 66 of file CaloCluster.h.

int l1t::CaloCluster::m_hwSeedPt

private

Definition at line 67 of file CaloCluster.h.