McVtxFilterTool.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
// McVtxFilterTool.h 
// Header file for class McVtxFilterTool
// Author: S.Binet<binet@cern.ch>
// Modified: D. Schouten <dschoute@sfu.ca>
#ifndef MCPARTICLETOOLS_MCVTXFILTERTOOL_H 
#define MCPARTICLETOOLS_MCVTXFILTERTOOL_H 1
 
// STL includes
#include <string>
#include <vector>
 
// HepMC / CLHEP includes
 
// FrameWork includes
#include "Gaudi/Property.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgTool.h"
 
// DataModel includes
#include "AthContainers/DataVector.h"
 
// McParticleUtils includes
#include "McParticleUtils/McVtxFilter.h"
 
// McParticleKernel includes
#include "McParticleKernel/IMcVtxFilterTool.h"
 
// Forward declaration
class McEventCollection;
#include "AtlasHepMC/GenVertex_fwd.h"
 
class McVtxFilterTool : virtual public IMcVtxFilterTool,
                    public AthAlgTool
{ 
 
  // Public enums:   
 public:     
  struct VtxType {   
    enum Flag {      
      Unknown = -1,      
      IsRootVertex = 0,      
      IsNotRootVertex    
    };   
  };     
  
  // Public methods: 
 public: 
 
  // Copy constructor: 
 
  McVtxFilterTool( const std::string& type,
           const std::string& name, 
           const IInterface* parent );
 
  virtual ~McVtxFilterTool(); 
 
  // Assignment operator: 
  //McVtxFilterTool &operator=(const McVtxFilterTool &alg); 
 
  // Athena algorithm's Hooks
  virtual StatusCode  initialize();
  virtual StatusCode  execute();
 
  // Const methods: 
 
  void displayOptions() const;
 
  void stats() const;
 
  virtual bool isAccepted( const HepMC::ConstGenVertexPtr& vtx ) const;
 
  // Non-const methods: 
 
  virtual void filterMcEventCollection( const McEventCollection* mcCollection,
                    McEventCollection* filterColl );
 
  // Protected methods: 
 protected: 
 
  McVtxFilterTool();
 
  void addVertex(  const HepMC::ConstGenVertexPtr& vtx, HepMC::GenEvent * evt,
          const VtxType::Flag vtxType = VtxType::IsNotRootVertex, bool isSignal=false ) const;
 
  bool keepParticle( const VtxType::Flag vtxType, const HepMC::ConstGenParticlePtr& p ) const;
 
  void setupFilters( Gaudi::Details::PropertyBase& decayPatterns );
 
  // Protected data: 
 protected: 
 
  // Containers
  
  StringProperty m_mcEventsName;
 
  StringProperty m_mcEventsOutputName;
 
  StringArrayProperty m_decayPatterns;
 
  BooleanArrayProperty m_matchSigns;
 
  BooleanArrayProperty m_matchBranches;
 
  DataVector<McVtxFilter> m_filters;
 
  std::vector<double> m_counter;
 
  BooleanProperty m_doSignalProcessVtx;
 
  BooleanProperty m_fillTree;
 
  LongArrayProperty m_particles;
}; 
 
#endif //> MCPARTICLETOOLS_MCVTXFILTERTOOL_H