Inheritance diagram for simfilter::FilterGenInTime:

Public Types
using	ModuleType = EDFilter

template<typename UserConfig >
using	Table = Modifier::Table< UserConfig >

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

bool	filter (art::Event &)

virtual void	beginJob ()

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

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

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

Static Public Attributes
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions
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 ()

Private Member Functions
bool	KeepParticle (simb::MCParticle const &part) const

Private Attributes
std::vector< std::array< double, 6 > >	fCryostatBoundaries
	boundaries of each cryostat More...

double	fMinKE

bool	fKeepOnlyMuons

double	fMinT

double	fMaxT

bool	fSortParticles

bool	fAlwaysPass

Detailed Description

Definition at line 38 of file FilterGenInTime_module.cc.

Member Typedef Documentation

using art::EDFilter::ModuleType = EDFilter

inherited

Definition at line 18 of file EDFilter.h.

template<typename UserConfig >

using art::detail::Filter::Table = Modifier::Table<UserConfig>

inherited

Definition at line 32 of file Filter.h.

Constructor & Destructor Documentation

simfilter::FilterGenInTime::FilterGenInTime ( fhicl::ParameterSet const & pset )

explicit

Definition at line 61 of file FilterGenInTime_module.cc.

References fAlwaysPass, fKeepOnlyMuons, fMaxT, fMinKE, fMinT, and fSortParticles.

     : EDFilter{pset}
     , fMinKE(pset.get<double>("MinEnergy", 0.0))
     , fKeepOnlyMuons(pset.get<bool>("KeepOnlyMuons", false))
     , fMinT(pset.get<double>("MinT", 0.0))
     , fMaxT(pset.get<double>("MaxT"))
     , fSortParticles(pset.get<bool>("SortParticles", false))
     , fAlwaysPass(pset.get<bool>("AlwaysPass", false))
   {
     if (fSortParticles) {
       produces<std::vector<simb::MCTruth>>("intime");
       produces<std::vector<simb::MCTruth>>("outtime");
     }
     std::cout << "New Filter!\n";
   }

Member Function Documentation

void simfilter::FilterGenInTime::beginJob ( )

virtual

Reimplemented from art::EDFilter.

Definition at line 77 of file FilterGenInTime_module.cc.

References fCryostatBoundaries.

   {
     auto const& geom = *art::ServiceHandle<geo::Geometry const>();
     for (auto const& cryo : geom.Iterate<geo::CryostatGeo>()) {
       std::array<double, 6> this_cryo_boundaries{};
       cryo.Boundaries(&this_cryo_boundaries[0]);
       fCryostatBoundaries.push_back(this_cryo_boundaries);
     }
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Filter::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 29 of file Filter.cc.

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Filter::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 72 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = beginRunWithFrame(r, frame);
     r.commitProducts();
     return rc;
   }

bool art::detail::Filter::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return rc;
   }

void art::detail::Filter::doEndJob ( )

inherited

Definition at line 37 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Filter::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 82 of file Filter.cc.

References art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = endRunWithFrame(r, frame);
     r.commitProducts();
     return rc;
   }

bool art::detail::Filter::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 102 of file Filter.cc.

References art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return rc;
   }

bool art::detail::Filter::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
	)

inherited

Definition at line 112 of file Filter.cc.

References e, art::EventPrincipal::makeEvent(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     bool const rc = filterWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     if (rc) {
       ++counts_passed;
     } else {
       ++counts_failed;
     }
     return rc;
   }

void art::detail::Filter::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 51 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Filter::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 65 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Filter::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Filter::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Filter.cc.

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

bool simfilter::FilterGenInTime::filter ( art::Event & evt )

virtual

Implements art::EDFilter.

Definition at line 208 of file FilterGenInTime_module.cc.

References util::abs(), simb::MCTruth::Add(), DEFINE_ART_MODULE, simb::MCParticle::E(), fAlwaysPass, fKeepOnlyMuons, fMinKE, fSortParticles, art::ProductRetriever::getMany(), simb::MCTruth::GetParticle(), ipart, KeepParticle(), simb::MCParticle::Mass(), simb::MCTruth::NParticles(), simb::MCParticle::PdgCode(), and art::Event::put().

   {
 
     std::unique_ptr<std::vector<simb::MCTruth>> truthInTimePtr(new std::vector<simb::MCTruth>(1));
     std::unique_ptr<std::vector<simb::MCTruth>> truthOutOfTimePtr(
       new std::vector<simb::MCTruth>(1));
 
     simb::MCTruth& truthInTime = truthInTimePtr->at(0);
     simb::MCTruth& truthOutOfTime = truthOutOfTimePtr->at(0);
 
     //get the list of particles from this event
     art::ServiceHandle<geo::Geometry const> geom;
 
     //std::vector< art::Handle< std::vector<simb::MCTruth> > > allmclists;
     //evt.getManyByType(allmclists);
     auto allmclists = evt.getMany<std::vector<simb::MCTruth>>();
     bool keepEvent = false;
     for (size_t mcl = 0; mcl < allmclists.size(); ++mcl) {
       art::Handle<std::vector<simb::MCTruth>> mclistHandle = allmclists[mcl];
       for (size_t m = 0; m < mclistHandle->size(); ++m) {
         art::Ptr<simb::MCTruth> mct(mclistHandle, m);
 
         for (int ipart = 0; ipart < mct->NParticles(); ipart++) {
           bool kp = KeepParticle(mct->GetParticle(ipart));
 
           if (kp && (!fKeepOnlyMuons || abs(mct->GetParticle(ipart).PdgCode()) == 13) &&
               mct->GetParticle(ipart).E() - mct->GetParticle(ipart).Mass() > fMinKE) {
             keepEvent = true;
             if (!fSortParticles) break;
           }
 
           if (fSortParticles) {
             simb::MCParticle particle = mct->GetParticle(ipart);
             if (kp) truthInTime.Add(particle);
             if (!kp) truthOutOfTime.Add(particle);
           }
 
         } //end loop over particles
 
         if (!fSortParticles && keepEvent) break;
 
       } //end loop over mctruth col
 
       if (!fSortParticles && keepEvent) break;
 
     } //end loop over all mctruth lists
 
     if (fSortParticles) {
       evt.put(std::move(truthInTimePtr), "intime");
       evt.put(std::move(truthOutOfTimePtr), "outtime");
     }
 
     return (keepEvent || fAlwaysPass);
   }

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

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

bool simfilter::FilterGenInTime::KeepParticle ( simb::MCParticle const & part ) const

private

Definition at line 87 of file FilterGenInTime_module.cc.

References util::abs(), geo::vect::coord(), e, simb::MCParticle::E(), fCryostatBoundaries, fMaxT, fMinT, simb::MCParticle::Mass(), simb::MCParticle::Momentum(), simb::MCParticle::Position(), and simb::MCParticle::T().

