xAOD::MissingETAssociationMap_v1 Class Reference

Inheritance diagram for xAOD::MissingETAssociationMap_v1:

Public Member Functions
	MissingETAssociationMap_v1 (SG::OwnershipPolicy own=SG::OWN_ELEMENTS, SG::IndexTrackingPolicy trackIndices=SG::DEFAULT_TRACK_INDICES)
	Default constructor.
	MissingETAssociationMap_v1 (MissingETAssociationMap_v1::iterator first, MissingETAssociationMap_v1::iterator last, SG::OwnershipPolicy own=SG::OWN_ELEMENTS, SG::IndexTrackingPolicy trackIndices=SG::DEFAULT_TRACK_INDICES)
	Constructor from iterators.
virtual	~MissingETAssociationMap_v1 ()
	Base class destructor.
void	resize (size_type sz)
void	pop_back ()
void	clear ()
void	sort ()
	Sort the container.
template<class COMPARE >
void	sort (COMPARE comp)
	Sort the container with a user-specified comparison operator.
void	clear (SG::OwnershipPolicy ownPolicy)
void	clear (SG::OwnershipPolicy ownPolicy, SG::IndexTrackingPolicy trackIndices)
iterator	erase (iterator position)
	Remove element at a given position.
iterator	erase (iterator first, iterator last)
	Remove a range of elements.
void	resetAssocCache () const
Find methods

const_iterator	find (const Jet *pJet) const
	Find association from jet pointer.
iterator	find (const Jet *pJet)
	Find association from jet pointer.
size_t	findIndex (const Jet *pJet) const
const_iterator	findByJetConst (const IParticle *pConst) const
	Find association from jet constituent.
iterator	findByJetConst (const IParticle *pConst)
	Find association from jet constituent.
const_iterator	findByJetConst (ElementLink< IParticleContainer > constLink) const
	Find association from jet constituent.
iterator	findByJetConst (ElementLink< IParticleContainer > constLink)
	Find association from jet constituent.
size_t	findIndexByJetConst (const IParticle *pConst) const
size_t	findIndexByJetConst (ElementLink< IParticleContainer > pConstLink) const
const MissingETAssociation_v1 *	getMiscAssociation () const
	Get an association for miscellaneous objects not associated to jets.
MissingETAssociation_v1 *	getMiscAssociation ()
Jet constituent and overlap removal methods

bool	setJetConstituents (const Jet *pJet) const
	Set constituent map for a jet.
bool	setJetConstituents (const std::vector< ElementLink< IParticleContainer > > &constLinks, const Jet *pJet) const
	Set constituent map for a jet.
bool	setJetConstituents (const std::vector< ElementLink< IParticleContainer > > &constLinks, size_t jetIndex) const
	Set constituent map for a jet.
bool	identifyOverlaps ()
	Do overlap-finding in all associations.
void	clearOverlaps ()
const IParticleContainer *	getUniqueSignals (const IParticleContainer *signals, MissingETBase::UsageHandler::Policy p=MissingETBase::UsageHandler::TrackCluster) const
	Extract a container of constituents that are not in jets.
const IParticleContainer *	getOverlapRemovedSignals (const IParticleContainer *signals, MissingETBase::UsageHandler::Policy p=MissingETBase::UsageHandler::TrackCluster) const
	Extract a container of constituents that do not overlap physics objects.
Reset mutable map flags

void	resetObjSelectionFlags () const
Protected Member Functions
void	f_setJetConstMap (std::map< ElementLink< IParticleContainer >, size_t > map)
void	f_clearJetConstMap ()
Protected Attributes
std::map< ElementLink < IParticleContainer >, size_t >	m_jetConstLinks
	Map jet constituents to the jet index.
Internal find methods for constant access

const_iterator	f_findConst (const Jet *pJet) const
	Find contribution by reference jet pointer.
void	f_setConstCache (const_iterator fCont) const
iterator	f_find (const Jet *pJet)
void	f_setCache (iterator fCont)
void	resetCache () const

Member Function Documentation

