Inheritance diagram for DuneEventFilter:

Public Types
using	Index = unsigned int

using	IndexVector = std::vector< Index >

using	IndexSet = std::set< Index >

using	Name = std::string

Public Types inherited from art::EDFilter
using	ModuleType = EDFilter

using	WorkerType = WorkerT< EDFilter >

Public Types inherited from art::detail::Filter
template<typename UserConfig >
using	Table = Modifier::Table< UserConfig >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	DuneEventFilter (fhicl::ParameterSet const &pset)

virtual	~DuneEventFilter ()

virtual bool	filter (art::Event &e)

Public Member Functions inherited from art::EDFilter
	EDFilter (fhicl::ParameterSet const &pset)

template<typename Config >
	EDFilter (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Filter
virtual	~Filter () noexcept

	Filter (fhicl::ParameterSet const &)

	Filter (Filter const &)=delete

	Filter (Filter &&)=delete

Filter &	operator= (Filter const &)=delete

Filter &	operator= (Filter &&)=delete

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Additional Inherited Members
Static Public Attributes inherited from art::detail::Filter
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Definition at line 34 of file DuneEventFilter_module.cc.

Member Typedef Documentation

using DuneEventFilter::Index = unsigned int

Definition at line 38 of file DuneEventFilter_module.cc.

using DuneEventFilter::IndexSet = std::set<Index>

Definition at line 40 of file DuneEventFilter_module.cc.

using DuneEventFilter::IndexVector = std::vector<Index>

Definition at line 39 of file DuneEventFilter_module.cc.

using DuneEventFilter::Name = std::string

Definition at line 41 of file DuneEventFilter_module.cc.

Constructor & Destructor Documentation

DuneEventFilter::DuneEventFilter ( fhicl::ParameterSet const & pset )

explicit

Definition at line 75 of file DuneEventFilter_module.cc.

 : EDFilter(pset),
   m_LogLevel(pset.get<Index>("LogLevel")),
   m_SelectEventVector(pset.get<IndexVector>("SelectEvents")),
   m_RejectEventVector(pset.get<IndexVector>("RejectEvents")),
   m_EventBegin(pset.get<Index>("EventBegin")),
   m_EventEnd(pset.get<Index>("EventEnd")),
   m_EventModFreq(pset.get<Index>("EventModFreq")),
   m_EventModVal(pset.get<Index>("EventModVal")),
   m_JobIndexRangeTool(pset.get<Name>("JobIndexRangeTool")),
   m_SkipEventTool(pset.get<Name>("SkipEventTool")),
   m_beginEvent(0), m_endEvent(0),
   m_pSkipEventTool(nullptr),
   m_nproc(0), m_nsel(0) {
   using std::cout;
   using std::endl;
   using std::string;
   const string myname = "DuneEventFilter::ctor: ";
   for ( Index ievt : m_SelectEventVector ) m_SelectEvents.insert(ievt);
   for ( Index ievt : m_RejectEventVector ) m_RejectEvents.insert(ievt);
   if ( m_LogLevel >= 1 ) {
     cout << myname << "      LogLevel: " << m_LogLevel << endl;
     cout << myname << "  SelectEvents: [";
     bool first = true;
     for ( unsigned int ievt : m_SelectEvents ) {
       if ( first ) first = false;
       else cout << ", ";
       cout << ievt;
     }
     cout << "]" << endl;
     cout << myname << "  RejectEvents: [";
     first = true;
     for ( unsigned int ievt : m_RejectEvents ) {
       if ( first ) first = false;
       else cout << ", ";
       cout << ievt;
     }
     cout << "]" << endl;
     cout << myname << "         EventBegin: " << m_EventBegin << endl;
     cout << myname << "           EventEnd: " << m_EventEnd << endl;
     cout << myname << "        EventModVal: " << m_EventModVal << endl;
     cout << myname << "       EventModFreq: " << m_EventModFreq << endl;
     cout << myname << "  JobIndexRangeTool: " << m_JobIndexRangeTool << endl;
     cout << myname << "      SkipEventTool: " << m_SkipEventTool << endl;
   }
   if ( m_EventEnd > m_EventBegin ) {
     m_beginEvent = m_EventBegin;
     m_endEvent = m_EventEnd;
   } else if ( m_JobIndexRangeTool.size() ) {
     DuneToolManager* ptm = DuneToolManager::instance();
     const IndexRangeTool* pjrt = ptm->getShared<IndexRangeTool>(m_JobIndexRangeTool);
     if ( pjrt == nullptr ) {
       cout << myname << "ERROR: Job index range tool not found: " << m_JobIndexRangeTool << endl;
     } else {
       IndexRange ran = pjrt->get("events");
       if ( ! ran.isValid() ) {
         cout << myname << "Event range is unrestricted." << endl;
       } else {
         m_beginEvent = ran.begin;
         m_endEvent = ran.end;
       }
     }
   }
   if ( m_endEvent > m_beginEvent ) {
     cout << myname << "Event selection range is [" << m_beginEvent << ", "
          << m_endEvent << ")." << endl;
   } else {
     cout << myname << "No event selection range." << endl;
   }
   if ( m_SkipEventTool.size() ) {
     DuneToolManager* ptm = DuneToolManager::instance();
     m_pSkipEventTool = ptm->getShared<IndexVectorMapTool>(m_SkipEventTool);
     if ( m_pSkipEventTool == nullptr ) {
       cout << "WARNING: Unable to find SkipEventTool " << m_SkipEventTool << endl;
     } else {
       cout << myname << "Using SkipEventTool @" << m_pSkipEventTool << endl;
     }
   }
 }

DuneEventFilter::~DuneEventFilter ( )

virtual

Definition at line 187 of file DuneEventFilter_module.cc.

                                   {
   using std::cout;
   using std::endl;
   using std::string;
   const string myname = "DuneEventFilter::dtor: ";
   if ( m_LogLevel >= 1 ) {
     float fsel = double(m_nsel)/double(m_nproc);
     cout << myname << " Events processed: " << m_nproc << endl;
     cout << myname << "  Events selected: " << m_nsel << " (" << fsel << ")" << endl;
   }
 }

Member Function Documentation

bool DuneEventFilter::filter ( art::Event & e )

virtual

Implements art::EDFilter.

Definition at line 157 of file DuneEventFilter_module.cc.

                                            {
   using std::cout;
   using std::endl;
   using std::string;
   const string myname = "DuneEventFilter::filter: ";
   Index ievt = evt.event();
   ++m_nproc;
   bool keep = true;
   if ( keep && m_SelectEvents.size() ) keep = m_SelectEvents.count(ievt);
   if ( keep ) keep = m_RejectEvents.count(ievt) == 0;
   if ( keep && m_endEvent > m_beginEvent ) keep = ievt >= m_beginEvent && ievt < m_endEvent;
   if ( keep && m_EventModFreq ) keep = (ievt % m_EventModFreq) == m_EventModVal;
   if ( keep && m_pSkipEventTool != nullptr ) {
     const IndexVector& skipEvents = m_pSkipEventTool->get(evt.run());
     if ( find(skipEvents.begin(), skipEvents.end(), ievt) != skipEvents.end() ) {
       keep = false;
       if ( m_LogLevel >= 3 ) {
         cout << myname << "  Event " << ievt << " rejected by SkipEventTool" << endl;
       }
     }
   }
   if ( m_LogLevel >= 2 ) {
     cout << myname << (keep ? "Sel" : "Rej") << "ecting event " << ievt << endl;
   }
   if ( keep ) ++m_nsel;
   return keep;
 }

Member Data Documentation

Index DuneEventFilter::m_beginEvent

private

Definition at line 61 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_endEvent

private

Definition at line 62 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_EventBegin

private

Definition at line 53 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_EventEnd

private

Definition at line 54 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_EventModFreq

private

Definition at line 55 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_EventModVal

private

Definition at line 56 of file DuneEventFilter_module.cc.

Name DuneEventFilter::m_JobIndexRangeTool

private

Definition at line 57 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_LogLevel

private

Definition at line 50 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_nproc

private

Definition at line 68 of file DuneEventFilter_module.cc.

Index DuneEventFilter::m_nsel

private

Definition at line 69 of file DuneEventFilter_module.cc.

const IndexVectorMapTool* DuneEventFilter::m_pSkipEventTool

private

Definition at line 65 of file DuneEventFilter_module.cc.

IndexSet DuneEventFilter::m_RejectEvents

private

Definition at line 64 of file DuneEventFilter_module.cc.

IndexVector DuneEventFilter::m_RejectEventVector

private

Definition at line 52 of file DuneEventFilter_module.cc.

IndexSet DuneEventFilter::m_SelectEvents

private

Definition at line 63 of file DuneEventFilter_module.cc.

IndexVector DuneEventFilter::m_SelectEventVector

private

Definition at line 51 of file DuneEventFilter_module.cc.

Name DuneEventFilter::m_SkipEventTool

private

Definition at line 58 of file DuneEventFilter_module.cc.

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

duneana/duneana/EventFilters/DuneEventFilter_module.cc

Private Attributes
Index	m_LogLevel

IndexVector	m_SelectEventVector

IndexVector	m_RejectEventVector

Index	m_EventBegin

Index	m_EventEnd

Index	m_EventModFreq

Index	m_EventModVal

Name	m_JobIndexRangeTool

Name	m_SkipEventTool

Index	m_beginEvent

Index	m_endEvent

IndexSet	m_SelectEvents

IndexSet	m_RejectEvents

const IndexVectorMapTool *	m_pSkipEventTool

Index	m_nproc

Index	m_nsel

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation