Inheritance diagram for simfilter::FilterSimPhotonLiteTime:

Public Member Functions
	FilterSimPhotonLiteTime (fhicl::ParameterSet const &p, art::ProcessingFrame const &)

	FilterSimPhotonLiteTime (FilterSimPhotonLiteTime const &)=delete

	FilterSimPhotonLiteTime (FilterSimPhotonLiteTime &&)=delete

FilterSimPhotonLiteTime &	operator= (FilterSimPhotonLiteTime const &)=delete

FilterSimPhotonLiteTime &	operator= (FilterSimPhotonLiteTime &&)=delete

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

template<typename Config >
	SharedFilter (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)

Public Member Functions inherited from art::detail::SharedModule
	SharedModule ()

	SharedModule (std::string const &moduleLabel)

hep::concurrency::SerialTaskQueueChain *	serialTaskQueueChain () const

std::set< std::string > const &	sharedResources () const

void	createQueues (SharedResources const &resources)

template<BranchType , typename... T>
void	serialize (T const &...resources)

template<BranchType , typename... T>
void	serializeExternal (T const &...resources)

Private Member Functions
bool	filter (art::Event &e, art::ProcessingFrame const &) override

void	CheckTimeWindows () const

Private Attributes
std::string const	fSimPhotonsLiteCollectionLabel
	Label for the sim::SimPhotonsLite data product. More...

std::vector< std::pair< int, int > > const	fTimeWindows
	Time windows used for filtering. Units are the same as in the sim::SimPhotonsLite. More...

int const	fMinTotalPhotons
	Minimum number of photons inside a window to pass the filter. More...

bool const	fDebug
	Set to true to print (a lot of) debug information. More...

std::size_t const	fN
	Number of time winows. More...

bool const	fUseReflectedPhotons
	Whether to include reflected photons in the filter. More...

std::string const	fReflectedLabel
	Label for the reflected photons – "Reflected" by default. More...

Additional Inherited Members
Public Types inherited from art::SharedFilter
using	ModuleType = SharedFilter

using	WorkerType = WorkerT< SharedFilter >

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 >

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 ()

Protected Member Functions inherited from art::detail::SharedModule
template<BranchType BT = InEvent, typename... T>
void	serialize (T const &...)

template<BranchType BT = InEvent, typename... T>
void	serializeExternal (T const &...)

template<BranchType BT = InEvent>
void	async ()

Detailed Description

Definition at line 32 of file FilterSimPhotonLiteTime_module.cc.

Constructor & Destructor Documentation

simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime	(	fhicl::ParameterSet const &	p,
		art::ProcessingFrame const &
	)

explicit

Definition at line 58 of file FilterSimPhotonLiteTime_module.cc.

   : SharedFilter{p}
   , fSimPhotonsLiteCollectionLabel(p.get<std::string>("SimPhotonsLiteCollectionLabel"))
   , fTimeWindows(p.get<std::vector<std::pair<int, int>>>("TimeWindows"))
   , fMinTotalPhotons(p.get<int>("MinTotalPhotons"))
   , fDebug(p.get<bool>("Debug", false))
   , fN(fTimeWindows.size())
   , fUseReflectedPhotons(p.get<bool>("UseReflectedPhotons", false))
   , fReflectedLabel(p.get<std::string>("ReflectedLabel", "Reflected"))
 {
   CheckTimeWindows();
 
   // For printing out debug messages, we want to serialize the
   // event-level calls so that the messages are not garbled.
   // Otherwise, this module works well for asynchronous event-level
   // calls.
   if (fDebug) { serialize(); }
   else {
     async<art::InEvent>();
   }
 }

simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime ( FilterSimPhotonLiteTime const & )

delete

simfilter::FilterSimPhotonLiteTime::FilterSimPhotonLiteTime ( FilterSimPhotonLiteTime && )

delete

Member Function Documentation

void simfilter::FilterSimPhotonLiteTime::CheckTimeWindows ( ) const

private

Definition at line 82 of file FilterSimPhotonLiteTime_module.cc.

 {
 
   if (fDebug)
     std::cout << "\tFilterSimPhotonLiteTime: TimeWindows size is " << fTimeWindows.size()
               << std::endl;
 
   for (auto const& tw : fTimeWindows) {
     if (fDebug)
       std::cout << "\t\tTimeWindow "
                 << "[" << tw.first << "," << tw.second << "]" << std::endl;
 
     if (tw.first > tw.second)
       throw cet::exception("FilterSimPhotonLiteTime::CheckTimeWindows")
         << "Bad time window initialization: tw.first>tw.second. Reverse the order!" << std::endl;
   }
 }

bool simfilter::FilterSimPhotonLiteTime::filter	(	art::Event &	e,
		art::ProcessingFrame const &
	)

overrideprivatevirtual

Implements art::SharedFilter.

Definition at line 101 of file FilterSimPhotonLiteTime_module.cc.

 {
   auto const& simPhotonsLiteCollection =
     *e.getValidHandle<std::vector<sim::SimPhotonsLite>>(fSimPhotonsLiteCollectionLabel);
 
   std::vector<int> sumNPhotonArray(fN, 0);
 
   const std::vector<sim::SimPhotonsLite>& simPhotonsLiteCollectionReflected =
     fUseReflectedPhotons ? *e.getValidHandle<std::vector<sim::SimPhotonsLite>>(
                              {fSimPhotonsLiteCollectionLabel, fReflectedLabel}) :
                            std::vector<sim::SimPhotonsLite>();
 
   size_t n_sim_photons = simPhotonsLiteCollection.size() + simPhotonsLiteCollectionReflected.size();
 
   if (fDebug) {
     std::cout << "New event to filter with total # sim photons: " << n_sim_photons << std::endl;
   }
 
   for (size_t i_pc = 0; i_pc < n_sim_photons; i_pc++) {
     const sim::SimPhotonsLite& simphotonslite =
       (i_pc < simPhotonsLiteCollection.size()) ?
         simPhotonsLiteCollection[i_pc] :
         simPhotonsLiteCollectionReflected[i_pc - simPhotonsLiteCollection.size()];
 
     if (fDebug)
       std::cout << "\tFilterSimPhotonLiteTime: Processing simphotonslite channel "
                 << simphotonslite.OpChannel << std::endl;
 
     for (auto const& photon_pair : simphotonslite.DetectedPhotons) {
       for (size_t i_tw = 0; i_tw < fN; i_tw++) {
         auto const& tw(fTimeWindows[i_tw]);
         if (photon_pair.first >= tw.first && photon_pair.first <= tw.second) {
 
           if (fDebug) {
             std::string photon_string =
               (i_pc < simPhotonsLiteCollection.size()) ? "Photon" : "Reflected Photon";
             std::cout << "\t\t" << photon_string << " with number " << photon_pair.second
                       << " at time " << photon_pair.first << " detected." << std::endl;
           }
 
           sumNPhotonArray[i_tw] += photon_pair.second;
 
           if (fDebug)
             std::cout << "\t\tTotal number of photons in this window (" << i_tw << ") is now "
                       << sumNPhotonArray[i_tw] << std::endl;
 
           if (sumNPhotonArray[i_tw] >= fMinTotalPhotons) return true;
         }
       }
     }
   }
 
   if (fDebug) {
     std::cout << "\tFilterSimPhotonLiteTime: Final total numbers are below min of "
               << fMinTotalPhotons << ":" << std::endl;
     for (size_t i_tw = 0; i_tw < fN; ++i_tw) {
       std::cout << "\t\tTimeWindow "
                 << "[" << fTimeWindows[i_tw].first << "," << fTimeWindows[i_tw].second
                 << "]: " << sumNPhotonArray[i_tw] << std::endl;
     }
   }
 
   return false;
 }