reco::PFBlockElement Class Reference

Abstract base class for a PFBlock element (track, cluster...) More...

#include <PFBlockElement.h>

Inheritance diagram for reco::PFBlockElement:

Public Types
enum	TrackType {   DEFAULT = 0, T_FROM_DISP, T_TO_DISP, T_FROM_GAMMACONV,   MUON, T_FROM_V0 }
enum	Type {   NONE = 0, TRACK = 1, PS1 = 2, PS2 = 3,   ECAL = 4, HCAL = 5, GSF = 6, BREM = 7,   HFEM = 8, HFHAD = 9, SC = 10, HO = 11,   HGCAL = 12, kNBETypes = 13 }

Public Member Functions
virtual PFBlockElement *	clone () const =0
	necessary to have the edm::OwnVector<PFBlockElement> working More...
virtual const PFClusterRef &	clusterRef () const
virtual const ConversionRefVector &	convRefs () const
virtual const PFDisplacedTrackerVertexRef &	displacedVertexRef (TrackType trType) const
virtual void	Dump (std::ostream &out=std::cout, const char *tab=" ") const
	print the object inside the element More...
const PFMultilinksType &	getMultilinks (Type type) const
unsigned	index () const
virtual bool	isLinkedToDisplacedVertex () const
bool	isMultilinksValide (Type type) const
virtual bool	isPrimary () const
virtual bool	isSecondary () const
bool	isTimeValid () const
	do we have a valid time information More...
void	lock ()
	lock element More...
bool	locked () const
	locked ? More...
virtual const MuonRef &	muonRef () const
	PFBlockElement (Type type=NONE)
	standard constructor More...
virtual void	setConversionRef (const ConversionRef &convRef, TrackType trType)
virtual void	setDisplacedVertexRef (const PFDisplacedTrackerVertexRef &niref, TrackType trType)
void	setIndex (unsigned index)
	set index More...
void	setIsValidMultilinks (bool isVal, Type type)
void	setMultilinks (const PFMultiLinksTC &ml, Type type)
virtual void	setMuonRef (const MuonRef &muref)
void	setTime (float time, float timeError=0.f)
	the timing information More...
virtual void	setTrackType (TrackType trType, bool value)
	the trackType More...
virtual void	setV0Ref (const VertexCompositeCandidateRef &v0ref, TrackType trType)
float	time () const
float	timeError () const
virtual const reco::TrackRef &	trackRef () const
virtual const PFRecTrackRef &	trackRefPF () const
virtual bool	trackType (TrackType trType) const
Type	type () const
void	unLock ()
	unlock element More...
virtual const VertexCompositeCandidateRef &	V0Ref () const
virtual	~PFBlockElement ()
	destructor More...

Protected Attributes
unsigned	index_
	index in block vector More...
bool	locked_
std::map< reco::PFBlockElement::Type, PFMultiLinksTC >	multilinks_
float	time_
	timing information (valid if timeError_ >= 0) More...
float	timeError_
	timing information uncertainty (<0 if timing not available) More...
Type	type_

Static Protected Attributes
static const ConversionRefVector	nullConv_ = reco::ConversionRefVector()
static const MuonRef	nullMuon_ = reco::MuonRef()
static const PFClusterRef	nullPFCluster_ = reco::PFClusterRef()
static const PFDisplacedTrackerVertexRef	nullPFDispVertex_ = reco::PFDisplacedTrackerVertexRef()
static const PFRecTrackRef	nullPFRecTrack_ = reco::PFRecTrackRef()
static const reco::TrackRef	nullTrack_ = reco::TrackRef()
static const VertexCompositeCandidateRef	nullVertex_ = reco::VertexCompositeCandidateRef()

Detailed Description

Abstract base class for a PFBlock element (track, cluster...)

this class contains a PFRecTrackRef of a PFClusterRef, depending on the type of the element

Definition at line 26 of file PFBlockElement.h.

Member Enumeration Documentation

TrackType

enum reco::PFBlockElement::TrackType

Enumerator
DEFAULT
T_FROM_DISP
T_TO_DISP
T_FROM_GAMMACONV
MUON
T_FROM_V0

Definition at line 47 of file PFBlockElement.h.

