filt::EmptyFilter Class Reference

Inheritance diagram for filt::EmptyFilter:

Public Types
using	ModuleType = EDFilter
using	WorkerType = WorkerT< EDFilter >
template<typename UserConfig >
using	Table = ProducerBase::Table< UserConfig >

Public Member Functions
	EmptyFilter (fhicl::ParameterSet const &)
virtual	~EmptyFilter ()
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
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	fHitsModuleLabel
double	fMinIonization
int	fMinNumHits
TH1I *	totHitHist
TH1I *	selHitHist
TH1I *	rejHitHist
TH2D *	totIonSelHist
TH2D *	totIonRejHist
TH1I *	numEventHist
TH2I *	resultTable

Detailed Description

Definition at line 44 of file EmptyFilter_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::EmptyFilter::EmptyFilter ( fhicl::ParameterSet const &  pset )

explicit

Definition at line 75 of file EmptyFilter_module.cc.

References reconfigure().

  {   
    this->reconfigure(pset);
  }

filt::EmptyFilter::~EmptyFilter ( )

virtual

Definition at line 81 of file EmptyFilter_module.cc.

  {
  }

Member Function Documentation

void filt::EmptyFilter::beginJob ( )

virtual

Reimplemented from art::EDFilter.

Definition at line 94 of file EmptyFilter_module.cc.

References art::TFileDirectory::make(), numEventHist, rejHitHist, resultTable, selHitHist, totHitHist, totIonRejHist, and totIonSelHist.

  {
    art::ServiceHandle<art::TFileService> tfs;
    totHitHist = tfs->make<TH1I>("totHitHist","Hit Number Per Event",750,0,1500);
    totIonSelHist = tfs->make<TH2D>("totIonSelHist","Ionization Per selected Event",500,0,20000,500,0,20000);
    totIonRejHist = tfs->make<TH2D>("totIonRejHist","Ionization Per rejected Event",500,0,20000,500,0,20000);
    selHitHist= tfs->make<TH1I>("selHitHist","Hit Number Per selected  Event",750, 0 ,1500);
    rejHitHist= tfs->make<TH1I>("rejHitHist","Hit Number Per rejected Event",750, 0 ,1500);
    numEventHist = tfs->make<TH1I>("numEventHist","Number of Events Processed and Selected",2,0,2);
    resultTable = tfs->make<TH2I>("resultTable","Event number is x axis, y axis bins 0=selected,1= hit num, 2= one plane empty, 3= too little ionization",40000,0,40000,4,0,4);
 
  }

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::EmptyFilter::filter ( art::Event &  evt )

virtual

Implements art::EDFilter.

Definition at line 108 of file EmptyFilter_module.cc.

References DEFINE_ART_MODULE, art::EventID::event(), fHitsModuleLabel, fMinIonization, fMinNumHits, art::DataViewImpl::getByLabel(), art::Event::id(), numEventHist, art::PtrVector< T >::push_back(), rejHitHist, resultTable, selHitHist, art::PtrVector< T >::size(), totHitHist, totIonRejHist, and totIonSelHist.

  { 

    numEventHist->Fill(0);
    int failFlag = 0;
    double indIon(0.0), colIon(0.0);
    int event = evt.id().event();
    
    art::ServiceHandle<geo::Geometry> geom;
    art::Handle< std::vector<recob::Hit> > hitHandle;
    evt.getByLabel(fHitsModuleLabel,hitHandle);
    art::PtrVector<recob::Hit> hitvec;
    for(unsigned int i = 0; i < hitHandle->size(); ++i){
      art::Ptr<recob::Hit> prod(hitHandle, i);
      hitvec.push_back(prod);
    }

    int numHits = hitvec.size();
    if( numHits> 0) {
      totHitHist->Fill(numHits);
      if(numHits < fMinNumHits) {
        mf::LogWarning("EmptyFilterModule") << "Too few hits: "<< numHits;
        failFlag=1;  
      }  
      if(failFlag==0) {
        //Check to see if either plane is empty
/* BB: This code section is broken.
        if(geom->Cryostat(cs).TPC(tpc).Plane(plane).SignalType() == geo::kInduction){ 
          std::cout << "Induction empty." << std::endl;
          failFlag=2;
        }
*/
        unsigned int j(0);  
        //advances j to collection plane
        while(hitvec[j]->WireID().Plane == 0) {
          indIon+=hitvec[j]->Integral();
          j++;
          if(j == hitvec.size()) {
            failFlag=2;
            mf::LogWarning("EmptyFilterModule") << "Collection empty.";
          }
        }
        for(; j < hitvec.size(); j++){
          colIon+=hitvec[j]->Integral();
        }
        double minIon=0;
        if((1.92*indIon)>colIon) minIon = colIon;
        else minIon=1.92*indIon;
        mf::LogWarning("EmptyFilterModule") <<"min ionization " << minIon 
                                            << " " << fMinIonization;
        if (minIon < fMinIonization) failFlag=3;
      }
    }
    else failFlag = 1; 
    resultTable->Fill(event,failFlag);   
    if(failFlag>0){
      totIonRejHist->Fill(indIon,colIon);
      rejHitHist->Fill(numHits); 
      return  false;
    }
    numEventHist->Fill(1);
    totIonSelHist->Fill(indIon,colIon);
    selHitHist->Fill(numHits);
  
    return true;
  }

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

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.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

{
  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::EmptyFilter::reconfigure

(

fhicl::ParameterSet const &

p

)

Definition at line 86 of file EmptyFilter_module.cc.

References fHitsModuleLabel, fMinIonization, fMinNumHits, and fhicl::ParameterSet::get().

Referenced by EmptyFilter().

  {
    fHitsModuleLabel = p.get< std::string > ("HitsModuleLabel"); 
    fMinIonization =   p.get< double      > ("MinIonization"); 
    fMinNumHits =      p.get< int         > ("MinHits");        
  } 

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);
}

Member Data Documentation

constexpr bool art::EDFilter::Fail {false}

staticinherited

Definition at line 33 of file EDFilter.h.

std::string filt::EmptyFilter::fHitsModuleLabel

private

Definition at line 59 of file EmptyFilter_module.cc.

Referenced by filter(), and reconfigure().

double filt::EmptyFilter::fMinIonization

private

Definition at line 60 of file EmptyFilter_module.cc.

Referenced by filter(), and reconfigure().

int filt::EmptyFilter::fMinNumHits

private

Definition at line 61 of file EmptyFilter_module.cc.

Referenced by filter(), and reconfigure().

TH1I* filt::EmptyFilter::numEventHist

private

Definition at line 67 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

constexpr bool art::EDFilter::Pass {true}

staticinherited

Definition at line 32 of file EDFilter.h.

TH1I* filt::EmptyFilter::rejHitHist

private

Definition at line 64 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH2I* filt::EmptyFilter::resultTable

private

Definition at line 68 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH1I* filt::EmptyFilter::selHitHist

private

Definition at line 63 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH1I* filt::EmptyFilter::totHitHist

private

Definition at line 62 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH2D* filt::EmptyFilter::totIonRejHist

private

Definition at line 66 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

TH2D* filt::EmptyFilter::totIonSelHist

private

Definition at line 65 of file EmptyFilter_module.cc.

Referenced by beginJob(), and filter().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larevt/v07_02_01/source/larevt/Filters/EmptyFilter_module.cc