TICLCandidate Class Reference

#include <TICLCandidate.h>

Inheritance diagram for TICLCandidate:

Public Types
typedef ticl::Trackster::ParticleType	ParticleType
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
void	addTrackster (const edm::Ptr< ticl::Trackster > &trackster)
float	id_probability (ParticleType type) const
const std::array< float, 8 > &	idProbabilities () const
float	MTDtime () const
float	MTDtimeError () const
float	rawEnergy () const
void	setIdProbabilities (const std::array< float, 8 > &idProbs)
void	setIdProbability (ParticleType type, float value)
void	setMTDTime (float time, float timeError)
void	setRawEnergy (float rawEnergy)
void	setTime (float time, float timeError)
void	setTrackPtr (const edm::Ptr< reco::Track > &trackPtr)
void	setTracksters (const std::vector< edm::Ptr< ticl::Trackster > > &tracksters)
	TICLCandidate (Charge q, const LorentzVector &p4)
	TICLCandidate ()
	TICLCandidate (const edm::Ptr< ticl::Trackster > &trackster)
	TICLCandidate (const edm::Ptr< reco::Track > trackPtr, const edm::Ptr< ticl::Trackster > &tracksterPtr)
float	time () const
float	timeError () const
const edm::Ptr< reco::Track >	trackPtr () const
const std::vector< edm::Ptr< ticl::Trackster > >	tracksters () const
void	zeroProbabilities ()
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
std::array< float, 8 >	idProbabilities_
float	MTDtime_
float	MTDtimeError_
float	rawEnergy_
float	time_
float	timeError_
edm::Ptr< reco::Track >	trackPtr_
std::vector< edm::Ptr< ticl::Trackster > >	tracksters_

Additional Inherited Members

Detailed Description

Definition at line 16 of file TICLCandidate.h.

Member Typedef Documentation

ParticleType

typedef ticl::Trackster::ParticleType TICLCandidate::ParticleType

Definition at line 18 of file TICLCandidate.h.

Constructor & Destructor Documentation

TICLCandidate() [1/4]

TICLCandidate::TICLCandidate ( Charge  q, const LorentzVector &  p4  )

inline

Definition at line 20 of file TICLCandidate.h.

      : LeafCandidate(q, p4), idProbabilities_{}, time_(0.f), timeError_(-1.f), rawEnergy_(0.f) {}

TICLCandidate() [2/4]

TICLCandidate::TICLCandidate ( )

inline

Definition at line 23 of file TICLCandidate.h.

: LeafCandidate(), idProbabilities_{}, time_(0.f), timeError_(-1.f), rawEnergy_(0.f) {}

TICLCandidate() [3/4]

TICLCandidate::TICLCandidate ( const edm::Ptr< ticl::Trackster > &  trackster )

inline

Definition at line 25 of file TICLCandidate.h.

      : LeafCandidate(),
        tracksters_({trackster}),
        idProbabilities_{},
        time_(trackster->time()),
        timeError_(trackster->timeError()),
        MTDtime_{0.f},
        MTDtimeError_{-1.f},
        rawEnergy_(0.f) {}

TICLCandidate() [4/4]

TICLCandidate::TICLCandidate ( const edm::Ptr< reco::Track >  trackPtr, const edm::Ptr< ticl::Trackster > &  tracksterPtr  )

inline

