Inheritance diagram for CRHitRemoval:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

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

virtual	~CRHitRemoval ()
	Destructor. More...

virtual void	reconfigure (fhicl::ParameterSet const &pset)

virtual void	produce (art::Event &e)

virtual void	beginJob ()
	Begin job method. More...

virtual void	endJob ()
	End job method. More...

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

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 Types
using	HitPtrVector = std::vector< art::Ptr< recob::Hit >>

Private Member Functions
void	collectPFParticleHits (const recob::PFParticle *pfParticle, const art::Handle< std::vector< recob::PFParticle > > &pfParticleHandle, const art::FindManyP< recob::Cluster > &partToClusAssns, const art::FindManyP< recob::Hit > &clusToHitAssns, HitPtrVector &hitVec)

void	copyAllHits (std::vector< art::Ptr< recob::Hit >> &, art::FindOneP< raw::RawDigit > &, art::FindOneP< recob::Wire > &, recob::HitCollectionCreator &)

void	copyInTimeHits (std::vector< art::Ptr< recob::Hit >> &, art::FindOneP< raw::RawDigit > &, art::FindOneP< recob::Wire > &, recob::HitCollectionCreator &)

void	FilterHits (HitPtrVector &hits, HitPtrVector &used_hits)

Private Attributes
std::vector< std::string >	fCosmicProducerLabels
	List of cosmic tagger producers. More...

std::string	fHitProducerLabel
	The full collection of hits. More...

std::string	fPFParticleProducerLabel
	PFParticle producer. More...

std::vector< std::string >	fTrackProducerLabels
	Track producer. More...

std::vector< std::string >	fAssnProducerLabels
	Track to PFParticle assns producer. More...

std::vector< double >	fCosmicTagThresholds
	Thresholds for tagging. More...

int	fEndTickPadding
	Padding the end tick. More...

int	fDetectorWidthTicks
	Effective drift time in ticks. More...

int	fMinTickDrift
	Starting tick. More...

int	fMaxTickDrift
	Ending tick. More...

int	fMaxOutOfTime
	Max hits that can be out of time before rejecting. More...

int	fNumEvent
	Number of events seen. More...

int	fNumCRRejects
	Number of tracks produced. More...

Detailed Description

Definition at line 45 of file CRHitRemoval_module.cc.

Member Typedef Documentation

using CRHitRemoval::HitPtrVector = std::vector<art::Ptr<recob::Hit>>

private

Definition at line 61 of file CRHitRemoval_module.cc.

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

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

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

CRHitRemoval::CRHitRemoval ( fhicl::ParameterSet const & pset )

explicit

Constructor.

Arguments:

pset - Fcl parameters.

Definition at line 112 of file CRHitRemoval_module.cc.

References recob::HitAndAssociationsWriterBase::declare_products(), and reconfigure().

                                                          :
 fNumEvent(0),
 fNumCRRejects(0)
 {
     reconfigure(pset);
     
     // let HitCollectionCreator declare that we are going to produce
     // hits and associations with wires and raw digits
     // (with no particular product label)
     recob::HitCollectionCreator::declare_products(*this);
     
     // Report.
     mf::LogInfo("CRHitRemoval") << "CRHitRemoval configured\n";
 }

CRHitRemoval::~CRHitRemoval ( )

virtual

Destructor.

Definition at line 129 of file CRHitRemoval_module.cc.

130 {}

Member Function Documentation

void CRHitRemoval::beginJob ( )

virtual

Begin job method.

Reimplemented from art::EDProducer.

Definition at line 153 of file CRHitRemoval_module.cc.

References fDetectorWidthTicks, fEndTickPadding, fMaxTickDrift, and fMinTickDrift.

 {
     auto const* detp = lar::providerFrom<detinfo::DetectorPropertiesService>();
     auto const* geo  = lar::providerFrom<geo::Geometry>();
     auto const* ts   = lar::providerFrom<detinfo::DetectorClocksService>();
     
     float samplingRate  = detp->SamplingRate();
     float driftVelocity = detp->DriftVelocity( detp->Efield(), detp->Temperature() ); // cm/us
     
     fDetectorWidthTicks = 2*geo->DetHalfWidth()/(driftVelocity*samplingRate/1000);
     fMinTickDrift       = ts->Time2Tick(ts->TriggerTime()); // this is the hardware trigger time
     fMaxTickDrift       = fMinTickDrift + fDetectorWidthTicks + fEndTickPadding;
 }