{ DEFAULT = 0, T_FROM_DISP, T_TO_DISP, T_FROM_GAMMACONV, MUON, T_FROM_V0 };

Type

enum reco::PFBlockElement::Type

possible types for the element do not modify this enum if you don't know what you're doing!!!

Enumerator
NONE
TRACK
PS1
PS2
ECAL
HCAL
GSF
BREM
HFEM
HFHAD
SC
HO
HGCAL
kNBETypes

Definition at line 30 of file PFBlockElement.h.

              {
      NONE = 0,
      TRACK = 1,
      PS1 = 2,
      PS2 = 3,
      ECAL = 4,
      HCAL = 5,
      GSF = 6,
      BREM = 7,
      HFEM = 8,
      HFHAD = 9,
      SC = 10,
      HO = 11,
      HGCAL = 12,
      kNBETypes = 13
    };

Constructor & Destructor Documentation

PFBlockElement()

reco::PFBlockElement::PFBlockElement ( Type  type = NONE )

inline

standard constructor

Definition at line 50 of file PFBlockElement.h.

        : type_(type), locked_(false), index_(static_cast<unsigned>(-1)), time_(0.f), timeError_(-1.f) {}

~PFBlockElement()

virtual reco::PFBlockElement::~PFBlockElement ( )

inlinevirtual

destructor

Definition at line 54 of file PFBlockElement.h.

{}

Member Function Documentation

clone()

virtual PFBlockElement* reco::PFBlockElement::clone ( ) const

pure virtual

necessary to have the edm::OwnVector<PFBlockElement> working

Implemented in reco::PFBlockElementSuperCluster, reco::PFBlockElementBrem, reco::PFBlockElementCluster, reco::PFBlockElementGsfTrack, and reco::PFBlockElementTrack.

Referenced by reco::PFBlock::addElement().

clusterRef()

virtual const PFClusterRef& reco::PFBlockElement::clusterRef ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementCluster.

Definition at line 90 of file PFBlockElement.h.

References nullPFCluster_.

Referenced by PFElectronTranslator::createBasicCluster(), PFPhotonTranslator::createBasicCluster(), PFElectronTranslator::createPreshowerCluster(), PFPhotonTranslator::createPreshowerCluster(), PFBlockBasedIsolation::getHighestEtECALCluster(), KDTreeLinkerPSEcal::insertFieldClusterElt(), KDTreeLinkerTrackEcal::insertFieldClusterElt(), KDTreeLinkerTrackHcal::insertFieldClusterElt(), and FWPFBlockProxyBuilder::setupClusterElement().

{ return nullPFCluster_; }

convRefs()

virtual const ConversionRefVector& reco::PFBlockElement::convRefs ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 92 of file PFBlockElement.h.

References nullConv_.

Referenced by TrackAndTrackLinker::testLink().

{ return nullConv_; }

displacedVertexRef()

virtual const PFDisplacedTrackerVertexRef& reco::PFBlockElement::displacedVertexRef ( TrackType  trType ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 91 of file PFBlockElement.h.

References nullPFDispVertex_.

Referenced by TrackAndTrackLinker::testLink().

{ return nullPFDispVertex_; }

Dump()

void PFBlockElement::Dump ( std::ostream &  out = std::cout, const char *  tab = " "  ) const

virtual

print the object inside the element

Reimplemented in reco::PFBlockElementSuperCluster, reco::PFBlockElementCluster, reco::PFBlockElementGsfTrack, reco::PFBlockElementBrem, and reco::PFBlockElementTrack.

Definition at line 24 of file PFBlockElement.cc.

References MillePedeFileConverter_cfg::out.

                                                                {
  if (!out)
    return;
  out << pad << "base element";
}

getMultilinks()

const PFMultilinksType& reco::PFBlockElement::getMultilinks ( Type  type ) const

inline

Definition at line 124 of file PFBlockElement.h.

References multilinks_.

Referenced by PreshowerAndECALLinker::linkPrefilter(), TrackAndECALLinker::linkPrefilter(), TrackAndHCALLinker::linkPrefilter(), TrackAndECALLinker::testLink(), and TrackAndHCALLinker::testLink().

{ return multilinks_.at(type).linkedPFObjects; }

index()

unsigned reco::PFBlockElement::index ( ) const

inline

Returns

index

Definition at line 86 of file PFBlockElement.h.

References index_.

Referenced by reco::PFCandidateEGammaExtra::addExtraNonConvTrack(), PFPhotonTranslator::correspondingDaughterCandidate(), PFElectronTranslator::correspondingDaughterCandidate(), PFEGammaAlgo::fillPFCandidates(), PFEGammaAlgo::initializeProtoCands(), PFEGammaAlgo::isMuon(), reco::operator<<(), PFEGammaAlgo::removeOrLinkECALClustersToKFTracks(), reco::PFCandidateEGammaExtra::setGsfElectronClusterRef(), and setIndex().

{ return index_; }

isLinkedToDisplacedVertex()

virtual bool reco::PFBlockElement::isLinkedToDisplacedVertex ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 111 of file PFBlockElement.h.

Referenced by TrackAndTrackLinker::linkPrefilter().

{ return false; }

isMultilinksValide()

bool reco::PFBlockElement::isMultilinksValide ( Type  type ) const

inline

Definition at line 117 of file PFBlockElement.h.

References multilinks_.

Referenced by PreshowerAndECALLinker::linkPrefilter(), TrackAndECALLinker::linkPrefilter(), TrackAndHCALLinker::linkPrefilter(), TrackAndECALLinker::testLink(), and TrackAndHCALLinker::testLink().

                                             {
      const auto& it = multilinks_.find(type);
      if (it != multilinks_.end())
        return it->second.isValid;
      else
        return false;  // no multilinks_ for the specified type
    }

isPrimary()

virtual bool reco::PFBlockElement::isPrimary ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 110 of file PFBlockElement.h.

{ return false; }

isSecondary()

virtual bool reco::PFBlockElement::isSecondary ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack, and reco::PFBlockElementGsfTrack.

Definition at line 109 of file PFBlockElement.h.

{ return false; }

isTimeValid()

bool reco::PFBlockElement::isTimeValid ( ) const

inline

do we have a valid time information

Definition at line 128 of file PFBlockElement.h.

References timeError_.

Referenced by PFAlgo::reconstructTrack().

{ return timeError_ >= 0.f; }

lock()

void reco::PFBlockElement::lock ( )

inline

lock element

Definition at line 63 of file PFBlockElement.h.

References locked_.

Referenced by reco::PFBlock::addElement().

{ locked_ = true; }

locked()

bool reco::PFBlockElement::locked ( ) const

inline

locked ?

Definition at line 80 of file PFBlockElement.h.

References locked_.

{ return locked_; }

muonRef()

virtual const MuonRef& reco::PFBlockElement::muonRef ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 93 of file PFBlockElement.h.

References nullMuon_.

Referenced by reco::mlpf::getElementProperties().

{ return nullMuon_; }

setConversionRef()

virtual void reco::PFBlockElement::setConversionRef ( const ConversionRef &  convRef, TrackType  trType  )

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 99 of file PFBlockElement.h.

References gather_cfg::cout.

                                                                                  {
      std::cout << "Error in PFBlockElement::setConversionRef : this base class method is not implemented" << std::endl;
    }

setDisplacedVertexRef()

virtual void reco::PFBlockElement::setDisplacedVertexRef ( const PFDisplacedTrackerVertexRef &  niref, TrackType  trType  )

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 95 of file PFBlockElement.h.

References gather_cfg::cout.

                                                                                                   {
      std::cout << "Error in PFBlockElement::setDisplacedVertexRef : this base class method is not implemented"
                << std::endl;
    }

setIndex()

void reco::PFBlockElement::setIndex ( unsigned  index )

inline

set index

Definition at line 83 of file PFBlockElement.h.

References index(), and index_.

Referenced by reco::PFBlock::addElement().

{ index_ = index; }

setIsValidMultilinks()

void reco::PFBlockElement::setIsValidMultilinks ( bool  isVal, Type  type  )

inline

Definition at line 115 of file PFBlockElement.h.

References plotFactory::isVal, multilinks_, and type().

{ multilinks_[type].isValid = isVal; }

setMultilinks()

void reco::PFBlockElement::setMultilinks ( const PFMultiLinksTC &  ml, Type  type  )

inline

Definition at line 114 of file PFBlockElement.h.

References edm_modernize_messagelogger::ml, multilinks_, and type().

{ multilinks_[type] = ml; }

setMuonRef()

virtual void reco::PFBlockElement::setMuonRef ( const MuonRef &  muref )

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 102 of file PFBlockElement.h.

References gather_cfg::cout.

                                                  {
      std::cout << "Error in PFBlockElement::setMuonRef : this base class method is not implemented" << std::endl;
    }

setTime()

void reco::PFBlockElement::setTime ( float  time, float  timeError = 0.f  )

inline

the timing information

Definition at line 134 of file PFBlockElement.h.

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

                                                    {
      time_ = time;
      timeError_ = timeError;
    }

setTrackType()

virtual void reco::PFBlockElement::setTrackType ( TrackType  trType, bool  value  )

inlinevirtual

the trackType

Reimplemented in reco::PFBlockElementGsfTrack, and reco::PFBlockElementTrack.

Definition at line 75 of file PFBlockElement.h.

References gather_cfg::cout.

                                                            {
      std::cout << "Error in PFBlockElement::setTrackType : this base class method is not implemented" << std::endl;
    }

setV0Ref()

virtual void reco::PFBlockElement::setV0Ref ( const VertexCompositeCandidateRef &  v0ref, TrackType  trType  )

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 105 of file PFBlockElement.h.

References gather_cfg::cout.

                                                                                      {
      std::cout << "Error in PFBlockElement::setV0Ref : this base class method is not implemented" << std::endl;
    }

time()

float reco::PFBlockElement::time ( ) const

inline

Returns

the timing

Definition at line 130 of file PFBlockElement.h.

References time_.

Referenced by PFAlgo::reconstructTrack(), and setTime().

{ return time_; }

timeError()

float reco::PFBlockElement::timeError ( ) const

inline

Returns

the timing uncertainty

Definition at line 132 of file PFBlockElement.h.

References timeError_.

Referenced by PFAlgo::reconstructTrack(), and setTime().

{ return timeError_; }

trackRef()

virtual const reco::TrackRef& reco::PFBlockElement::trackRef ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 88 of file PFBlockElement.h.

References nullTrack_.

Referenced by PFEGammaFilters::isElectronSafeForJetMET(), PFEGammaFilters::isPhotonSafeForJetMET(), reco::mlpf::setCandidateRefs(), and FWPFBlockProxyBuilder::setupTrackElement().

{ return nullTrack_; }

trackRefPF()

virtual const PFRecTrackRef& reco::PFBlockElement::trackRefPF ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 89 of file PFBlockElement.h.

References nullPFRecTrack_.

Referenced by reco::mlpf::getElementProperties().

{ return nullPFRecTrack_; }

trackType()

virtual bool reco::PFBlockElement::trackType ( TrackType  trType ) const

inlinevirtual

Returns

tracktype

Reimplemented in reco::PFBlockElementGsfTrack, and reco::PFBlockElementTrack.

Definition at line 72 of file PFBlockElement.h.

Referenced by PFAlgo::isFromSecInt(), FWPFBlockProxyBuilder::setupTrackElement(), and TrackAndTrackLinker::testLink().

{ return false; }

type()

Type reco::PFBlockElement::type ( ) const

inline

Returns

type

Definition at line 69 of file PFBlockElement.h.

References type_.

Referenced by reco::mlpf::getElementProperties(), PFBlockBasedIsolation::getHighestEtECALCluster(), PFEGammaFilters::isElectronSafeForJetMET(), PFEGammaAlgo::isMuon(), PFEGammaFilters::isPhotonSafeForJetMET(), PFBlockAlgo::link(), PreshowerAndECALLinker::linkPrefilter(), TrackAndECALLinker::linkPrefilter(), TrackAndHCALLinker::linkPrefilter(), PFBlockElementSCEqual::operator()(), reco::operator<<(), MLPFProducer::produce(), PFElectronTranslator::produce(), PFPhotonTranslator::produce(), reco::mlpf::setCandidateRefs(), setIsValidMultilinks(), setMultilinks(), ECALAndHCALCaloJetLinker::testLink(), HCALAndHOLinker::testLink(), HFEMAndHFHADLinker::testLink(), HGCalAndBREMLinker::testLink(), ECALAndHCALLinker::testLink(), GSFAndBREMLinker::testLink(), TrackAndHOLinker::testLink(), HCALAndBREMLinker::testLink(), GSFAndHCALLinker::testLink(), GSFAndECALLinker::testLink(), ECALAndBREMLinker::testLink(), GSFAndHGCalLinker::testLink(), PreshowerAndECALLinker::testLink(), TrackAndGSFLinker::testLink(), TrackAndECALLinker::testLink(), SCAndHGCalLinker::testLink(), SCAndECALLinker::testLink(), and TrackAndHCALLinker::testLink().

{ return type_; }

unLock()

void reco::PFBlockElement::unLock ( )

inline

unlock element

Definition at line 66 of file PFBlockElement.h.

References locked_.

{ locked_ = false; }

V0Ref()

virtual const VertexCompositeCandidateRef& reco::PFBlockElement::V0Ref ( ) const

inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 94 of file PFBlockElement.h.

References nullVertex_.

Referenced by TrackAndTrackLinker::testLink().

{ return nullVertex_; }

Member Data Documentation

index_

unsigned reco::PFBlockElement::index_

protected

index in block vector

Definition at line 150 of file PFBlockElement.h.

Referenced by index(), and setIndex().

locked_

bool reco::PFBlockElement::locked_

protected

locked flag.

Definition at line 147 of file PFBlockElement.h.

Referenced by lock(), locked(), and unLock().

multilinks_

std::map<reco::PFBlockElement::Type, PFMultiLinksTC> reco::PFBlockElement::multilinks_

protected

Definition at line 154 of file PFBlockElement.h.

Referenced by getMultilinks(), isMultilinksValide(), setIsValidMultilinks(), and setMultilinks().

nullConv_

const reco::ConversionRefVector reco::PFBlockElement::nullConv_ = reco::ConversionRefVector()

staticprotected

Definition at line 166 of file PFBlockElement.h.

Referenced by convRefs().

nullMuon_

const reco::MuonRef reco::PFBlockElement::nullMuon_ = reco::MuonRef()

staticprotected

Definition at line 167 of file PFBlockElement.h.

Referenced by muonRef().

nullPFCluster_

const reco::PFClusterRef reco::PFBlockElement::nullPFCluster_ = reco::PFClusterRef()

staticprotected

Definition at line 164 of file PFBlockElement.h.

Referenced by clusterRef().

nullPFDispVertex_

const reco::PFDisplacedTrackerVertexRef reco::PFBlockElement::nullPFDispVertex_ = reco::PFDisplacedTrackerVertexRef()

staticprotected

Definition at line 165 of file PFBlockElement.h.

Referenced by reco::PFBlockElementTrack::displacedVertexRef(), and displacedVertexRef().

nullPFRecTrack_

const reco::PFRecTrackRef reco::PFBlockElement::nullPFRecTrack_ = reco::PFRecTrackRef()

staticprotected

Definition at line 163 of file PFBlockElement.h.

Referenced by trackRefPF().

nullTrack_

const reco::TrackRef reco::PFBlockElement::nullTrack_ = reco::TrackRef()

staticprotected

Definition at line 162 of file PFBlockElement.h.

Referenced by trackRef().

nullVertex_

const reco::VertexCompositeCandidateRef reco::PFBlockElement::nullVertex_ = reco::VertexCompositeCandidateRef()

staticprotected

Definition at line 168 of file PFBlockElement.h.

Referenced by V0Ref().

time_

float reco::PFBlockElement::time_

protected

timing information (valid if timeError_ >= 0)

Definition at line 158 of file PFBlockElement.h.

Referenced by setTime(), and time().

timeError_

float reco::PFBlockElement::timeError_

protected

timing information uncertainty (<0 if timing not available)

Definition at line 160 of file PFBlockElement.h.

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

type_

Type reco::PFBlockElement::type_

protected

type, see PFBlockElementType

Definition at line 142 of file PFBlockElement.h.

Referenced by Modules.Service::__str__(), Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::dumpSequencePython(), RandomRunSource.RandomRunSource::insertInto(), Modules.Service::insertInto(), ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), Modules.ESPrefer::nameInProcessDesc_(), and type().