Definition at line 35 of file TICLCandidate.h.

      : LeafCandidate(), tracksters_{}, trackPtr_(trackPtr), time_(0.f), timeError_(-1.f) {
    if (trackPtr_.isNull() and tracksterPtr.isNull())
      throw cms::Exception("NullPointerError")
          << "TICLCandidate constructor: at least one between track and trackster must be valid";

    if (tracksterPtr.isNonnull()) {
      tracksters_.push_back(tracksterPtr);
      auto const& trackster = tracksters_[0].get();
      idProbabilities_ = trackster->id_probabilities();
      if (trackPtr_.isNonnull()) {
        auto pdgId = trackster->isHadronic() ? 211 : 11;
        auto const& tk = trackPtr_.get();
        setPdgId(pdgId * tk->charge());
        setCharge(tk->charge());
        rawEnergy_ = trackster->raw_energy();
        auto const& regrE = trackster->regressed_energy();
        math::XYZTLorentzVector p4(regrE * tk->momentum().unit().x(),
                                   regrE * tk->momentum().unit().y(),
                                   regrE * tk->momentum().unit().z(),
                                   regrE);
        setP4(p4);

      } else {
        auto pdgId = trackster->isHadronic() ? 130 : 22;
        setPdgId(pdgId);
        setCharge(0);
        rawEnergy_ = trackster->raw_energy();
        const float& regrE = trackster->regressed_energy();
        math::XYZTLorentzVector p4(regrE * trackster->barycenter().unit().x(),
                                   regrE * trackster->barycenter().unit().y(),
                                   regrE * trackster->barycenter().unit().z(),
                                   regrE);
        setP4(p4);
      }
    } else {
      //candidate from track only
      auto const& tk = trackPtr_.get();
      setPdgId(211 * tk->charge());
      setCharge(tk->charge());
      const float energy = std::sqrt(tk->p() * tk->p() + ticl::mpion2);
      setRawEnergy(energy);
      math::PtEtaPhiMLorentzVector p4Polar(tk->pt(), tk->eta(), tk->phi(), ticl::mpion);
      setP4(p4Polar);
    }
  }

Member Function Documentation

addTrackster()

void TICLCandidate::addTrackster ( const edm::Ptr< ticl::Trackster > &  trackster )

inline

Definition at line 107 of file TICLCandidate.h.

References ticl::Trackster::time(), time_, ticl::Trackster::timeError(), timeError_, and tracksters_.

Referenced by ticl::LinkingAlgoByDirectionGeometric::linkTracksters(), and ticl::LinkingAlgoByDirectionGeometric::recordTrackster().

                                                            {
    tracksters_.push_back(trackster);
    time_ = trackster->time();
    timeError_ = trackster->timeError();
  }

id_probability()

float TICLCandidate::id_probability ( ParticleType  type ) const

inline

Definition at line 113 of file TICLCandidate.h.

References idProbabilities_, and createfilelist::int.

                                                       {
    // probabilities are stored in the same order as defined in the ParticleType enum
    return idProbabilities_[(int)type];
  }

idProbabilities()

const std::array<float, 8>& TICLCandidate::idProbabilities ( ) const

inline

Definition at line 118 of file TICLCandidate.h.

References idProbabilities_.

{ return idProbabilities_; }

MTDtime()

float TICLCandidate::MTDtime ( ) const

inline

Definition at line 90 of file TICLCandidate.h.

References MTDtime_.

{ return MTDtime_; }

MTDtimeError()

float TICLCandidate::MTDtimeError ( ) const

inline

Definition at line 91 of file TICLCandidate.h.

References MTDtimeError_.

{ return MTDtimeError_; }

rawEnergy()

float TICLCandidate::rawEnergy ( ) const

inline

Definition at line 101 of file TICLCandidate.h.

References rawEnergy_.

Referenced by Jet.Jet::chargedEmEnergyFraction(), Jet.Jet::chargedHadronEnergyFraction(), Jet.Jet::chargedMuEnergyFraction(), Jet.Jet::electronEnergyFraction(), Jet.Jet::HFEMEnergyFraction(), Jet.Jet::HFHadronEnergyFraction(), Jet.Jet::hoEnergyFraction(), Jet.Jet::jetID(), Jet.Jet::muonEnergyFraction(), Jet.Jet::neutralEmEnergyFraction(), Jet.Jet::neutralHadronEnergyFraction(), Jet.Jet::photonEnergyFraction(), and setRawEnergy().

{ return rawEnergy_; }

setIdProbabilities()

void TICLCandidate::setIdProbabilities ( const std::array< float, 8 > &  idProbs )

inline

Definition at line 126 of file TICLCandidate.h.

References idProbabilities_.

{ idProbabilities_ = idProbs; }

setIdProbability()

void TICLCandidate::setIdProbability ( ParticleType  type, float  value  )

inline

Definition at line 127 of file TICLCandidate.h.

References idProbabilities_, createfilelist::int, and relativeConstraints::value.

{ idProbabilities_[int(type)] = value; }

setMTDTime()

void TICLCandidate::setMTDTime ( float  time, float  timeError  )