void CRHitRemoval::collectPFParticleHits	(	const recob::PFParticle *	pfParticle,
		const art::Handle< std::vector< recob::PFParticle > > &	pfParticleHandle,
		const art::FindManyP< recob::Cluster > &	partToClusAssns,
		const art::FindManyP< recob::Hit > &	clusToHitAssns,
		HitPtrVector &	hitVec
	)

private

Find all hits in PFParticle hierarchy

Arguments:

pfParticle - the top level PFParticle to have hits removed pfParticleHandle - handle to the PFParticle objects partToClusAssns - list of PFParticle to Cluster associations clusToHitAssns - list of Cluster to Hit associations hitVec - the current list of hits

This recursively called method will remove all hits associated to an input PFParticle and, in addition, will call itself for all daughters of the input PFParticle

Definition at line 448 of file CRHitRemoval_module.cc.

References recob::PFParticle::Daughters(), fMaxTickDrift, fMinTickDrift, art::Ptr< T >::get(), max, min, and recob::PFParticle::Self().

Referenced by produce().

 {
     // Recover the clusters associated to the input PFParticle
     std::vector<art::Ptr<recob::Cluster> > clusterVec = partToClusAssns.at(pfParticle->Self());
     
     int minTick(fMinTickDrift);
     int maxTick(fMaxTickDrift);
     
     // Loop over the clusters and grab the associated hits
     for(const auto& cluster : clusterVec)
     {
         std::vector<art::Ptr<recob::Hit> > clusHitVec = clusToHitAssns.at(cluster.key());
         hitVec.insert(hitVec.end(), clusHitVec.begin(), clusHitVec.end());
         
         int minHitTick = (*std::min_element(clusHitVec.begin(),clusHitVec.end(),[](const auto& hit,const auto& min){return hit->PeakTimeMinusRMS() < min->PeakTimeMinusRMS();}))->PeakTimeMinusRMS();
         int maxHitTick = (*std::max_element(clusHitVec.begin(),clusHitVec.end(),[](const auto& hit,const auto& max){return hit->PeakTimePlusRMS() > max->PeakTimePlusRMS();}))->PeakTimePlusRMS();
         
         if (minHitTick < minTick) minTick = minHitTick;
         if (maxHitTick < maxTick) maxTick = maxHitTick;
     }
     
     // Loop over the daughters of this particle and remove their hits as well
     for(const auto& daughterId : pfParticle->Daughters())
     {
         art::Ptr<recob::PFParticle> daughter(pfParticleHandle, daughterId);
         
         collectPFParticleHits(daughter.get(), pfParticleHandle, partToClusAssns, clusToHitAssns, hitVec);
     }
     
     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};
 }

void CRHitRemoval::copyAllHits	(	std::vector< art::Ptr< recob::Hit >> &	inputHits,
		art::FindOneP< raw::RawDigit > &	rawDigitAssns,
		art::FindOneP< recob::Wire > &	wireAssns,
		recob::HitCollectionCreator &	newHitCollection
	)

private

Definition at line 484 of file CRHitRemoval_module.cc.

References recob::HitCollectionCreator::emplace_back().

Referenced by produce().

 {
     for(const auto& hitPtr : inputHits)
     {
         art::Ptr<recob::Wire>   wire      = wireAssns.at(hitPtr.key());
         art::Ptr<raw::RawDigit> rawdigits = rawDigitAssns.at(hitPtr.key());
         
         // just copy it
         newHitCollection.emplace_back(*hitPtr, wire, rawdigits);
     }
     
     return;
 }

void CRHitRemoval::copyInTimeHits	(	std::vector< art::Ptr< recob::Hit >> &	inputHits,
		art::FindOneP< raw::RawDigit > &	rawDigitAssns,
		art::FindOneP< recob::Wire > &	wireAssns,
		recob::HitCollectionCreator &	newHitCollection
	)

private

Definition at line 501 of file CRHitRemoval_module.cc.

References recob::HitCollectionCreator::emplace_back(), fMaxTickDrift, and fMinTickDrift.

Referenced by produce().

 {
     for(const auto& hitPtr : inputHits)
     {
         // Check on out of time hits
         if (hitPtr->PeakTimeMinusRMS() < fMinTickDrift || hitPtr->PeakTimePlusRMS() > fMaxTickDrift) continue;
         
         art::Ptr<recob::Wire>   wire      = wireAssns.at(hitPtr.key());
         art::Ptr<raw::RawDigit> rawdigits = rawDigitAssns.at(hitPtr.key());
         
         // just copy it
         newHitCollection.emplace_back(*hitPtr, wire, rawdigits);
     }
     
     return;
 }

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::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

   {
     return current_context_.get();
   }

void CRHitRemoval::endJob ( )

virtual

End job method.

Reimplemented from art::EDProducer.

Definition at line 550 of file CRHitRemoval_module.cc.

References fNumCRRejects, and fNumEvent.

 {
     double aveCRPerEvent = fNumEvent > 0 ? double(fNumCRRejects) / double(fNumEvent) : 0.;
     
     mf::LogInfo("CRHitRemoval")
     << "CRHitRemoval statistics:\n"
     << "  Number of events = " << fNumEvent << "\n"
     << "  Number of Cosmic Rays found = " << fNumCRRejects
     << ", " << aveCRPerEvent << " average/event";
 }

void CRHitRemoval::FilterHits	(	HitPtrVector &	hits,
		HitPtrVector &	used_hits
	)

private

Definition at line 530 of file CRHitRemoval_module.cc.

Referenced by produce().

 {
     if(used_hits.size() > 0)
     {
         // Make sure both hit collections are sorted.
         std::stable_sort(hits.begin(), hits.end());
         std::stable_sort(used_hits.begin(), used_hits.end());
         
         // Do set difference operation.
         std::vector<art::Ptr<recob::Hit>>::iterator it
         = std::set_difference(hits.begin(), hits.end(), used_hits.begin(), used_hits.end(), hits.begin());
         
         // Truncate hit collection.
         hits.erase(it, hits.end());
     }
 }

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::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::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.

 {
   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 CRHitRemoval::produce ( art::Event & evt )

virtual

Produce method.

Arguments:

evt - Art event.

This is the primary method. The goal is to produce a list of recob::Hit objects which are a "clean" subset of all hits and which are believed to be due to a neutrino interaction. It does this by considering input CosmicTag objects, relating them to PFParticles/Tracks and removing the hits associated to those objects which are believed to be Cosmic Rays.

Implements art::EDProducer.

Definition at line 180 of file CRHitRemoval_module.cc.

References collectPFParticleHits(), copyAllHits(), copyInTimeHits(), anab::CosmicTag::CosmicScore(), fAssnProducerLabels, fCosmicProducerLabels, fCosmicTagThresholds, fHitProducerLabel, art::fill_ptr_vector(), FilterHits(), fMaxOutOfTime, fMaxTickDrift, fMinTickDrift, fNumEvent, fPFParticleProducerLabel, fTrackProducerLabels, art::DataViewImpl::getByLabel(), recob::PFParticle::IsPrimary(), art::Handle< T >::isValid(), art::Ptr< T >::key(), recob::PFParticle::Parent(), and track.

 {
     ++fNumEvent;
     
     // Start by looking up the original hits
     art::Handle< std::vector<recob::Hit> > hitHandle;
     evt.getByLabel(fHitProducerLabel, hitHandle);
     
     // also get the associated wires and raw digits;
     // we assume they have been created by the same module as the hits
     art::FindOneP<raw::RawDigit> ChannelHitRawDigits(hitHandle, evt, fHitProducerLabel);
     art::FindOneP<recob::Wire>   ChannelHitWires(hitHandle, evt, fHitProducerLabel);
     
     // If there are no hits then there should be no output
     if (!hitHandle.isValid()) return;
     
     HitPtrVector ChHits;
     art::fill_ptr_vector(ChHits, hitHandle);
     
     // this object contains the hit collection
     // and its associations to wires and raw digits:
     recob::HitCollectionCreator hcol(*this,
                                      evt,
                                      /* doWireAssns */ ChannelHitWires.isValid(),
                                      /* doRawDigitAssns */ ChannelHitRawDigits.isValid()
                                      );
     
     // Now recover thre remaining collections of objects in the event store that we need
     // Recover the PFParticles that are ultimately associated to tracks
     // This will be the key to recovering the hits
     art::Handle<std::vector<recob::PFParticle> > pfParticleHandle;
     evt.getByLabel(fPFParticleProducerLabel, pfParticleHandle);
     
     // Without a valid collection of PFParticles we can't do the hit removal
     if (!pfParticleHandle.isValid())
     {
         copyAllHits(ChHits, ChannelHitRawDigits, ChannelHitWires, hcol);
         
         // put the hit collection and associations into the event
         hcol.put_into(evt);
         
         return;
     }
     
     // Recover the clusters so we can do associations to the hits
     // In theory the clusters come from the same producer as the PFParticles
     art::Handle<std::vector<recob::Cluster> > clusterHandle;
     evt.getByLabel(fPFParticleProducerLabel, clusterHandle);
     
     // If there are no clusters then something is really wrong
     if (!clusterHandle.isValid())
     {
         copyAllHits(ChHits, ChannelHitRawDigits, ChannelHitWires, hcol);
         
         // put the hit collection and associations into the event
         hcol.put_into(evt);
         
         return;
     }
     
     // Build the list of cosmic tag producers, associations and thresholds
     std::vector<art::Handle<std::vector<anab::CosmicTag>>>              cosmicHandleVec;
     std::vector<std::map<int,std::vector<art::Ptr<recob::Track>>>>      cosmicToTrackVecMapVec;
     std::vector<std::map<int,std::vector<art::Ptr<recob::PFParticle>>>> trackToPFParticleVecMapVec;
     std::vector<double>                                                 thresholdVec;
     
     for(size_t idx = 0; idx != fCosmicProducerLabels.size(); idx++)
     {
         std::string& handleLabel(fCosmicProducerLabels[idx]);
         
         art::Handle<std::vector<anab::CosmicTag>> cosmicHandle;
         evt.getByLabel(handleLabel, cosmicHandle);
         
         if (cosmicHandle.isValid())
         {
             // Look up the associations to tracks
             art::FindManyP<recob::Track> cosmicTrackAssns(cosmicHandle, evt, handleLabel);
             
             // Get the handle to the tracks
             art::Handle<std::vector<recob::Track>> trackHandle;
             evt.getByLabel(fTrackProducerLabels[idx], trackHandle);
             
             // This should be the case
             if (trackHandle.isValid())
             {
                 std::map<int,std::vector<art::Ptr<recob::Track>>>       cosmicToTrackVecMap;
                 std::map<int, std::vector<art::Ptr<recob::PFParticle>>> trackToPFParticleVecMap;
                 
                 // Loop through the cosmic tags
                 for(size_t cosmicIdx = 0; cosmicIdx < cosmicHandle->size(); cosmicIdx++)
                 {
                     art::Ptr<anab::CosmicTag> cosmicTag(cosmicHandle, cosmicIdx);
                 
                     std::vector<art::Ptr<recob::Track>> cosmicToTrackVec = cosmicTrackAssns.at(cosmicTag.key());
                     
                     cosmicToTrackVecMap[cosmicTag.key()] = cosmicToTrackVec;
 
                     art::FindManyP<recob::PFParticle> trackPFParticleAssns(trackHandle, evt, fAssnProducerLabels[idx]);
                 
                     for(auto& track : cosmicToTrackVec)
                     {
                         std::vector<art::Ptr<recob::PFParticle>> trackToPFParticleVec = trackPFParticleAssns.at(track.key());
                     
                         for(auto& pfParticle : trackToPFParticleVec)
                             trackToPFParticleVecMap[track.key()].push_back(pfParticle);
                     }
                 }
             
                 // Store these collections
                 cosmicHandleVec.emplace_back(cosmicHandle);
                 cosmicToTrackVecMapVec.emplace_back(cosmicToTrackVecMap);
                 trackToPFParticleVecMapVec.emplace_back(trackToPFParticleVecMap);
                 thresholdVec.push_back(fCosmicTagThresholds[idx]);
             }
         }
     }
     
     // No cosmic tags then nothing to do here
     if (cosmicHandleVec.empty())
     {
         copyAllHits(ChHits, ChannelHitRawDigits, ChannelHitWires, hcol);
         
         // put the hit collection and associations into the event
         hcol.put_into(evt);
         
         return;
     }
     
     // Now we walk up the remaining list of associations needed to go from CR tags to hits
     // We'll need to go from tracks to PFParticles
     // From PFParticles we go to clusters
     art::FindManyP<recob::Cluster> clusterAssns(pfParticleHandle, evt, fPFParticleProducerLabel);
     
     // Likewise, recover the collection of associations to hits
     art::FindManyP<recob::Hit> clusterHitAssns(clusterHandle, evt, fPFParticleProducerLabel);
     
     // No point double counting hits
     std::set<const recob::PFParticle*> taggedSet;
     
     // Start the identification of hits to remove. The outer loop is over the various producers of
     // the CosmicTag objects we're examininig
     for(size_t idx = 0; idx != cosmicHandleVec.size(); idx++)
     {
         // Obviously, dereference the handle and associations
         const art::Handle<std::vector<anab::CosmicTag> >&             cosmicHandle(cosmicHandleVec[idx]);
         const std::map<int,std::vector<art::Ptr<recob::Track>>>&      crTagTrackVec(cosmicToTrackVecMapVec[idx]);
         const std::map<int,std::vector<art::Ptr<recob::PFParticle>>>& trackToPFParticleVecMap(trackToPFParticleVecMapVec[idx]);
         
         for(size_t crIdx = 0; crIdx != cosmicHandle->size(); crIdx++)
         {
             art::Ptr<anab::CosmicTag> cosmicTag(cosmicHandle, crIdx);
             
             // If this was tagged as a CR muon then we have work to do!
             if (cosmicTag->CosmicScore() > thresholdVec[idx])
             {
                 // Recover the associated track
                 std::vector<art::Ptr<recob::Track>> trackVec(crTagTrackVec.at(cosmicTag.key()));
                 
                 // Loop over the tracks (almost always only 1)
                 for(const auto& track : trackVec)
                 {
                     std::map<int,std::vector<art::Ptr<recob::PFParticle>>>::const_iterator trackToPFParticleVecItr = trackToPFParticleVecMap.find(track.key());
                     
                     if (trackToPFParticleVecItr != trackToPFParticleVecMap.end())
                     {
                         // Loop through them
                         for(const auto& pfParticlePtr : trackToPFParticleVecItr->second)
                         {
                             // Get bare pointer
                             const recob::PFParticle* pfParticle = pfParticlePtr.get();
                     
                             // A cosmic ray must be a primary (by fiat)
                             while(!pfParticle->IsPrimary()) pfParticle = art::Ptr<recob::PFParticle>(pfParticleHandle,pfParticle->Parent()).get();
                             
                             // Add to our list of tagged PFParticles
                             taggedSet.insert(pfParticle);
                         }
                     }
                 }
             }
         }
     }
     
     // If no PFParticles have been tagged then nothing to do
     if (!taggedSet.empty())
     {
         // This may all seem backwards... but what you want to do is remove all the hits which are associated to tagged
         // cosmic ray tracks/PFParticles and what you want to leave is all other hits. This includes hits on other PFParticles
         // as well as unassociated (as yet) hits.
         // One also needs to deal with a slight complication with hits in 2D which are shared between untagged PFParticles and
         // tagged ones... we should leave these in.
         
         // All that is left is to go through the PFParticles which have not been tagged and collect up all their hits
         // to output to our new collection
         // Note that this SHOULD take care of the case of shared 2D hits automagically since if the PFParticle has not
         // been tagged and it shares hits we'll pick those up here.
         HitPtrVector taggedHits;
         HitPtrVector untaggedHits;
         
         // Loop through the PFParticles and build out the list of hits on untagged PFParticle trees
         for(const auto& pfParticle : *pfParticleHandle)
         {
             // Start with only primaries
             if (!pfParticle.IsPrimary()) continue;
             
             // Temporary container for these hits
             HitPtrVector tempHits;
             
             // Find the hits associated to this untagged PFParticle
             collectPFParticleHits(&pfParticle, pfParticleHandle, clusterAssns, clusterHitAssns, tempHits);
 
             // One more possible chance at identifying tagged hits...
             // Check these hits to see if any lie outside time window
             bool goodHits(true);
             
             if (taggedSet.find(&pfParticle) != taggedSet.end()) goodHits = false;
 
             if (goodHits)
             {
                 int nOutOfTime(0);
                 
                 for(const auto& hit : tempHits)
                 {
                     // Check on out of time hits
                     if (hit->PeakTimeMinusRMS() < fMinTickDrift || hit->PeakTimePlusRMS()  > fMaxTickDrift) nOutOfTime++;
                     
                     if (nOutOfTime > fMaxOutOfTime)
                     {
                         goodHits = false;
                         break;
                     }
                 }
             }
             
             if (goodHits) std::copy(tempHits.begin(),tempHits.end(),std::back_inserter(untaggedHits));
             else          std::copy(tempHits.begin(),tempHits.end(),std::back_inserter(taggedHits));
         }
         
         // First task - remove hits from the tagged hit collection that are inthe untagged hits (shared hits)
         FilterHits(taggedHits,untaggedHits);
         
         // Now filter the tagged hits from the total hit collection
         FilterHits(ChHits, taggedHits);
     }
     
     // Copy our new hit collection to the output
     copyInTimeHits(ChHits, ChannelHitRawDigits, ChannelHitWires, hcol);
     
     // put the hit collection and associations into the event
     hcol.put_into(evt);
     
 }

void CRHitRemoval::reconfigure ( fhicl::ParameterSet const & pset )

virtual

Reconfigure method.

Arguments:

pset - Fcl parameter set.

Definition at line 139 of file CRHitRemoval_module.cc.

References fAssnProducerLabels, fCosmicProducerLabels, fCosmicTagThresholds, fEndTickPadding, fHitProducerLabel, fMaxOutOfTime, fPFParticleProducerLabel, fTrackProducerLabels, and fhicl::ParameterSet::get().

Referenced by CRHitRemoval().

 {
     fCosmicProducerLabels    = pset.get<std::vector<std::string> >("CosmicProducerLabels");
     fHitProducerLabel        = pset.get<std::string>("HitProducerLabel");
     fPFParticleProducerLabel = pset.get<std::string>("PFParticleProducerLabel");
     fTrackProducerLabels     = pset.get<std::vector<std::string>>("TrackProducerLabels");
     fAssnProducerLabels      = pset.get<std::vector<std::string>>("AssnProducerLabels");
     fCosmicTagThresholds     = pset.get<std::vector<double> >("CosmicTagThresholds");
     fEndTickPadding          = pset.get<int>("EndTickPadding", 50);
     fMaxOutOfTime            = pset.get<int>("MaxOutOfTime",    4);
 }

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

std::vector<std::string> CRHitRemoval::fAssnProducerLabels

private

Track to PFParticle assns producer.

Definition at line 87 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

std::vector<std::string> CRHitRemoval::fCosmicProducerLabels

private

List of cosmic tagger producers.

Definition at line 83 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

std::vector<double> CRHitRemoval::fCosmicTagThresholds

private

Thresholds for tagging.

Definition at line 89 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

int CRHitRemoval::fDetectorWidthTicks

private

Effective drift time in ticks.

Definition at line 93 of file CRHitRemoval_module.cc.

Referenced by beginJob().

int CRHitRemoval::fEndTickPadding

private

Padding the end tick.

Definition at line 91 of file CRHitRemoval_module.cc.

Referenced by beginJob(), and reconfigure().

std::string CRHitRemoval::fHitProducerLabel

private

The full collection of hits.

Definition at line 84 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

int CRHitRemoval::fMaxOutOfTime

private

Max hits that can be out of time before rejecting.

Definition at line 96 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

int CRHitRemoval::fMaxTickDrift

private

Ending tick.

Definition at line 95 of file CRHitRemoval_module.cc.

Referenced by beginJob(), collectPFParticleHits(), copyInTimeHits(), and produce().

int CRHitRemoval::fMinTickDrift

private

Starting tick.

Definition at line 94 of file CRHitRemoval_module.cc.

Referenced by beginJob(), collectPFParticleHits(), copyInTimeHits(), and produce().

int CRHitRemoval::fNumCRRejects

private

Number of tracks produced.

Definition at line 100 of file CRHitRemoval_module.cc.

Referenced by endJob().

int CRHitRemoval::fNumEvent

private

Number of events seen.

Definition at line 99 of file CRHitRemoval_module.cc.

Referenced by endJob(), and produce().

std::string CRHitRemoval::fPFParticleProducerLabel

private

PFParticle producer.

Definition at line 85 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

std::vector<std::string> CRHitRemoval::fTrackProducerLabels

private

Track producer.

Definition at line 86 of file CRHitRemoval_module.cc.

Referenced by produce(), and reconfigure().

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

/cvmfs/larsoft.opensciencegrid.org/products/larana/v07_04_02/source/larana/CosmicRemoval/CRHitRemoval_module.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation