CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes | Friends
reco::PFBlockElement Class Referenceabstract

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

#include <PFBlockElement.h>

Inheritance diagram for reco::PFBlockElement:
reco::PFBlockElementBrem reco::PFBlockElementCluster reco::PFBlockElementGsfTrack reco::PFBlockElementSuperCluster reco::PFBlockElementTrack

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,
  kNBETypes =12
}
 

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 () const
 
unsigned index () const
 
virtual bool isLinkedToDisplacedVertex () const
 
bool isMultilinksValide () const
 
virtual bool isPrimary () const
 
virtual bool isSecondary () const
 
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)
 
void setMultilinks (const PFMultiLinksTC &ml)
 
void setMultilinksList (const PFMultilinksType &links)
 
virtual void setMuonRef (const MuonRef &muref)
 
virtual void setTrackType (TrackType trType, bool value)
 the trackType More...
 
virtual void setV0Ref (const VertexCompositeCandidateRef &v0ref, TrackType trType)
 
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_
 
PFMultiLinksTC multilinks_
 
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_
 
static const PFRecTrackRef nullPFRecTrack_ = reco::PFRecTrackRef()
 
static const reco::TrackRef nullTrack_ = reco::TrackRef()
 
static const
VertexCompositeCandidateRef 		nullVertex_ = reco::VertexCompositeCandidateRef()
 

Friends

std::ostream & operator<< (std::ostream &out, const PFBlockElement &element)
 

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 28 of file PFBlockElement.h.

Member Enumeration Documentation

enum reco::PFBlockElement::TrackType
Enumerator
DEFAULT 
T_FROM_DISP 
T_TO_DISP 
T_FROM_GAMMACONV 
MUON 
T_FROM_V0 

Definition at line 49 of file PFBlockElement.h.

49  {
50  DEFAULT=0,
51  T_FROM_DISP,
52  T_TO_DISP,
53  T_FROM_GAMMACONV,
54  MUON,
55  T_FROM_V0
56  };
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 
kNBETypes 

Definition at line 33 of file PFBlockElement.h.

33  {
34  NONE=0,
35  TRACK=1,
36  PS1=2,
37  PS2=3,
38  ECAL=4,
39  HCAL=5,
40  GSF=6,
41  BREM=7,
42  HFEM=8,
43  HFHAD=9,
44  SC=10,
45  HO=11,
46  kNBETypes=12
47  };

Constructor & Destructor Documentation

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

standard constructor

Definition at line 59 of file PFBlockElement.h.

59  :
60  type_(type),
61  locked_(false),
62  index_( static_cast<unsigned>(-1) ) {
63  }
type
type
Definition: HCALResponse.h:21
reco::PFBlockElement::index_
unsigned index_
index in block vector
Definition: PFBlockElement.h:148
virtual reco::PFBlockElement::~PFBlockElement ( )
inlinevirtual

destructor

Definition at line 67 of file PFBlockElement.h.

67 {}

Member Function Documentation

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

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

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

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

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

Reimplemented in reco::PFBlockElementCluster.

Definition at line 103 of file PFBlockElement.h.

References nullPFCluster_.

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

103 {return nullPFCluster_; }
reco::PFBlockElement::nullPFCluster_
static const PFClusterRef nullPFCluster_
Definition: PFBlockElement.h:156
virtual const ConversionRefVector& reco::PFBlockElement::convRefs ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 105 of file PFBlockElement.h.

References nullConv_.

Referenced by TrackAndTrackLinker::testLink().

105 { return nullConv_;}
reco::PFBlockElement::nullConv_
static const ConversionRefVector nullConv_
Definition: PFBlockElement.h:158
virtual const PFDisplacedTrackerVertexRef& reco::PFBlockElement::displacedVertexRef ( TrackType  trType) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 104 of file PFBlockElement.h.

References nullPFDispVertex_.

Referenced by TrackAndTrackLinker::testLink().

