PdgIdFilter< T > Class Template Reference

PdgIdFilter selects particles from their pdg id code. More...

#include <PdgIdFilter.h>

Inheritance diagram for PdgIdFilter< T >:

Collaboration diagram for PdgIdFilter< T >:

Public Member Functions
	PdgIdFilter ()
	Default constructor: More...
	PdgIdFilter (const PdgIdFilter< T > &rhs)
	Copy constructor: More...
virtual	~PdgIdFilter ()
	Destructor: More...
PdgIdFilter< T > &	operator= (const PdgIdFilter< T > &rhs)
	Assignment operator: More...
virtual bool	isAccepted (const T *element) const
	Main filter method. More...
const ParticleCandidateList *	pdgIds () const
	Return the list of pdg ids the filter is looking for. More...
bool	matchSign () const
	Return true if the filter requires a strict sign matching. More...
void	setFilter (const IFilterCuts *filter)
	Pure virtual function (to be overloaded by each of the children classes) to copy the cut properties of a given filter to another one. More...
void	setPdgId (const int &pdgId)
void	setPdgIds (const std::list< int > &pdgIds)
void	setPdgIds (const ParticleCandidateList &pdgIds)
void	setMatchSign (const bool matchSign)
bool	operator() (const T *element) const

Protected Attributes
ParticleCandidateList	m_pdgIds
	The list of particles ids which might be accepted. More...
bool	m_matchSign
	Tells to also match the sign of the pdg id of particles => true by default. More...

Detailed Description

template<typename T>
class PdgIdFilter< T >

PdgIdFilter selects particles from their pdg id code.

Up to now, it is based on a ParticleCandidateList but it is very likely that internally it will be based on DecayPattern See AnalysisExamples/FilterExample.cxx for a concrete example

Definition at line 34 of file PdgIdFilter.h.

Constructor & Destructor Documentation

PdgIdFilter() [1/2]

template<typename T >

PdgIdFilter< T >::PdgIdFilter

inline

Default constructor:

I/O operators.

Inline methods:

Definition at line 114 of file PdgIdFilter.h.

                                   :
  IFilterCuts(),
  IFilter<T>(),
  m_pdgIds(),
  m_matchSign( true )
{}

PdgIdFilter() [2/2]

template<typename T >

PdgIdFilter< T >::PdgIdFilter ( const PdgIdFilter< T > &  rhs )

inline

Copy constructor:

Definition at line 122 of file PdgIdFilter.h.

                                                              :
  IFilterCuts(rhs),
  IFilter<T>(rhs),
  m_pdgIds( rhs.m_pdgIds ),
  m_matchSign( rhs.m_matchSign )
{}

~PdgIdFilter()

template<typename T >

PdgIdFilter< T >::~PdgIdFilter

virtual

Destructor:

Definition at line 130 of file PdgIdFilter.h.

{}

Member Function Documentation

isAccepted()

template<typename T >

bool PdgIdFilter< T >::isAccepted ( const T *  element ) const

virtual

Main filter method.

This method takes the decision whether or not the filter has to accept the element. It returns true or false accordingly if the particle's id matches one of the required one.

Check if a pdg-id set has been set-up

Otherwise return true by convention

Implements IFilter< T >.

Definition at line 150 of file PdgIdFilter.h.

{
  if ( false == m_pdgIds.empty() ) {
    const int pdgId = element->pdgId();
    //std::cout << "Received PDG: " << pdgId << std::endl;
    //m_pdgIds.dropList();
    if ( m_pdgIds.hasInList( pdgId, m_matchSign ) ) return true;
    else return false;
  }
 
  return true;
}

matchSign()

template<typename T >

bool PdgIdFilter< T >::matchSign

inline

Return true if the filter requires a strict sign matching.

Definition at line 172 of file PdgIdFilter.h.

{
  return m_matchSign;
}

operator()()

template<typename T >

bool IFilter< T >::operator() ( const T *  element ) const

inlineinherited

Definition at line 101 of file IFilter.h.

{ 
  return isAccepted(element); 
}

operator=()

template<typename T >

PdgIdFilter< T > & PdgIdFilter< T >::operator= ( const PdgIdFilter< T > &  rhs )

inline

Assignment operator:

Definition at line 134 of file PdgIdFilter.h.

{
  if ( this != &rhs ) {
    IFilterCuts::operator=(rhs);
    IFilter<T>::operator=(rhs);
    m_pdgIds    = rhs.m_pdgIds;
    m_matchSign = rhs.m_matchSign;
  }
  return *this;
}

pdgIds()

template<typename T >

const ParticleCandidateList * PdgIdFilter< T >::pdgIds

inline

Return the list of pdg ids the filter is looking for.

Definition at line 166 of file PdgIdFilter.h.

{
  return &m_pdgIds;
}

setFilter()

template<typename T >

void PdgIdFilter< T >::setFilter ( const IFilterCuts *  ifilter )

virtual

Pure virtual function (to be overloaded by each of the children classes) to copy the cut properties of a given filter to another one.

It copies the properties of ifilter to the current IFilterCuts object.

Parameters

ifilter

the IFilterCuts which holds a set of properties one wants to copy to the current IFilterCuts object.

Implements IFilterCuts.

Definition at line 178 of file PdgIdFilter.h.

{
  if ( filter ) {
    const PdgIdFilter<T> * pdgFilter = 
      dynamic_cast<const PdgIdFilter<T> *>(filter );
    
    if ( pdgFilter ) {
      operator=(*pdgFilter);
    } else {
      MsgStream log( Athena::getMessageSvc(), "PdgIdFilter" );
      log << MSG::ERROR
      << "Can't dynamic_cast " << typeid(filter).name() 
      << " to a PdgIdFilter"
      << endmsg;
    }
  } //> filter is not a NULL pointer
}

setMatchSign()

template<typename T >

void PdgIdFilter< T >::setMatchSign ( const bool  matchSign )

inline

Definition at line 219 of file PdgIdFilter.h.

{
  m_matchSign = matchSign;
}

setPdgId()

template<typename T >

void PdgIdFilter< T >::setPdgId ( const int &  pdgId )

inline

Definition at line 197 of file PdgIdFilter.h.

{
  m_pdgIds.add( pdgId );
}

setPdgIds() [1/2]

template<typename T >

void PdgIdFilter< T >::setPdgIds ( const ParticleCandidateList &  pdgIds )

inline

Definition at line 213 of file PdgIdFilter.h.

{
  setPdgIds( pdgIds.list() );
}

setPdgIds() [2/2]

template<typename T >

void PdgIdFilter< T >::setPdgIds

(

const std::list< int > &

pdgIds

)

Definition at line 203 of file PdgIdFilter.h.

{
  for ( auto itr = pdgIds.begin();
    itr != pdgIds.end();
    ++itr ) {
    m_pdgIds.add( *itr );
  }
}

Member Data Documentation

m_matchSign

template<typename T >

bool PdgIdFilter< T >::m_matchSign

protected

Tells to also match the sign of the pdg id of particles => true by default.

Definition at line 101 of file PdgIdFilter.h.

m_pdgIds

template<typename T >

ParticleCandidateList PdgIdFilter< T >::m_pdgIds

protected

The list of particles ids which might be accepted.

Definition at line 96 of file PdgIdFilter.h.

---

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

• PdgIdFilter.h