ISF::CosmicEventFilterTool Class Reference

#include <CosmicEventFilterTool.h>

Inheritance diagram for ISF::CosmicEventFilterTool:

Collaboration diagram for ISF::CosmicEventFilterTool:

Public Member Functions
	CosmicEventFilterTool (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters. More...
	~CosmicEventFilterTool ()
	Destructor. More...
virtual StatusCode	initialize () override final
	Athena algtool Hooks. More...
virtual StatusCode	finalize () override final
	Athena algtool Hook. More...
virtual bool	eventPassesFilter () const override final
	Check that the current event passes this filter. More...

Private Attributes
std::atomic< unsigned int >	m_ntot
std::atomic< unsigned int >	m_npass
SG::ReadHandleKeyArray< TrackRecordCollection >	m_VolumeNames
bool	m_useANDFilter
int	m_magicID
double	m_ptMin
double	m_ptMax

Detailed Description

the code used in this implementation is kindly stolen from: atlasoff:: Simulation/G4Extentions/G4CosmicFilter/

Author

John Chapman -at- cern.ch

Definition at line 32 of file CosmicEventFilterTool.h.

Constructor & Destructor Documentation

CosmicEventFilterTool()

ISF::CosmicEventFilterTool::CosmicEventFilterTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Constructor with parameters.

Constructor.

Definition at line 21 of file CosmicEventFilterTool.cxx.

  : base_class(t,n,p)
  , m_ntot(0)
  , m_npass(0)
  , m_VolumeNames{""}
  , m_useANDFilter(true)
  , m_magicID(0)
  , m_ptMin(-1)
  , m_ptMax(-1)
{
  declareProperty("UseAndFilter", m_useANDFilter, "Use an AND Filter over all the Volumes, if false use an OR filter");
  declareProperty("VolumeNames", m_VolumeNames, "List of Volumes to use for filtering");
  declareProperty("PDG_ID", m_magicID, "If this is non-zero then more detailed checks will be made, requiring this particle to be present.");
  declareProperty("ptMin", m_ptMin, "Minimum pT for detailed cuts.");
  declareProperty("ptMax", m_ptMax, "Minimum pT for detailed cuts.");
}

~CosmicEventFilterTool()

ISF::CosmicEventFilterTool::~CosmicEventFilterTool

(

)

Destructor.

Definition at line 41 of file CosmicEventFilterTool.cxx.

                                                 {
}

Member Function Documentation

eventPassesFilter()

bool ISF::CosmicEventFilterTool::eventPassesFilter ( ) const

finaloverridevirtual

Check that the current event passes this filter.

Definition at line 66 of file CosmicEventFilterTool.cxx.

{
 
  ++m_ntot;
  if (m_VolumeNames.empty()) { ++m_npass; return true;}
  bool evtPassesFilter(m_useANDFilter);
  auto trackRecordCollectionHandles = m_VolumeNames.makeHandles();
  for(auto& coll : trackRecordCollectionHandles) {
    if (!coll.isValid())
        {
          ATH_MSG_DEBUG("Cannot retrieve TrackRecordCollection " << coll.key());
          return false;
        }
      unsigned int counter(0);
      if (m_magicID!=0 || m_ptMin>0 || m_ptMax>0)
        {
          const unsigned int ntracks(coll->size());
          for (unsigned int track=0;track<ntracks;++track)
            {
              if (m_magicID!=0 && m_magicID != std::fabs(coll->operator[](track).GetPDGCode())) { continue; }
              if (m_ptMin>0 && m_ptMin > coll->operator[](track).GetMomentum().perp() ) { continue; }
              if (m_ptMax>0 && m_ptMax < coll->operator[](track).GetMomentum().perp() ) { continue; }
              ++counter;
            }// end of loop over tracks
        }
      else
        {
          counter = coll->size();
        }
 
      if(m_useANDFilter)
        { //AND Filter
          if(0==counter)
            { //One Failure is too many
              return false;
            }
        }
      else
        { //OR Filter
          if(0!=counter)
            { //One Success is enough
              ++m_npass;
              return true;
            }
        }
    }// end of loop over volumes
 
  if (evtPassesFilter)
    {
      ++m_npass;
    }
  return evtPassesFilter;
}

finalize()

StatusCode ISF::CosmicEventFilterTool::finalize ( )

finaloverridevirtual

Athena algtool Hook.

Definition at line 56 of file CosmicEventFilterTool.cxx.

{
  ATH_MSG_VERBOSE("finalize() ...");
  ATH_MSG_INFO("Processed "<< m_ntot <<" events, "<< m_npass<<" events passed filter ");
  ATH_MSG_VERBOSE("finalize() successful");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode ISF::CosmicEventFilterTool::initialize ( )

finaloverridevirtual

Athena algtool Hooks.

Definition at line 46 of file CosmicEventFilterTool.cxx.

{
  ATH_MSG_VERBOSE("initialize() ...");
  ATH_CHECK(m_VolumeNames.initialize());
  ATH_MSG_VERBOSE("initialize() successful");
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_magicID

int ISF::CosmicEventFilterTool::m_magicID

private

Definition at line 53 of file CosmicEventFilterTool.h.

m_npass

std::atomic<unsigned int> ISF::CosmicEventFilterTool::m_npass

mutableprivate

Definition at line 50 of file CosmicEventFilterTool.h.

m_ntot

std::atomic<unsigned int> ISF::CosmicEventFilterTool::m_ntot

mutableprivate

Definition at line 49 of file CosmicEventFilterTool.h.

m_ptMax

double ISF::CosmicEventFilterTool::m_ptMax

private

Definition at line 55 of file CosmicEventFilterTool.h.

m_ptMin

double ISF::CosmicEventFilterTool::m_ptMin

private

Definition at line 54 of file CosmicEventFilterTool.h.

m_useANDFilter

bool ISF::CosmicEventFilterTool::m_useANDFilter

private

Definition at line 52 of file CosmicEventFilterTool.h.

m_VolumeNames

SG::ReadHandleKeyArray<TrackRecordCollection> ISF::CosmicEventFilterTool::m_VolumeNames

private

Definition at line 51 of file CosmicEventFilterTool.h.

---

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

• CosmicEventFilterTool.h
• CosmicEventFilterTool.cxx