xAOD::MissingETAssociationMap_v1::iterator xAOD::MissingETAssociationMap_v1::erase	(	iterator	first,
		iterator	last
	)			`[inline]`

Remove a range of elements.

Parameters:

	first	Iterator pointing to the first element to be removed.
	last	Iterator pointing one past the last element to be removed.

Returns:: An iterator pointing to the element pointed to by last prior to erasing (or end()).

If the container owns its elements, then the removed elements will be deleted. Any duplicates will be removed in this process, but don't rely on this.

Reimplemented from DataVector< MissingETAssociation_v1 >.

xAOD::MissingETAssociationMap_v1::iterator xAOD::MissingETAssociationMap_v1::erase ( iterator position ) [inline]

Remove element at a given position.

Parameters:

position

Iterator pointing to the element to be removed.

Returns:: An iterator pointing to the next element (or end()).

If the container owns its elements, then the pointed-to element will be deleted.

Reimplemented from DataVector< MissingETAssociation_v1 >.

MissingETAssociationMap_v1::const_iterator MissingETAssociationMap_v1::f_findConst ( const Jet * pJet ) const [protected]

Find contribution by reference jet pointer.

This method finds a xAOD::MissingETAssociation_v1 object linked to the specified xAOD::Jet object. It is invoked internally by find(const Jet*). It uses an internal cache to determine if this jet has been found in the latest invocation of the find method, and returns without further action in this case. If a different jet is searched for, it initiates a linear search and updates the internal cache with the new pointer (will be NULL if referenced jet not found) and the datawords storing the const_iterator and the iterator referencing the non-modifiable and modifiable xAOD::MissingETAssociation_v1 object in the association map, respectively (both iterators will be set to the corresponding end iterator if the jet is not in the association map).

Returns:: Valid const iterator referencing the MissingETAssociation_v1 object linking ot the requested jet. If this jet is not in the list, MissingETAssociationMap_v1::end() is returned.

Parameters:

[in] pJet pointer to non-modifiable Jet object to be found in the association map.

MissingETAssociationMap_v1::iterator MissingETAssociationMap_v1::find ( const Jet * pJet )

Find association from jet pointer.

Returns:: Iterator referencing a modifiable xAOD::MissingETAssociation_v1 object linking to the given jet. If the reference jet is not in the association map, an end iterator is returned.

Parameters:

[in] pJet pointer to the xAOD::Jet object searched for in the association map.

MissingETAssociationMap_v1::const_iterator MissingETAssociationMap_v1::find ( const Jet * pJet ) const

Find association from jet pointer.

Returns:: Const iterator referencing a non-modifiable xAOD::MissingETAssociation_v1 object linking to the given jet. If the jet is not in the association map, an end const iterator is returned.

Parameters:

[in] pJet pointer to the xAOD::Jet object searched for in the association map.

MissingETAssociationMap_v1::iterator MissingETAssociationMap_v1::findByJetConst ( ElementLink< IParticleContainer > constLink )

Find association from jet constituent.

Returns:: Iterator referencing a modifiable xAOD::MissingETAssociation_v1 object linking to the jet containing this constituent. If the parent jet is not in the association map, an end iterator is returned.

Parameters:

[in] ElementLink to the xAOD::IParticle object searched for in the association map.

MissingETAssociationMap_v1::const_iterator MissingETAssociationMap_v1::findByJetConst ( ElementLink< IParticleContainer > constLink ) const

Find association from jet constituent.

Returns:: Const iterator referencing a modifiable xAOD::MissingETAssociation_v1 object linking to the jet containing this constituent. If the parent jet is not in the association map, an end const iterator is returned.

Parameters:

[in] ElementLink to the xAOD::IParticle object searched for in the association map.

MissingETAssociationMap_v1::iterator MissingETAssociationMap_v1::findByJetConst ( const IParticle * pConst )

Find association from jet constituent.

Returns:: Iterator referencing a modifiable xAOD::MissingETAssociation_v1 object linking to the jet containing this constituent. If the parent jet is not in the association map, an end iterator is returned.

Parameters:

[in] pointer to the xAOD::IParticle object searched for in the association map.

MissingETAssociationMap_v1::const_iterator MissingETAssociationMap_v1::findByJetConst ( const IParticle * pConst ) const

Find association from jet constituent.

Returns:: Const iterator referencing a modifiable xAOD::MissingETAssociation_v1 object linking to the jet containing this constituent. If the parent jet is not in the association map, an end const iterator is returned.

Parameters:

[in] pointer to the xAOD::IParticle object searched for in the association map.

const MissingETAssociation_v1 * MissingETAssociationMap_v1::getMiscAssociation ( ) const

Get an association for miscellaneous objects not associated to jets.

Returns:: View container of non-overlapping constituents, which the user should delete

const xAOD::IParticleContainer * MissingETAssociationMap_v1::getOverlapRemovedSignals	(	const IParticleContainer *	signals,
		MissingETBase::UsageHandler::Policy	p = `MissingETBase::UsageHandler::TrackCluster`
	)			const

Extract a container of constituents that do not overlap physics objects.

Returns:: View container of non-overlapping constituents, which the user should delete

Parameters:

`[in]`	Non-modifiable	IParticleContainer holding the constituents to be tested
`[in]`	MissingETBase::UsageHandler::Policy	stating which types of constituents to check

const xAOD::IParticleContainer * MissingETAssociationMap_v1::getUniqueSignals	(	const IParticleContainer *	signals,
		MissingETBase::UsageHandler::Policy	p = `MissingETBase::UsageHandler::TrackCluster`
	)			const

Extract a container of constituents that are not in jets.

Returns:: View container of non-overlapping constituents, which the user should delete

Parameters:

`[in]`	Non-modifiable	IParticleContainer holding the constituents to be tested
`[in]`	MissingETBase::UsageHandler::Policy	stating which types of constituents to check

bool MissingETAssociationMap_v1::identifyOverlaps ( )

Do overlap-finding in all associations.

Returns:: Boolean stating whether any overlaps were identified

bool MissingETAssociationMap_v1::setJetConstituents	(	const std::vector< ElementLink< IParticleContainer > > &	constLinks,
		size_t	jetIndex
	)			const

Set constituent map for a jet.

Returns:: Boolean stating whether or not jet is linked to an association in the map.

Parameters:

`[in]`	Index	of the jet's association in the map
`[in]`	Non-modifiable	vector of ElementLink to the jet constituents

bool MissingETAssociationMap_v1::setJetConstituents	(	const std::vector< ElementLink< IParticleContainer > > &	constLinks,
		const Jet *	pJet
	)			const

Set constituent map for a jet.

Returns:: Boolean stating whether or not jet is linked to an association in the map.

Parameters:

`[in]`	Pointer	to the jet
`[in]`	Non-modifiable	vector of ElementLink to the jet constituents

bool MissingETAssociationMap_v1::setJetConstituents ( const Jet * pJet ) const

Set constituent map for a jet.

Returns:: Boolean stating whether or not jet is linked to an association in the map.

Parameters:

[in] Pointer to the jet

template<class COMPARE >

void xAOD::MissingETAssociationMap_v1::sort ( COMPARE comp ) [inline]

Sort the container with a user-specified comparison operator.

Parameters:

comp

Functional to compare two values.

Reimplemented from DataVector< MissingETAssociation_v1 >.

void xAOD::MissingETAssociationMap_v1::sort ( ) [inline]

Sort the container.

This just sorts by pointer value, so it's probably not very useful.

Reimplemented from DataVector< MissingETAssociation_v1 >.

The documentation for this class was generated from the following files:

/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODMissingET/xAODMissingET/versions/MissingETAssociationMap_v1.h
/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODMissingET/Root/MissingETAssociationMap_v1.cxx
/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.28/xAODMissingET/xAODMissingET/versions/MissingETAssociationMap_v1.icc

xAOD::MissingETAssociationMap_v1 Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Internal find methods for constant access

Member Function Documentation