cluster::SmallClusterFilter Class Reference

Inheritance diagram for cluster::SmallClusterFilter:

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

Public Member Functions
	SmallClusterFilter (fhicl::ParameterSet const &pset)
virtual	~SmallClusterFilter ()
void	beginJob ()
bool	beginRun (art::Run &run)
void	reconfigure (fhicl::ParameterSet const &pset)
bool	filter (art::Event &evt)
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 Member Functions
void	ClearandResizeVectors (unsigned int nHits)
void	GetPlaneAndTPC (art::Ptr< recob::Hit > a, unsigned int &p, unsigned int &cs, unsigned int &t, unsigned int &w)

Private Attributes
art::ServiceHandle< geo::Geometry >	geom
	handle to geometry service More...
const detinfo::DetectorProperties *	detp = lar::providerFrom<detinfo::DetectorPropertiesService>()
	const ptr to det properties data provider More...
util::GeometryUtilities	gser
	geometry utilities More...
std::vector< unsigned int >	fNWires
	Number of wires on each plane. More...
std::string	fHitFinderModuleLabel
	label of module making hits More...
std::vector< int >	fMaxHitsByPlane
	maximum hits on each plane More...
int	fMaxTotalHits
	maximum number of hits allowed More...
unsigned int	fNPlanes
	number of planes More...
std::vector< std::vector< art::Ptr< recob::Hit > > >	hitlistbyplane
	list of all hits on each plane More...

Detailed Description

Definition at line 38 of file SmallClusterFilter_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

cluster::SmallClusterFilter::SmallClusterFilter ( fhicl::ParameterSet const &  pset )

explicit

METHODS global

Definition at line 79 of file SmallClusterFilter_module.cc.

References reconfigure().

{
  this->reconfigure(pset);  
}

cluster::SmallClusterFilter::~SmallClusterFilter ( )

virtual

Definition at line 98 of file SmallClusterFilter_module.cc.

{
  //Nothing to do in the destructor
}

Member Function Documentation

void cluster::SmallClusterFilter::beginJob ( )

virtual

Get TFileService and define output Histograms

Reimplemented from art::EDFilter.

Definition at line 113 of file SmallClusterFilter_module.cc.

References fNPlanes, geom, and geo::GeometryCore::Nplanes().

{
  // this will not change on a run per run basis.
  fNPlanes = geom->Nplanes();                           //get the number of planes in the TPC
        
  art::ServiceHandle<art::TFileService> tfs;

  return;
}

bool cluster::SmallClusterFilter::beginRun ( art::Run &  run )

virtual

Reimplemented from art::EDFilter.

Definition at line 104 of file SmallClusterFilter_module.cc.

{
  //nothing to do at beginRun()
  return true;
}

void cluster::SmallClusterFilter::ClearandResizeVectors ( unsigned int  nHits )

private

Definition at line 129 of file SmallClusterFilter_module.cc.

References fNPlanes, and hitlistbyplane.

Referenced by filter().

                                                                    {

  //   fMinWire.clear();
  //   fMaxWire.clear();
  //   fMinTime.clear();
  //   fMaxTime.clear();
  //   
  //   fRMS_wire.clear();
  //   fRMS_time.clear();
  //   
  //   mcwirevertex.resize(fNPlanes);  // wire coordinate of vertex for each plane 
  //   mctimevertex.resize(fNPlanes);  // time coordinate of vertex for each plane
  //   
  //   fRMS_wire.resize(fNPlanes);
  //   fRMS_time.resize(fNPlanes); 
  //   
  hitlistbyplane.clear();
  hitlistbyplane.resize(fNPlanes);    
  return;
}

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

virtual

Routine that finds the cluster and sets the dTdW of the 2D shower

Get Clusters

Implements art::EDFilter.

Definition at line 156 of file SmallClusterFilter_module.cc.

References ClearandResizeVectors(), fHitFinderModuleLabel, fMaxHitsByPlane, fMaxTotalHits, fNPlanes, art::DataViewImpl::getByLabel(), GetPlaneAndTPC(), hitlistbyplane, geo::kCollection, and w.