Referenced by filter().

   {
     const TLorentzVector& v4 = part.Position();
     const TLorentzVector& p4 = part.Momentum();
     // origin of particle
     double x0[3] = {v4.X(), v4.Y(), v4.Z()};
     // normalized direction of particle
     double dx[3] = {
       p4.Px() / p4.Vect().Mag(), p4.Py() / p4.Vect().Mag(), p4.Pz() / p4.Vect().Mag()};
 
     // tolernace for treating number as "zero"
     double eps = 1e-5;
 
     //check to see if particle crosses boundary of any cryostat within appropriate time window
     std::vector<bool> intersects_cryo(fCryostatBoundaries.size(), false);
     std::vector<bool> inside_cryo(fCryostatBoundaries.size(), false);
     std::vector<double> distance_to_cryo(fCryostatBoundaries.size(), 0.);
 
     // Check to see if particle intersects any cryostat
     //
     // Algorithmically, this is looking for ray-box intersection. This is a common problem in
     // computer graphics. The algorithm below is taken from "Graphics Gems", Academic Press, 1990
     for (size_t i_cryo = 0; i_cryo < fCryostatBoundaries.size(); i_cryo++) {
       auto const& bound = fCryostatBoundaries[i_cryo];
       std::array<int, 3> quadrant{}; // 0 == RIGHT, 1 == LEFT, 2 == MIDDLE
       std::array<double, 3> candidatePlane{};
       std::array<double, 3> coord{};
 
       std::array<double, 3> bound_lo = {{bound[0], bound[2], bound[4]}};
       std::array<double, 3> bound_hi = {{bound[1], bound[3], bound[5]}};
 
       // First check if origin is inside box
       // Also check which of the two planes in each dimmension is the
       // "candidate" for the ray to hit
       bool inside = true;
       for (int i = 0; i < 3; i++) {
         if (x0[i] < bound_lo[i]) {
           quadrant[i] = 1; // LEFT
           candidatePlane[i] = bound_lo[i];
           inside = false;
         }
         else if (x0[i] > bound_hi[i]) {
           quadrant[i] = 0; // RIGHT
           candidatePlane[i] = bound_hi[i];
           inside = false;
         }
         else {
           quadrant[i] = 2; // MIDDLE
         }
       }
 
       if (inside) {
         inside_cryo[i_cryo] = true;
         // if we're inside the cryostat, then we do intersect it
         intersects_cryo[i_cryo] = true;
         continue;
       }
 
       // ray origin is outside the box -- calculate the distance to the cryostat and see if it intersects
 
       // calculate distances to candidate planes
       std::array<double, 3> maxT{};
       for (int i = 0; i < 3; i++) {
         if (quadrant[i] != 2 /* MIDDLE */ && abs(dx[i]) > eps) {
           maxT[i] = (candidatePlane[i] - x0[i]) / dx[i];
         }
         // if a ray origin is between two the two planes in a dimmension, it would never hit that plane first
         else {
           maxT[i] = -1;
         }
       }
 
       // The plane on the box that the ray hits is the one with the largest distance
       int whichPlane = 0;
       for (int i = 1; i < 3; i++) {
         if (maxT[whichPlane] < maxT[i]) whichPlane = i;
       }
 
       // check if the candidate intersection point is inside the box
 
       // no intersection
       if (maxT[whichPlane] < 0.) {
         intersects_cryo[i_cryo] = false;
         continue;
       }
 
       for (int i = 0; i < 3; i++) {
         if (whichPlane != i) { coord[i] = x0[i] + maxT[whichPlane] * dx[i]; }
         else {
           coord[i] = candidatePlane[i];
         }
       }
 
       // check if intersection is in box
       intersects_cryo[i_cryo] = true;
       for (int i = 0; i < 3; i++) {
         if (coord[i] < bound_lo[i] || coord[i] > bound_hi[i]) { intersects_cryo[i_cryo] = false; }
       }
 
       if (intersects_cryo[i_cryo]) { distance_to_cryo[i_cryo] = maxT[whichPlane]; }
     }
 
     // check if any cryostats are intersected in-time
     for (size_t i_cryo = 0; i_cryo < fCryostatBoundaries.size(); i_cryo++) {
 
       // If the particle originates inside the cryostat, then
       // we can't really say when it will leave. Thus, accept
       // the particle
       if (inside_cryo[i_cryo]) { return true; }
       // otherwise check arrival time at boundary of cryostat
       if (intersects_cryo[i_cryo]) {
         double ptime = (distance_to_cryo[i_cryo] * 1e-2 /* cm -> m */) /
                        (TMath::C() * sqrt(1 - pow(part.Mass() / part.E(), 2))) /* velocity */;
         double totT = part.T() + ptime * 1e9 /* s -> ns */;
         if (totT > fMinT && totT < fMaxT) { return true; }
       }
     }
 
     return false;
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

Member Data Documentation

constexpr bool art::detail::Filter::Fail {false}

staticinherited

Definition at line 29 of file Filter.h.

bool simfilter::FilterGenInTime::fAlwaysPass

private

Definition at line 54 of file FilterGenInTime_module.cc.

Referenced by filter(), and FilterGenInTime().

std::vector<std::array<double, 6> > simfilter::FilterGenInTime::fCryostatBoundaries

private

boundaries of each cryostat

Definition at line 49 of file FilterGenInTime_module.cc.

Referenced by beginJob(), and KeepParticle().

bool simfilter::FilterGenInTime::fKeepOnlyMuons

private

Definition at line 51 of file FilterGenInTime_module.cc.

Referenced by filter(), and FilterGenInTime().

double simfilter::FilterGenInTime::fMaxT

private

Definition at line 52 of file FilterGenInTime_module.cc.

Referenced by FilterGenInTime(), and KeepParticle().

double simfilter::FilterGenInTime::fMinKE

private

Definition at line 50 of file FilterGenInTime_module.cc.

Referenced by filter(), and FilterGenInTime().

double simfilter::FilterGenInTime::fMinT

private

Definition at line 52 of file FilterGenInTime_module.cc.

Referenced by FilterGenInTime(), and KeepParticle().

bool simfilter::FilterGenInTime::fSortParticles

private

Definition at line 53 of file FilterGenInTime_module.cc.

Referenced by filter(), and FilterGenInTime().

constexpr bool art::detail::Filter::Pass {true}

staticinherited

Definition at line 28 of file Filter.h.

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

larsim/v09_43_00/source/larsim/SimFilters/FilterGenInTime_module.cc

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation