Analysis::PhotonAssociation Class Reference

#include <PhotonAssociation.h>

Inheritance diagram for Analysis::PhotonAssociation:

Collaboration diagram for Analysis::PhotonAssociation:

Public Types
typedef JetKeyDescriptor::key_t	name_t
typedef name_t	NameType
typedef typename NavigationDefaults::DefaultChildColl< PhotonContainer, double >::type	constituent_coll
typedef constituent_coll::iterator	constituent_iter
typedef constituent_coll::const_iterator	constituent_const_iter
typedef PhotonContainer	container_type
	Object container type.
typedef double	parameter_type
	\ brief Relational parameter type
typedef NavigationDefaults::DefaultChildColl< container_type, parameter_type >	navhelper_t
	Collection manager type.
typedef PhotonContainer::base_value_type	constituent_type
typedef PhotonContainer::reference	constituent_ptr_ref
typedef PhotonContainer::const_reference	constituent_const_ptr_ref
typedef PhotonContainer::value_type	constituent_ptr
typedef SG::GenerateIndexingPolicy< PhotonContainer >::type::index_type	external_index_type
typedef NavigableIterator< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl< PhotonContainer, double >::type >	object_iter

Public Member Functions
	PhotonAssociation ()=default
	constructor
	PhotonAssociation (const NameType &name)
	constructor
	~PhotonAssociation ()=default
virtual JetAssociationBase *	clone () const
	a clone method for the proper workings of the copy constructor
const Photon *	photon () const
	get photon directly without token
void	set_photon (const PhotonContainer *theContainer, const Photon *the_photon, double weight=1)
void	set_photon (const PhotonContainer *theContainer, const index_type &theIndex, double weight=1)
void	set_association (const PhotonContainer *theContainer, const Photon *the_photon, double weight=1)
void	set_association (const PhotonContainer *theContainer, const index_type &theIndex, double weight=1)
double	getPhotonWeight (const Photon *the_photon) const
double	getPhotonWeight (const PhotonContainer *theContainer, const index_type &theIndex) const
void	setName (const name_t &name)
const name_t &	name () const
size_t	keyIndex () const
virtual void	fillToken (INavigationToken &navToken) const
void	putElement (const PhotonContainer *objectContainer, const constituent_type *constituentObject, const double &objectParameter=double(), size_t sizeHint=0)
void	insertElement (const PhotonContainer *objectContainer, const constituent_type *constituentObject, const double &objectParameter=double(), size_t sizeHint=0)
void	reweight (const constituent_type *constituentObject, const double &objectParameter=double())
bool	remove (const constituent_type *aConstituent)
bool	removeAll ()
bool	replace (const PhotonContainer *newObjectContainer)
	replace old object container with a new container assumes that all objects have been or will be inserted to the new container
bool	contains (const constituent_type *aConstituent) const
virtual object_iter	begin () const
virtual object_iter	end () const
virtual unsigned int	size () const
double	getParameter (const constituent_type *aConstituent) const
const PhotonContainer *	getContainer (const constituent_type *aConstituent) const
bool	getIndex (const constituent_type *aConstituent, external_index_type &theIndex) const
virtual void	fillToken (INavigationToken &thisToken, const std::any &weight) const =0

Protected Member Functions
const constituent_coll &	getConstituents () const
const constituent_coll *	getPtrToConstituents () const
virtual const constituent_type *	getConstituentPtr (constituent_iter iter) const
virtual double	getConstituentPar (constituent_iter iter) const
void	dumpStore () const

Protected Attributes
size_t	m_keyIndex
JetKeyDescriptorInstance *	m_jetKeyDescr

Private Types
typedef Navigable< PhotonContainer, double >::external_index_type	index_type
typedef Navigable< PhotonContainer, double >::constituent_iter	iter_type

Private Member Functions
virtual void	apply (NavigationToken< constituent_type > &navToken) const
virtual void	toKidsAfterAccept (INavigationToken &navToken) const
virtual void	toKidsAfterReject (INavigationToken &navToken) const

Private Attributes
constituent_coll	m_constituents

Detailed Description

Definition at line 25 of file PhotonAssociation.h.

Member Typedef Documentation

constituent_coll

typedef typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_coll

inherited

Definition at line 101 of file Navigable.h.

constituent_const_iter

typedef constituent_coll::const_iterator Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_const_iter

inherited

Definition at line 103 of file Navigable.h.

constituent_const_ptr_ref

typedef PhotonContainer::const_reference Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_const_ptr_ref

inherited

Definition at line 151 of file Navigable.h.

constituent_iter

typedef constituent_coll::iterator Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_iter

inherited

Definition at line 102 of file Navigable.h.

constituent_ptr

typedef PhotonContainer::value_type Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_ptr

inherited

Definition at line 152 of file Navigable.h.

constituent_ptr_ref

typedef PhotonContainer::reference Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_ptr_ref

inherited

Definition at line 150 of file Navigable.h.

constituent_type

typedef PhotonContainer::base_value_type Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::constituent_type

inherited

Definition at line 149 of file Navigable.h.

container_type

typedef PhotonContainer Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::container_type

inherited

Object container type.

Definition at line 110 of file Navigable.h.

external_index_type

typedef SG::GenerateIndexingPolicy<PhotonContainer>::type::index_type Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::external_index_type

inherited

Definition at line 156 of file Navigable.h.

index_type

typedef Navigable<PhotonContainer,double>::external_index_type Analysis::PhotonAssociation::index_type

private

Definition at line 29 of file PhotonAssociation.h.

iter_type

typedef Navigable<PhotonContainer,double>::constituent_iter Analysis::PhotonAssociation::iter_type

private

Definition at line 30 of file PhotonAssociation.h.

name_t

typedef JetKeyDescriptor::key_t JetAssociationBase::name_t

inherited

Definition at line 28 of file JetAssociationBase.h.

NameType

typedef name_t JetAssociationBase::NameType

inherited

Definition at line 29 of file JetAssociationBase.h.

navhelper_t

typedef NavigationDefaults::DefaultChildColl<container_type,parameter_type> Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::navhelper_t

inherited

Collection manager type.

Definition at line 114 of file Navigable.h.

object_iter

typedef NavigableIterator<PhotonContainer,double,typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type> Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::object_iter

inherited

Definition at line 159 of file Navigable.h.

parameter_type

typedef double Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::parameter_type

inherited

\ brief Relational parameter type

Definition at line 112 of file Navigable.h.

Constructor & Destructor Documentation

PhotonAssociation() [1/2]

Analysis::PhotonAssociation::PhotonAssociation ( )

default

constructor

PhotonAssociation() [2/2]

Analysis::PhotonAssociation::PhotonAssociation

(

const NameType &

name

)

constructor

Definition at line 10 of file PhotonAssociation.cxx.

  {
    this->setName(name);
  }  

~PhotonAssociation()

Analysis::PhotonAssociation::~PhotonAssociation ( )

default

Member Function Documentation

apply()

virtual void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::apply ( NavigationToken< constituent_type > & navToken ) const

privatevirtualinherited

begin()

virtual object_iter Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::begin ( ) const

virtualinherited

clone()

JetAssociationBase * Analysis::PhotonAssociation::clone ( ) const

virtual

a clone method for the proper workings of the copy constructor

Implements JetAssociationBase.

Definition at line 15 of file PhotonAssociation.cxx.

  {
    return new PhotonAssociation( *this );
  }

contains()

bool Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::contains ( const constituent_type * aConstituent ) const

inherited

dumpStore()

void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::dumpStore ( ) const

protectedinherited

end()

virtual object_iter Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::end ( ) const

virtualinherited

fillToken() [1/2]

virtual void INavigable::fillToken ( INavigationToken & thisToken, const std::any & weight ) const

pure virtualinherited

Implemented in Analysis::ISvxAssociation, Analysis::ISvxConstituent, Analysis::Muon, Analysis::MuonAssociation, Analysis::ParticleShallowClone, Analysis::TauJet, CaloClusterNavigable, constituent_iter< ElectronContainer, double >, constituent_iter< INavigable4MomentumCollection, double >, constituent_iter< JetCollection, double >, constituent_iter< MuonContainer, double >, constituent_iter< PhotonContainer, double >, constituent_iter< TrackParticleContainer, double >, eflowObject, egamma, external_index_type< CaloCellContainer, double >, external_index_type< ElectronContainer, double >, external_index_type< INavigable4MomentumCollection, double >, external_index_type< JetCollection, double >, external_index_type< MuonContainer, double >, external_index_type< PhotonContainer, double >, external_index_type< TrackParticleContainer, double >, Jet, Nav4MomWrapper< Navigable_t, P4Momentum_t >, Navigable< CONT, RPAR, COLL >, Navigable< CaloClusterContainer >, Navigable< collection_t, weight_t >, Navigable< INavigable4MomentumCollection, double >, NavigableTerminalNode, object_iter< CaloCellContainer, double >, object_iter< TrackParticleContainer, double >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, and ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >.

fillToken() [2/2]

virtual void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::fillToken ( INavigationToken & navToken ) const

virtualinherited

Implements INavigable.

getConstituentPar()

virtual double Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getConstituentPar ( constituent_iter iter ) const

protectedvirtualinherited

getConstituentPtr()

virtual const constituent_type * Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getConstituentPtr ( constituent_iter iter ) const

protectedvirtualinherited

getConstituents()

const constituent_coll & Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getConstituents ( ) const

inlineprotectedinherited

Definition at line 290 of file Navigable.h.

{ return m_constituents; }

getContainer()

const PhotonContainer * Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getContainer ( const constituent_type * aConstituent ) const

inherited

getIndex()

bool Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getIndex ( const constituent_type * aConstituent, external_index_type & theIndex ) const

inherited

getParameter()

double Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getParameter ( const constituent_type * aConstituent ) const

inherited

getPhotonWeight() [1/2]

double Analysis::PhotonAssociation::getPhotonWeight

(

const Photon *

the_photon

)

const

Definition at line 68 of file PhotonAssociation.cxx.

  {
    // from Navigable
    return (this->contains(the_photon) )
      ? this->getParameter(the_photon)
      : 0.;
  }

getPhotonWeight() [2/2]

double Analysis::PhotonAssociation::getPhotonWeight	(	const PhotonContainer *	theContainer,
		const index_type &	theIndex ) const

Definition at line 76 of file PhotonAssociation.cxx.

  {
    // from Navigable
    return (this->contains(theContainer,theIndex))
      ? this->getParameter(theContainer,theIndex)
      : 0.;
  }

getPtrToConstituents()

const constituent_coll * Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::getPtrToConstituents ( ) const

inlineprotectedinherited

Definition at line 294 of file Navigable.h.

  { return &m_constituents; }

insertElement()

void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::insertElement ( const PhotonContainer * objectContainer, const constituent_type * constituentObject, const double & objectParameter = RPAR(), size_t sizeHint = 0 )

inherited

keyIndex()

size_t JetAssociationBase::keyIndex ( ) const

inlineinherited

Definition at line 35 of file JetAssociationBase.h.

{ return m_keyIndex; }

name()

const JetAssociationBase::name_t & JetAssociationBase::name ( ) const

inherited

Definition at line 20 of file JetAssociationBase.cxx.

{
  return m_jetKeyDescr->getKey(JetKeyConstants::AssoCat,m_keyIndex);
} 

photon()

const Photon * Analysis::PhotonAssociation::photon

(

)

const

get photon directly without token

Definition at line 20 of file PhotonAssociation.cxx.

  {
    //get photon from Navigable
    if (this->size() ==0) 
      return nullptr;
    if (this->size() > 1)
      return nullptr;
    // this shouldn't happen
    else 
      return getConstituentPtr((this->getConstituents()).begin());
  }

putElement()

void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::putElement ( const PhotonContainer * objectContainer, const constituent_type * constituentObject, const double & objectParameter = RPAR(), size_t sizeHint = 0 )

inherited

remove()

bool Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::remove ( const constituent_type * aConstituent )

inherited

removeAll()

bool Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::removeAll ( )

inlineinherited

Definition at line 237 of file Navigable.h.

{ m_constituents.clear(); return this->size() == 0 ; }

replace()

bool Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::replace ( const PhotonContainer * newObjectContainer )

inherited

replace old object container with a new container assumes that all objects have been or will be inserted to the new container

reweight()

void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::reweight ( const constituent_type * constituentObject, const double & objectParameter = RPAR() )

inherited

set_association() [1/2]

void Analysis::PhotonAssociation::set_association ( const PhotonContainer * theContainer, const index_type & theIndex, double weight = 1 )

inline

Definition at line 54 of file PhotonAssociation.h.

    {set_photon(theContainer, theIndex, weight);}

set_association() [2/2]

void Analysis::PhotonAssociation::set_association ( const PhotonContainer * theContainer, const Photon * the_photon, double weight = 1 )

inline

Definition at line 50 of file PhotonAssociation.h.

    {set_photon(theContainer, the_photon, weight);}

set_photon() [1/2]

void Analysis::PhotonAssociation::set_photon	(	const PhotonContainer *	theContainer,
		const index_type &	theIndex,
		double	weight = 1 )

Definition at line 50 of file PhotonAssociation.cxx.

  {
    double newWeight = weight;
    // photon already in collection
    if ( this->contains(theContainer,theIndex) )
      {
    // update weight
    newWeight *= this->getPhotonWeight(theContainer,theIndex);
    // remove the previous photon
    this->remove(theContainer,theIndex);
      }
    
    // from Navigable base
    this->putElement(theContainer,theIndex,newWeight);
  }

set_photon() [2/2]

void Analysis::PhotonAssociation::set_photon	(	const PhotonContainer *	theContainer,
		const Photon *	the_photon,
		double	weight = 1 )

Definition at line 32 of file PhotonAssociation.cxx.

  {
    double newWeight = weight;
    // photon already in collection
    if ( this->contains(the_photon) )
      {
    // update weight
    newWeight *= this->getPhotonWeight(the_photon);
    // remove the previous photon 
    this->remove(the_photon);
      }
    
    // from Navigable base
    this->putElement(theContainer,the_photon,newWeight);
  }

setName()

void JetAssociationBase::setName ( const name_t & name )

inherited

Definition at line 15 of file JetAssociationBase.cxx.

{
  m_keyIndex = m_jetKeyDescr->getIndex(JetKeyConstants::AssoCat,name);
}

size()

virtual unsigned int Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::size ( ) const

virtualinherited

toKidsAfterAccept()

virtual void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::toKidsAfterAccept ( INavigationToken & navToken ) const

privatevirtualinherited

toKidsAfterReject()

virtual void Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::toKidsAfterReject ( INavigationToken & navToken ) const

privatevirtualinherited

Member Data Documentation

m_constituents

constituent_coll Navigable< PhotonContainer, double, typename NavigationDefaults::DefaultChildColl<PhotonContainer, double>::type >::m_constituents

privateinherited

Definition at line 345 of file Navigable.h.

m_jetKeyDescr

JetKeyDescriptorInstance* JetAssociationBase::m_jetKeyDescr

protectedinherited

Definition at line 57 of file JetAssociationBase.h.

m_keyIndex

size_t JetAssociationBase::m_keyIndex

protectedinherited

Definition at line 56 of file JetAssociationBase.h.

---

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

• PhotonAssociation.h
• PhotonAssociation.cxx