{ 
  //Check the size of the maxHitsByPlane vector against fNPlanes
  if (fMaxHitsByPlane.size() != fNPlanes) return false;

  //Get the hits for this event:
  art::Handle< std::vector<recob::Hit> > HitListHandle;
  evt.getByLabel(fHitFinderModuleLabel,HitListHandle);  

  //A vector to hold hits, not yet filled:
  std::vector< art::Ptr<recob::Hit> > hitlist;
        
  //How many hits in this event?  Tell user:
  mf::LogVerbatim("SmallClusterFilter") << " ++++ Hitsreceived received " 
                                        << HitListHandle->size() << " +++++ ";

  //Catch the case were there are no hits in the event:
  if(HitListHandle->size() ==0 )
    {
      mf::LogWarning("SmallClusterFilter") << " no hits received! exiting ";
      return false;
    }
  if (HitListHandle->size() > (unsigned int) fMaxTotalHits)
    {
      mf::LogWarning("SmallClusterFinder") << "Not an empty event, exiting.";
      return false;
    }
        
        
        
  ClearandResizeVectors(HitListHandle->size());
  // resizing once cluster size is known.
  
  art::Ptr< recob::Hit> theHit;
  
  bool collFound = false;
  //add all of the hits to the hitlist, and sort them into hits by plane
  for(unsigned int iHit = 0; iHit < HitListHandle->size(); iHit++){

    theHit = art::Ptr< recob::Hit>(HitListHandle, iHit);

    unsigned int p(0),w(0), t(0),cs(0); //c=channel, p=plane, w=wire, t=TPC
    GetPlaneAndTPC(theHit,p,cs,t,w);  //Find out what plane this hit is on.
    
    //Do a check to catch crazy hits:
    if (theHit -> Integral() > 500 ) continue;
    
    //add this hit to the total list
    hitlist.push_back(theHit);

    //add this hit to the list specific to this plane
    hitlistbyplane[p].push_back(theHit);
    //hitlistleftover[p].push_back(theHit);
    //Just for searching for Ar39:

    if (theHit -> SignalType() == geo::kCollection) collFound = true;
      
  } // End loop on hits.
        
  
        
  //Check against each plane:
  for (unsigned int i = 0; i < fNPlanes; i ++){
    if (hitlistbyplane[i].size() > (unsigned int) fMaxHitsByPlane[i]) return false;
  }
        
  //check that there is at least 1 hit on collection:
  if (!collFound) return false;
        
  mf::LogVerbatim("SmallClusterFilter") << "\nPassing with " 
                                        << hitlistbyplane[fNPlanes-1].size() 
                                        << " hit(s) on collection.\n";
        
  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();
}

void cluster::SmallClusterFilter::GetPlaneAndTPC ( art::Ptr< recob::Hit >  a, unsigned int &  p, unsigned int &  cs, unsigned int &  t, unsigned int &  w  )

private

Definition at line 238 of file SmallClusterFilter_module.cc.

References DEFINE_ART_MODULE.

Referenced by filter().

{
  cs = a -> WireID().Cryostat;
  p = a -> WireID().Plane;
  t = a -> WireID().TPC;
  w = a -> WireID().Wire;
}

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 cluster::SmallClusterFilter::reconfigure

(

fhicl::ParameterSet const &

pset

)

Definition at line 85 of file SmallClusterFilter_module.cc.

References fHitFinderModuleLabel, fMaxHitsByPlane, fMaxTotalHits, and fhicl::ParameterSet::get().

Referenced by SmallClusterFilter().

{
  fHitFinderModuleLabel = pset.get< std::string         > ("HitFinderModuleLabel"); 
  fMaxHitsByPlane       = pset.get< std::vector<int>    > ("MaxHitsByPlane");
  fMaxTotalHits         = pset.get<      int            > ("MaxTotalHits");
        
  //fRadiusSizePar is used to exclude hits from a cluster outside of a certain size
  //fNHitsInClust ensures the clusters don't get too big
  //max hits by plane filters this event if the hits on that plane is too big
  //max hits total checks against the sum of all hits found.
}

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

const detinfo::DetectorProperties* cluster::SmallClusterFilter::detp = lar::providerFrom<detinfo::DetectorPropertiesService>()

private

const ptr to det properties data provider

Definition at line 63 of file SmallClusterFilter_module.cc.

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

staticinherited

Definition at line 33 of file EDFilter.h.

std::string cluster::SmallClusterFilter::fHitFinderModuleLabel

private

label of module making hits

Definition at line 68 of file SmallClusterFilter_module.cc.

Referenced by filter(), and reconfigure().

std::vector<int> cluster::SmallClusterFilter::fMaxHitsByPlane

private

maximum hits on each plane

Definition at line 69 of file SmallClusterFilter_module.cc.

Referenced by filter(), and reconfigure().

int cluster::SmallClusterFilter::fMaxTotalHits

private

maximum number of hits allowed

Definition at line 70 of file SmallClusterFilter_module.cc.

Referenced by filter(), and reconfigure().

unsigned int cluster::SmallClusterFilter::fNPlanes

private

number of planes

Definition at line 71 of file SmallClusterFilter_module.cc.

Referenced by beginJob(), ClearandResizeVectors(), and filter().

std::vector< unsigned int > cluster::SmallClusterFilter::fNWires

private

Number of wires on each plane.

Definition at line 65 of file SmallClusterFilter_module.cc.

art::ServiceHandle<geo::Geometry> cluster::SmallClusterFilter::geom

private

handle to geometry service

Definition at line 62 of file SmallClusterFilter_module.cc.

Referenced by beginJob().

util::GeometryUtilities cluster::SmallClusterFilter::gser

private

geometry utilities

Definition at line 64 of file SmallClusterFilter_module.cc.

std::vector< std::vector< art::Ptr<recob::Hit> > > cluster::SmallClusterFilter::hitlistbyplane

private

list of all hits on each plane

Definition at line 73 of file SmallClusterFilter_module.cc.

Referenced by ClearandResizeVectors(), and filter().

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

staticinherited

Definition at line 32 of file EDFilter.h.

---

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

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