104 { return nullPFDispVertex_; }
reco::PFBlockElement::nullPFDispVertex_
static const PFDisplacedTrackerVertexRef nullPFDispVertex_
Definition: PFBlockElement.h:157
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 25 of file PFBlockElement.cc.

26  {
27  if(!out) return;
28  out<<pad<<"base element";
29 }
const PFMultilinksType& reco::PFBlockElement::getMultilinks ( ) const
inline

Definition at line 133 of file PFBlockElement.h.

References reco::PFMultiLinksTC::linkedClusters, and multilinks_.

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

133 {return multilinks_.linkedClusters;}
reco::PFBlockElement::multilinks_
PFMultiLinksTC multilinks_
Definition: PFBlockElement.h:151
reco::PFMultiLinksTC::linkedClusters
PFMultilinksType linkedClusters
Definition: PFMultilinksTC.h:18
unsigned reco::PFBlockElement::index ( ) const
inline
Returns
index

Definition at line 99 of file PFBlockElement.h.

References index_.

Referenced by BeautifulSoup.PageElement::_invert(), reco::PFCandidateEGammaExtra::addExtraNonConvTrack(), PFElectronTranslator::correspondingDaughterCandidate(), PFPhotonTranslator::correspondingDaughterCandidate(), PFEGammaAlgo::fillPFCandidates(), PFEGammaAlgo::initializeProtoCands(), PFEGammaAlgo::isAMuon(), PFEGammaAlgo::removeOrLinkECALClustersToKFTracks(), reco::PFCandidateEGammaExtra::setGsfElectronClusterRef(), and setIndex().

99 {return index_;}
reco::PFBlockElement::index_
unsigned index_
index in block vector
Definition: PFBlockElement.h:148
virtual bool reco::PFBlockElement::isLinkedToDisplacedVertex ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 122 of file PFBlockElement.h.

Referenced by TrackAndTrackLinker::linkPrefilter().

122 {return false;}
bool reco::PFBlockElement::isMultilinksValide ( ) const
inline

Definition at line 132 of file PFBlockElement.h.

References reco::PFMultiLinksTC::isValid, and multilinks_.

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

132 {return multilinks_.isValid;}
reco::PFBlockElement::multilinks_
PFMultiLinksTC multilinks_
Definition: PFBlockElement.h:151
virtual bool reco::PFBlockElement::isPrimary ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 121 of file PFBlockElement.h.

121 { return false; }
virtual bool reco::PFBlockElement::isSecondary ( ) const
inlinevirtual

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

Definition at line 120 of file PFBlockElement.h.

120 { return false; }
void reco::PFBlockElement::lock ( )
inline

lock element

Definition at line 77 of file PFBlockElement.h.

References locked_.

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

77 {locked_ = true;}
bool reco::PFBlockElement::locked ( ) const
inline

locked ?

Definition at line 93 of file PFBlockElement.h.

References locked_.

93 {return locked_;}
virtual const MuonRef& reco::PFBlockElement::muonRef ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 106 of file PFBlockElement.h.

References nullMuon_.

106 { return nullMuon_; }
reco::PFBlockElement::nullMuon_
static const MuonRef nullMuon_
Definition: PFBlockElement.h:159
virtual void reco::PFBlockElement::setConversionRef ( const ConversionRef &  convRef,
TrackType  trType 
)
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 110 of file PFBlockElement.h.

References gather_cfg::cout.

110  {
111  std::cout << "Error in PFBlockElement::setConversionRef : this base class method is not implemented" << std::endl;}
gather_cfg.cout
tuple cout
Definition: gather_cfg.py:145
virtual void reco::PFBlockElement::setDisplacedVertexRef ( const PFDisplacedTrackerVertexRef &  niref,
TrackType  trType 
)
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 108 of file PFBlockElement.h.

References gather_cfg::cout.

108  {
109  std::cout << "Error in PFBlockElement::setDisplacedVertexRef : this base class method is not implemented" << std::endl;}
gather_cfg.cout
tuple cout
Definition: gather_cfg.py:145
void reco::PFBlockElement::setIndex ( unsigned  index)
inline

set index

Definition at line 96 of file PFBlockElement.h.

References index(), and index_.

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

96 { index_ = index; }
reco::PFBlockElement::index
unsigned index() const
Definition: PFBlockElement.h:99
reco::PFBlockElement::index_
unsigned index_
index in block vector
Definition: PFBlockElement.h:148
void reco::PFBlockElement::setIsValidMultilinks ( bool  isVal)
inline

Definition at line 129 of file PFBlockElement.h.

References reco::PFMultiLinksTC::isValid, and multilinks_.

129 {multilinks_.isValid = isVal;}
reco::PFBlockElement::multilinks_
PFMultiLinksTC multilinks_
Definition: PFBlockElement.h:151
void reco::PFBlockElement::setMultilinks ( const PFMultiLinksTC &  ml)
inline

Definition at line 128 of file PFBlockElement.h.

References multilinks_.

128 {multilinks_ = ml;}
reco::PFBlockElement::multilinks_
PFMultiLinksTC multilinks_
Definition: PFBlockElement.h:151
void reco::PFBlockElement::setMultilinksList ( const PFMultilinksType &  links)
inline

Definition at line 130 of file PFBlockElement.h.

References reco::PFMultiLinksTC::linkedClusters, electronStore::links, and multilinks_.

130 {multilinks_.linkedClusters = links;}
reco::PFBlockElement::multilinks_
PFMultiLinksTC multilinks_
Definition: PFBlockElement.h:151
reco::PFMultiLinksTC::linkedClusters
PFMultilinksType linkedClusters
Definition: PFMultilinksTC.h:18
virtual void reco::PFBlockElement::setMuonRef ( const MuonRef &  muref)
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 112 of file PFBlockElement.h.

References gather_cfg::cout.

112  {
113  std::cout << "Error in PFBlockElement::setMuonRef : this base class method is not implemented" << std::endl;}
gather_cfg.cout
tuple cout
Definition: gather_cfg.py:145
virtual void reco::PFBlockElement::setTrackType ( TrackType  trType,
bool  value 
)
inlinevirtual

the trackType

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

Definition at line 89 of file PFBlockElement.h.

References gather_cfg::cout.

89  {
90  std::cout << "Error in PFBlockElement::setTrackType : this base class method is not implemented" << std::endl;}
gather_cfg.cout
tuple cout
Definition: gather_cfg.py:145
virtual void reco::PFBlockElement::setV0Ref ( const VertexCompositeCandidateRef &  v0ref,
TrackType  trType 
)
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 114 of file PFBlockElement.h.

References gather_cfg::cout.

114  {
115 
116  std::cout << "Error in PFBlockElement::setV0Ref : this base class method is not implemented" << std::endl;
117  }
gather_cfg.cout
tuple cout
Definition: gather_cfg.py:145
virtual const reco::TrackRef& reco::PFBlockElement::trackRef ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 101 of file PFBlockElement.h.

References nullTrack_.

Referenced by PFPhotonAlgo::EvaluateGCorrMVA(), PFPhotonAlgo::EvaluateResMVA(), PFEGammaFilters::isElectronSafeForJetMET(), PFEGammaFilters::isPhotonSafeForJetMET(), and FWPFBlockProxyBuilder::setupTrackElement().

101 {return nullTrack_; }
reco::PFBlockElement::nullTrack_
static const reco::TrackRef nullTrack_
Definition: PFBlockElement.h:154
virtual const PFRecTrackRef& reco::PFBlockElement::trackRefPF ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 102 of file PFBlockElement.h.

References nullPFRecTrack_.

Referenced by KDTreeLinkerTrackEcal::insertTargetElt(), and KDTreeLinkerTrackHcal::insertTargetElt().

102 {return nullPFRecTrack_; }
reco::PFBlockElement::nullPFRecTrack_
static const PFRecTrackRef nullPFRecTrack_
Definition: PFBlockElement.h:155
virtual bool reco::PFBlockElement::trackType ( TrackType  trType) const
inlinevirtual
Returns
tracktype

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

Definition at line 86 of file PFBlockElement.h.

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

86 { return false; }
Type reco::PFBlockElement::type ( ) const
inline
Returns
type

Definition at line 83 of file PFBlockElement.h.

References type_.

Referenced by cuy.ValElement::__init__(), PFPhotonAlgo::EvaluateGCorrMVA(), PFPhotonAlgo::EvaluateResMVA(), PFBlockBasedIsolation::getHighestEtECALCluster(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::inputCommands(), PFEGammaAlgo::isAMuon(), PFEGammaFilters::isElectronSafeForJetMET(), PFEGammaFilters::isPhotonSafeForJetMET(), PreshowerAndECALLinker::linkPrefilter(), TrackAndECALLinker::linkPrefilter(), PFBlockElementSCEqual::operator()(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputCommands(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::outputEventContent(), PFElectronTranslator::produce(), EgammaHLTPFPhotonIsolationProducer::produce(), PFPhotonTranslator::produce(), Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::properties(), HFEMAndHFHADLinker::testLink(), ECALAndHCALCaloJetLinker::testLink(), ECALAndHCALLinker::testLink(), HCALAndHOLinker::testLink(), ECALAndBREMLinker::testLink(), GSFAndBREMLinker::testLink(), TrackAndHOLinker::testLink(), GSFAndECALLinker::testLink(), GSFAndHCALLinker::testLink(), HCALAndBREMLinker::testLink(), TrackAndGSFLinker::testLink(), PreshowerAndECALLinker::testLink(), SCAndECALLinker::testLink(), TrackAndHCALLinker::testLink(), and TrackAndECALLinker::testLink().

83 { return type_; }
void reco::PFBlockElement::unLock ( )
inline

unlock element

Definition at line 80 of file PFBlockElement.h.

References locked_.

80 {locked_ = false;}
virtual const VertexCompositeCandidateRef& reco::PFBlockElement::V0Ref ( ) const
inlinevirtual

Reimplemented in reco::PFBlockElementTrack.

Definition at line 107 of file PFBlockElement.h.

References nullVertex_.

Referenced by TrackAndTrackLinker::testLink().

107 { return nullVertex_; }
reco::PFBlockElement::nullVertex_
static const VertexCompositeCandidateRef nullVertex_
Definition: PFBlockElement.h:160

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const PFBlockElement &  element 
)
friend

Member Data Documentation

unsigned reco::PFBlockElement::index_
protected

index in block vector

Definition at line 148 of file PFBlockElement.h.

Referenced by index(), and setIndex().

bool reco::PFBlockElement::locked_
protected

locked flag.

Definition at line 145 of file PFBlockElement.h.

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

PFMultiLinksTC reco::PFBlockElement::multilinks_
protected

Definition at line 151 of file PFBlockElement.h.

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

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

Definition at line 158 of file PFBlockElement.h.

Referenced by convRefs().

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

Definition at line 159 of file PFBlockElement.h.

Referenced by muonRef().

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

Definition at line 156 of file PFBlockElement.h.

Referenced by clusterRef().

const reco::PFDisplacedTrackerVertexRef reco::PFBlockElement::nullPFDispVertex_
staticprotected
Initial value:
=
reco::PFDisplacedTrackerVertexRef()

Definition at line 157 of file PFBlockElement.h.

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

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

Definition at line 155 of file PFBlockElement.h.

Referenced by trackRefPF().

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

Definition at line 154 of file PFBlockElement.h.

Referenced by trackRef().

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

Definition at line 160 of file PFBlockElement.h.

Referenced by V0Ref().

Type reco::PFBlockElement::type_
protected

type, see PFBlockElementType

Definition at line 140 of file PFBlockElement.h.

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

Generated for CMSSW Reference Manual by doxygen 1.8.5