Inheritance diagram for filt::FinalStateSelectFilter:

Public Types
using	ModuleType = EDFilter

using	WorkerType = WorkerT< EDFilter >

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

Public Member Functions
	FinalStateSelectFilter (fhicl::ParameterSet const &)

virtual	~FinalStateSelectFilter ()

bool	filter (art::Event &evt)

void	reconfigure (fhicl::ParameterSet const &p)

void	beginJob ()

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

bool	modifiesEvent () const

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

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

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

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

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

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

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

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

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

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Static Public Attributes
static constexpr bool	Pass {true}

static constexpr bool	Fail {false}

Protected Member Functions
bool	isSubset (std::vector< int > &a, std::vector< int > &aN, std::vector< bool > aNex, std::vector< int > &b, bool IsInclusive)

CurrentProcessingContext const *	currentContext () const

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Attributes
std::string	fGenieModuleLabel

bool	fDebug

bool	fInclusive
	Controls the verbosity. More...

std::vector< int >	fPDG
	Returns events which contain AT LEAST the listed particles. More...

std::vector< int >	fPDGCount
	List of particle PDGs we want to keep. More...

std::vector< bool >	fPDGCountExclusive
	List of N's for the particle PDGs. More...

TH1D *	fSelectedEvents

TH1D *	fTotalEvents

Detailed Description

Definition at line 39 of file FinalStateSelectFilter_module.cc.

Member Typedef Documentation

using art::EDFilter::ModuleType = EDFilter

inherited

Definition at line 37 of file EDFilter.h.

template<typename UserConfig >

using art::EDFilter::Table = ProducerBase::Table<UserConfig>

inherited

Definition at line 46 of file EDFilter.h.

using art::EDFilter::WorkerType = WorkerT<EDFilter>

inherited

Definition at line 38 of file EDFilter.h.

Constructor & Destructor Documentation

filt::FinalStateSelectFilter::FinalStateSelectFilter ( fhicl::ParameterSet const & pset )

explicit

Definition at line 75 of file FinalStateSelectFilter_module.cc.

References reconfigure().

   {   
     this->reconfigure(pset);
   }

filt::FinalStateSelectFilter::~FinalStateSelectFilter ( )

virtual

Definition at line 81 of file FinalStateSelectFilter_module.cc.

82 {

83 }

Member Function Documentation

void filt::FinalStateSelectFilter::beginJob ( )

virtual

Reimplemented from art::EDFilter.

Definition at line 99 of file FinalStateSelectFilter_module.cc.

References fSelectedEvents, fTotalEvents, and art::TFileDirectory::make().

   {
     art::ServiceHandle<art::TFileService> tfs;
     fSelectedEvents = tfs->make<TH1D>("fSelectedEvents", "Number of Selected Events", 3, 0, 3); //counts the number of selected events 
     fTotalEvents = tfs->make<TH1D>("fTotalEvents", "Total Events", 3, 0, 3); //counts the initial number of events in the unfiltered root input file
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDFilter::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDFilter.cc.

References art::EDFilter::current_context_.

   {
     return current_context_.get();
   }

bool filt::FinalStateSelectFilter::filter ( art::Event & evt )

virtual

Implements art::EDFilter.

Definition at line 107 of file FinalStateSelectFilter_module.cc.

References fDebug, fGenieModuleLabel, fInclusive, fPDG, fPDGCount, fPDGCountExclusive, fSelectedEvents, fTotalEvents, art::DataViewImpl::getByLabel(), simb::MCTruth::GetParticle(), isSubset(), simb::MCTruth::NParticles(), and part.

   { 
         
     art::Handle< std::vector<simb::MCTruth> > mclist;
     evt.getByLabel(fGenieModuleLabel,mclist);
     art::Ptr<simb::MCTruth> mc(mclist,0);
     
     fTotalEvents->Fill(1);
 
     std::vector<int> finalstateparticles;
     
     //Guard agaist lazy people not including this 
     if(fPDGCount.size() != 0 || fPDGCountExclusive.size() != 0){
       //Make sure we have all that we need
       if(fPDGCount.size() != fPDG.size() ||
          fPDGCountExclusive.size() != fPDGCount.size() || 
          fPDGCountExclusive.size() != fPDG.size()){
         std::cout << "PDG, PDGCount, and PDGCountExclusivity Vector size mismatch." << std::endl;
         return false;
       }
     }
    
     //get a vector of final state particles   
     std::vector< int > pizeroDecayIndex; 
     std::vector< int > pizeroMotherIndex;
     std::vector< int > pizeroMotherPdg;
     int nPhotons = 0;
     for(int i = 0; i < mc->NParticles(); ++i){
       simb::MCParticle part(mc->GetParticle(i));
       if(part.StatusCode()== 1 && abs(part.PdgCode()) < 100000000 
          && abs(part.PdgCode()) != 12 && abs(part.PdgCode()) != 14 && abs(part.PdgCode()) != 16){       
 
         finalstateparticles.push_back(part.PdgCode());
 
         //This is to address when GENIE doesn't report the direct parent of multiple final state photons 
         if(part.PdgCode() == 22){
           nPhotons++;
           pizeroDecayIndex.push_back(finalstateparticles.size()-1);       
           pizeroMotherIndex.push_back(mc->GetParticle(part.Mother()).TrackId());        
           pizeroMotherPdg.push_back(mc->GetParticle(part.Mother()).PdgCode());  
           if(fDebug) std::cout << "\t \t \t :::  PHOTON with mother : " << mc->GetParticle(part.Mother()).PdgCode() << std::endl; 
         }
       }
     }
 
     //This is to address when GENIE doesn't report the direct parent of final state photons 
     //   We rewrite the PDG of the outcoming photons are the resonance that created them! Just to keep 
     //   things consistent     
     std::vector< int > IndicesToRemove;  
     if(nPhotons >= 2){    
       for(unsigned int i = 0; i < pizeroDecayIndex.size(); i++){
         for(unsigned int j = 0; j < pizeroDecayIndex.size(); j++){
           if(i == j) continue; // don't want to check same elements 
           if(j < 1) continue;  // avoids double counting matches...I think...
           if(pizeroMotherIndex[i] == pizeroMotherIndex[j]){
           
             finalstateparticles.at(pizeroDecayIndex[i]) = -39; //Yes, that is a negative Graviton, safest thing I could think of
             finalstateparticles.at(pizeroDecayIndex[j]) = -39; //Yes, that is a negative Graviton, safest thing I could think of
             finalstateparticles.push_back(pizeroMotherPdg[i]);
           
             std::cout << " ::: I CHANGED ONE OF YOUR PARTICLES!!! " << std::endl;
 
           }
         }
       }
       finalstateparticles.erase(std::remove(finalstateparticles.begin(), finalstateparticles.end(), -39), finalstateparticles.end());
 
     }
 
 
     if(isSubset(fPDG, fPDGCount, fPDGCountExclusive, finalstateparticles,fInclusive)){
       fSelectedEvents->Fill(1);
       if(fDebug) std::cout << "this is a selected event" << std::endl;
     }
 
     // returns true if the user-defined fPDG exist(s) in the final state particles
     return isSubset(fPDG, fPDGCount, fPDGCountExclusive, finalstateparticles, fInclusive); 
 
   } // bool  

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDFilter::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 131 of file EDFilter.h.

References art::EDFilter::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

bool filt::FinalStateSelectFilter::isSubset	(	std::vector< int > &	a,
		std::vector< int > &	aN,
		std::vector< bool >	aNex,
		std::vector< int > &	b,
		bool	IsInclusive
	)

protected

else it is exclusive

Definition at line 190 of file FinalStateSelectFilter_module.cc.

References DEFINE_ART_MODULE, and fDebug.

Referenced by filter().

   {
     // check if the analyzer wants an includive final state
     if(IsInclusive){
       // Sweet, OK, so things get a bit annoying because we want this 
       // to be fairly generic. What I am trying to do is let analyzers 
       // create complicated inclusive final states with exclusive or inclusive 
       // numbers of particles. This requires this "exclusivity" vector
       //
       // an example final state would be NC 1 photon inclusive, 
       // all the analyzer wants is events with EXACTLY 1 photon in the final 
       // state. 
 
       // Create a vector for the exclusivity check;
       std::vector< int > counts(a.size());
 
       //Particle Checking
       //  Iterate through all the wanted PDGs (vector a) and compare
       //  to what we have in the final state (vecotr b). 
       for(unsigned int i = 0; i < a.size(); i++){
         if(std::find(b.begin(), b.end(), a[i]) != b.end()){
           counts[i] = std::count(b.begin(), b.end(), a[i]);
         }
         else{counts[i] = 0;}
       }
       
       //Verify we have the final state we want
       //  Iterate through the full vector and make sure we have at least
       //  as many particles we wanted, also check the exclusivity
       if(aN.size() != 0){
         for(unsigned int i = 0; i < a.size(); i++){
 
           if(aNex[i] == true && counts[i] != aN[i]){
             return false;
           }
           else if(aNex[i] == false && counts[i] < aN[i]){
             return false;
           }
           else if(aNex[i] == false && counts[i] == 0 && aN[i] == 0){
             return false;
           }
 
         }
       }
       // If the count vector size is zero then the user was being lazy...
       // but no one is perfect so I will try to accommodate this. I make the 
       // assumption that they only are asking for final state which contain
       // ANY NUMBER of the requested PDG. If this isn't true then the user
       // should specify all the arguments
       else{
         for(unsigned int i = 0; i < a.size(); i++){
           if(std::find(b.begin(), b.end(), a[i]) == b.end()){
             return false;
           }
         }               
       }
     
       if(fDebug) std::cout << "INCLUSIVE " << std::endl;
       if(fDebug){
         std::cout << "Particle List Selected : " << std::endl; 
         for(unsigned int i = 0; i < b.size(); i++)
           {std::cout << "\t\t PDG : " << b[i] << std::endl;}
       }
       return true;
     }
     else{
       //Exclusive filter is fine too, though I am less excited.
 
       //Verify that all the final state particles in the final state
       //  are what we requested.
       for(unsigned int i = 0; i < b.size(); i++){
         if(std::find(a.begin(), a.end(), b[i]) == a.end()){
           return false;
         }
       }
 
       //Particle Checking
       //  Iterate through all the wanted PDGs (vector a) and compare
       //  to what we have in the final state (vecotr b). Need to count
       //  how many matches we since this is supposed to be the exclusive
       //  portion of the code. 
       std::vector< int > counts(a.size());
 
       for(unsigned int i = 0; i < a.size(); i++){
         
         //Search in b vector is there is the wanted PDG!
         //   If we find it iterate the counter so that we can
         //   check against the wanted counts later, BUT if that
         //   PDG we want isn't in the final state (vector b) then
         //   we want to ditch the event! 
         if(std::find(b.begin(), b.end(), a[i]) != b.end()){
           counts[i] = std::count(b.begin(), b.end(), a[i]);
         }
         // else, ditch the event
         else{
           return false;
         }
       }
             
       // Exclusive Check
       //   iterate through the count vectors and make sure they 
       //   are the same, I am sure there is a smart computer-ing
       //   way to do this but I wrote it this way, if it turns out
       //   to be too slow we can address this. 
       for(unsigned int i = 0; i < aN.size(); i++){      
         if(fDebug) std::cout<< "For: " << a[i] << " Requested N : " << aN[i] << " and found N : " << counts[i] << std::endl; 
         if(aN[i] != counts[i]){
           return false;
         }
       }    
       if(fDebug)      std::cout << "EXCLUSIVE " << std::endl;
       if(fDebug){
         std::cout << "Particle List Selected : " << std::endl; 
         for(unsigned int i = 0; i < b.size(); i++)
           {std::cout << "\t\t PDG : " << b[i] << std::endl;}
       }
       return true;
     }
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

void filt::FinalStateSelectFilter::reconfigure ( fhicl::ParameterSet const & p )

Definition at line 86 of file FinalStateSelectFilter_module.cc.

References fDebug, fGenieModuleLabel, fInclusive, fPDG, fPDGCount, fPDGCountExclusive, and fhicl::ParameterSet::get().

Referenced by FinalStateSelectFilter().

   {
     fDebug             = p.get< bool >("IsVerbose"); 
     fGenieModuleLabel  = p.get< std::string      >("GenieModuleLabel");
     fPDG               = p.get< std::vector<int> >("PDG");
     fInclusive         = p.get< bool >("isInclusive");        
     fPDGCount          = p.get< std::vector<int> >("PDGCount");
     fPDGCountExclusive = p.get< std::vector<bool> >("PDGCountExclusivity");
 
 
   } 

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }