McVtxFilter.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
// McVtxFilter.h 
// Header file for class McVtxFilter
// Author: S.Binet<binet@cern.ch>
#ifndef MCPARTICLEUTILS_MCVTXFILTER_H 
#define MCPARTICLEUTILS_MCVTXFILTER_H 
 
// STL includes
#include <sstream>
#include <ostream>
 
// Framework includes
#include "AthenaBaseComps/AthMessaging.h"
#include "AthContainers/DataVector.h"
 
// HepMC includes
#include "AtlasHepMC/GenEvent.h"
#include "AtlasHepMC/GenParticle.h"
#include "AtlasHepMC/GenVertex.h"
 
// AnalysisUtils includes
#include "AnalysisUtils/IFilterCuts.h"
#include "AnalysisUtils/ParticleCandidateList.h"
 
// McParticleUtils includes
#include "McParticleUtils/DecayParser.h"
 
// Forward declaration
 
class McVtxFilter : virtual public IFilterCuts, public AthMessaging
{ 
  
  // Public methods: 
  public: 
  
  McVtxFilter();
  
  McVtxFilter( const McVtxFilter& rhs );
  
  McVtxFilter( const std::string& decayPattern,
           const bool matchSign = false, 
           const bool matchBranches = false );
  
  McVtxFilter( const bool matchSign, const bool matchBranches );
  
  virtual ~McVtxFilter(); 
  
  McVtxFilter &operator=(const McVtxFilter &rhs); 
  
  // Const methods: 
 
  virtual bool isAccepted( HepMC::ConstGenVertexPtr vtx ) const;
 
  void dump( std::ostream& out = std::cout ) const;
 
  bool isFullVtx() const;
 
  bool matchSign() const;
 
  bool matchBranches() const;
 
  const std::string& decayPattern() const;
 
  const DataVector<const ParticleCandidateList>& parentList() const;
    
  const DataVector<const ParticleCandidateList>& childList() const;
    
  // Non-const methods: 
 
  virtual void setFilter( const IFilterCuts * filter );
  
  void setMatchSign( const bool matchSign );
  
  void setMatchBranches( const bool matchVtxBranches );
  
  void setDecayPattern( const std::string& decayPattern );
 
  // Protected methods: 
  protected: 
  
  bool checkParentBranch( HepMC::ConstGenVertexPtr vtx ) const;
 
  bool checkChildBranch ( HepMC::ConstGenVertexPtr vtx ) const;
  
  bool checkTwoBodyDecay( HepMC::ConstGenVertexPtr vtx ) const;
  
  // Protected data: 
  protected: 
 
  bool m_matchSign;
  
  bool m_matchBranches;
 
  std::string m_decayPattern;
  
  DataVector<const ParticleCandidateList> m_parentList;
  
  DataVector<const ParticleCandidateList> m_childList;
  
}; 
 
MsgStream& operator<<( MsgStream & msg, const McVtxFilter &obj );
std::ostream& operator<<( std::ostream& out, const McVtxFilter &obj );
 
// Inline methods: 
 
inline McVtxFilter::~McVtxFilter(){}
 
// Const methods: 
 
inline bool McVtxFilter::isFullVtx() const
{
  if ( m_parentList.empty() || m_childList.empty() ) {
    return false;
  } else {
    return true;
  }
}
 
inline bool McVtxFilter::matchSign() const
{
  return m_matchSign;
}
 
inline bool McVtxFilter::matchBranches() const
{
  return m_matchBranches;
}
 
inline const std::string& McVtxFilter::decayPattern() const
{
  return m_decayPattern;
}
 
inline 
const DataVector<const ParticleCandidateList>& McVtxFilter::parentList() const
{
  return m_parentList;
}
 
inline    
const DataVector<const ParticleCandidateList>& McVtxFilter::childList() const
{
  return m_childList;
}
 
// Non-const methods: 
 
inline void McVtxFilter::setMatchSign( const bool matchSign )
{
  m_matchSign = matchSign;
}
 
inline void McVtxFilter::setMatchBranches( const bool matchBranches )
{
  m_matchBranches = matchBranches;
}
 
#endif //> MCPARTICLEUTILS_MCVTXFILTER_H