inline

Definition at line 93 of file TICLCandidate.h.

References MTDtime_, MTDtimeError_, time(), and timeError().

                                               {
    MTDtime_ = time;
    MTDtimeError_ = timeError;
  };

setRawEnergy()

void TICLCandidate::setRawEnergy ( float  rawEnergy )

inline

Definition at line 102 of file TICLCandidate.h.

References rawEnergy(), and rawEnergy_.

{ rawEnergy_ = rawEnergy; }

setTime()

void TICLCandidate::setTime ( float  time, float  timeError  )

inline

Definition at line 85 of file TICLCandidate.h.

References time(), time_, timeError(), and timeError_.

                                            {
    time_ = time;
    timeError_ = timeError;
  };

setTrackPtr()

void TICLCandidate::setTrackPtr ( const edm::Ptr< reco::Track > &  trackPtr )

inline

Definition at line 99 of file TICLCandidate.h.

References trackPtr(), and trackPtr_.

Referenced by ticl::LinkingAlgoByDirectionGeometric::linkTracksters().

{ trackPtr_ = trackPtr; }

setTracksters()

void TICLCandidate::setTracksters ( const std::vector< edm::Ptr< ticl::Trackster > > &  tracksters )

inline

Definition at line 106 of file TICLCandidate.h.

References tracksters(), and tracksters_.

{ tracksters_ = tracksters; }

time()

float TICLCandidate::time ( ) const

inline

Definition at line 82 of file TICLCandidate.h.

References time_.

Referenced by setMTDTime(), and setTime().

{ return time_; }

timeError()

float TICLCandidate::timeError ( ) const

inline

Definition at line 83 of file TICLCandidate.h.

References timeError_.

Referenced by setMTDTime(), and setTime().

{ return timeError_; }

trackPtr()

const edm::Ptr<reco::Track> TICLCandidate::trackPtr ( ) const

inline

Definition at line 98 of file TICLCandidate.h.

References trackPtr_.

Referenced by setTrackPtr().

{ return trackPtr_; }

tracksters()

const std::vector<edm::Ptr<ticl::Trackster> > TICLCandidate::tracksters ( ) const

inline

Definition at line 104 of file TICLCandidate.h.

References tracksters_.

Referenced by ticl::LinkingAlgoByDirectionGeometric::linkTracksters(), and setTracksters().

{ return tracksters_; };

zeroProbabilities()

void TICLCandidate::zeroProbabilities ( )

inline

Definition at line 120 of file TICLCandidate.h.

References idProbabilities_, and reco::LeafCandidate::p().

                           {
    for (auto& p : idProbabilities_) {
      p = 0.f;
    }
  }

Member Data Documentation

idProbabilities_

std::array<float, 8> TICLCandidate::idProbabilities_

private

Definition at line 135 of file TICLCandidate.h.

Referenced by id_probability(), idProbabilities(), setIdProbabilities(), setIdProbability(), and zeroProbabilities().

MTDtime_

float TICLCandidate::MTDtime_

private

Definition at line 139 of file TICLCandidate.h.

Referenced by MTDtime(), and setMTDTime().

MTDtimeError_

float TICLCandidate::MTDtimeError_

private

Definition at line 140 of file TICLCandidate.h.

Referenced by MTDtimeError(), and setMTDTime().

rawEnergy_

float TICLCandidate::rawEnergy_

private

Definition at line 141 of file TICLCandidate.h.

Referenced by rawEnergy(), and setRawEnergy().

time_

float TICLCandidate::time_

private

Definition at line 137 of file TICLCandidate.h.

Referenced by addTrackster(), setTime(), and time().

timeError_

float TICLCandidate::timeError_

private

Definition at line 138 of file TICLCandidate.h.

Referenced by addTrackster(), setTime(), and timeError().

trackPtr_

edm::Ptr<reco::Track> TICLCandidate::trackPtr_

private

Definition at line 133 of file TICLCandidate.h.

Referenced by setTrackPtr(), and trackPtr().

tracksters_

std::vector<edm::Ptr<ticl::Trackster> > TICLCandidate::tracksters_

private

Definition at line 132 of file TICLCandidate.h.

Referenced by addTrackster(), setTracksters(), and tracksters().