recob::HitRefinerAssociator Class Reference

A class handling a collection of hits and its associations. More...

#include "HitCreator.h"

Inheritance diagram for recob::HitRefinerAssociator:

Public Member Functions
void	use_hits (std::unique_ptr< std::vector< recob::Hit >> &&srchits)
	Uses the specified collection as data product. More...
void	put_into (art::Event &)
	Moves the data into the event. More...
void	put_into ()
	Moves the data into the event. More...
size_t	size () const
	Returns the number of hits currently in the collection. More...
std::vector< recob::Hit > const &	peek () const
	Returns a read-only reference to the current list of hits. More...
Constructors
template<typename ModuleType >
	HitRefinerAssociator (ModuleType &producer, art::Event &event, art::InputTag const &HitModuleLabel, std::string instance_name="", bool doWireAssns=true, bool doRawDigitAssns=true)
	Constructor: sets instance name and whether to build associations. More...
template<typename ModuleType >
	HitRefinerAssociator (ModuleType &producer, art::Event &event, art::InputTag const &HitModuleLabel, bool doWireAssns, bool doRawDigitAssns=true)
	Constructor: sets instance name and whether to build associations. More...

Static Public Member Functions
template<typename ModuleType >
static void	declare_products (ModuleType &producer, std::string instance_name="", bool doWireAssns=true, bool doRawDigitAssns=true)
	Declares the hit products we are going to fill. More...

Protected Types
using	HitPtr_t = art::Ptr< recob::Hit >
	Type of art pointer to Hit. More...

Protected Member Functions
void	prepare_associations (std::vector< recob::Hit > const &srchits)
	Finds out the associations for the specified hits. More...
void	prepare_associations ()
	Finds out the associations for the current hits. More...
HitPtr_t	CreatePtr (size_t index) const
	Creates an art pointer to the hit with the specified index. More...

Protected Attributes
art::InputTag	hits_label
	Label of the collection of hits. More...
std::string	prod_instance
	Tame of the instance for data products. More...
std::unique_ptr< std::vector< recob::Hit > >	hits
	Collection of hits. More...
std::unique_ptr< art::Assns< recob::Wire, recob::Hit > >	WireAssns
	Associations with wires. More...
std::unique_ptr< art::Assns< raw::RawDigit, recob::Hit > >	RawDigitAssns
	Associations with raw digits. More...
art::Event *	event = nullptr
	Pointer to the event we are using. More...
art::PtrMaker< recob::Hit >	hitPtrMaker
	Tool to create hit pointers,. More...

Detailed Description

A class handling a collection of hits and its associations.

---

Use this object if you already have a recob::Hit data product and another collection that is going to become a data product, and you simply want the new hits associated to the wire and digit with the same channel. No hit-to-hit association is attempted (that would be, incidentally, not supported by art): the data product is used to get all the associated wires and digits, then they are associated to the new hits by channel ID. If a channel is not available, a warning is produced. If different hits on the same channel are associated to different wires or raw digits, an exception is thrown.

Definition at line 865 of file HitCreator.h.

Member Typedef Documentation

using recob::HitAndAssociationsWriterBase::HitPtr_t = art::Ptr<recob::Hit>

protectedinherited

Type of art pointer to Hit.

Definition at line 462 of file HitCreator.h.

Constructor & Destructor Documentation

template<typename ModuleType >

recob::HitRefinerAssociator::HitRefinerAssociator	(	ModuleType &	producer,
		art::Event &	event,
		art::InputTag const &	HitModuleLabel,
		std::string	instance_name = "",
		bool	doWireAssns = true,
		bool	doRawDigitAssns = true
	)

Constructor: sets instance name and whether to build associations.

Template Parameters

ModuleType

type of producing module (EDProducer or EDFilter)

Parameters

producer	the module producing the data products
event	the event the products are going to be put into
HitModuleLabel	label of the module used to create hits
instance_name	name of the instance for all data products
doWireAssns	whether to enable associations to wires
doRawDigitAssns	whether to enable associations to raw digits

All the data products (hit collection and associations) will have the specified product instance name.

Definition at line 1141 of file HitCreator.h.

References recob::HitAndAssociationsWriterBase::hits.

  : HitAndAssociationsWriterBase
      (producer, event, instance_name, doWireAssns, doRawDigitAssns)
  , hits_label(HitModuleLabel)
{
  hits.reset(new std::vector<recob::Hit>);
} // recob::HitRefinerAssociator::HitRefinerAssociator()

template<typename ModuleType >

recob::HitRefinerAssociator::HitRefinerAssociator ( ModuleType &  producer, art::Event &  event, art::InputTag const &  HitModuleLabel, bool  doWireAssns, bool  doRawDigitAssns = true  )

inline

Constructor: sets instance name and whether to build associations.

Template Parameters

ModuleType

type of producing module (EDProducer or EDFilter)

Parameters

producer	the module producing the data products
event	the event the products are going to be put into
HitModuleLabel	label of the module used to create hits
doWireAssns	whether to enable associations to wires
doRawDigitAssns	whether to enable associations to raw digits

All the data products (hit collection and associations) will have an empty product instance name.

Definition at line 904 of file HitCreator.h.

       :
      HitRefinerAssociator
        (producer, event, HitModuleLabel, "", doWireAssns, doRawDigitAssns)
      {}

Member Function Documentation

HitPtr_t recob::HitAndAssociationsWriterBase::CreatePtr ( size_t  index ) const

inlineprotectedinherited

Creates an art pointer to the hit with the specified index.

Definition at line 499 of file HitCreator.h.

{ return hitPtrMaker(index); }

template<typename ModuleType >

void recob::HitAndAssociationsWriterBase::declare_products ( ModuleType &  producer, std::string  instance_name = "", bool  doWireAssns = true, bool  doRawDigitAssns = true  )

staticinherited

Declares the hit products we are going to fill.

Template Parameters

ModuleType

type of producing module (EDProducer or EDFilter)

Parameters

producer	the module producing the data products
instance_name	name of the instance for all data products
doWireAssns	whether to enable associations to wires
doRawDigitAssns	whether to enable associations to raw digits

This declaration must be given in the constructor of producer. It is equivalent to manually declare the relevant among these products:

produces<std::vector<recob::Hit>>(prod_instance);
produces<art::Assns<recob::Wire, recob::Hit>>(prod_instance);
produces<art::Assns<raw::RawDigit, recob::Hit>>(prod_instance);

in the producer constructor. All the data products (hit collection and associations) will have the specified product instance name.

Definition at line 1117 of file HitCreator.h.

Referenced by apa::APAHitFinder::APAHitFinder(), cluster::ClusterCrawler::ClusterCrawler(), CRHitRemoval::CRHitRemoval(), recob::HitAndAssociationsWriterManager< Writer, ModuleType >::declareProducts(), hit::DisambigCheater::DisambigCheater(), hit::DPRawHitFinder::DPRawHitFinder(), hit::FFTHitFinder::FFTHitFinder(), hit::GausHitFinder::GausHitFinder(), hit::HitCheater::HitCheater(), hit::HitFinder::HitFinder(), cluster::LineCluster::LineCluster(), hit::RawHitFinder::RawHitFinder(), hit::RFFHitFinder::RFFHitFinder(), cluster::SimpleLineCluster::SimpleLineCluster(), cluster::TrajCluster::TrajCluster(), and hit::TTHitFinder::TTHitFinder().

  {
  producer.template produces<std::vector<recob::Hit>>(instance_name);
  
  // declare the other products we are creating (if any)
  if (doWireAssns) {
    producer.template produces<art::Assns<recob::Wire, recob::Hit>>
      (instance_name);
  }
  if (doRawDigitAssns) {
    producer.template produces<art::Assns<raw::RawDigit, recob::Hit>>
      (instance_name);
  }
  
} // recob::HitAndAssociationsWriterBase::declare_products()

std::vector<recob::Hit> const& recob::HitAndAssociationsWriterBase::peek ( ) const

inlineinherited

Returns a read-only reference to the current list of hits.

Definition at line 433 of file HitCreator.h.

References hits().

{ return *hits; }

void recob::HitRefinerAssociator::prepare_associations ( std::vector< recob::Hit > const &  srchits )

protected

Finds out the associations for the specified hits.

Definition at line 446 of file HitCreator.cxx.

References raw::RawDigit::Channel(), recob::Wire::Channel(), recob::Hit::Channel(), art::Ptr< T >::isNull(), max, and art::errors::ProductNotFound.

  {
    if (!RawDigitAssns && !WireAssns) return; // no associations needed
    assert(event);
    
    // we make the associations anew
    if (RawDigitAssns) ClearAssociations(*RawDigitAssns);
    
    // read the hits; this is going to hurt performances...
    // no solution to that until there is a way to have a lazy read
    art::ValidHandle<std::vector<recob::Hit>> hHits
      = event->getValidHandle<std::vector<recob::Hit>>(hits_label);
    
    // now get the associations
    if (WireAssns) {
      // we make the associations anew
      ClearAssociations(*WireAssns);
      
      // find the associations between the hits and the wires
      art::FindOneP<recob::Wire> HitToWire(hHits, *event, hits_label);
      if (!HitToWire.isValid()) {
        throw art::Exception(art::errors::ProductNotFound)
          << "Can't find the associations between hits and wires produced by '"
          << hits_label << "'!\n";
      } // if no association
      
      // fill a map of wire vs. channel number
      std::vector<art::Ptr<recob::Wire>> WireMap;
      for (size_t iAssn = 0; iAssn < HitToWire.size(); ++iAssn) {
        art::Ptr<recob::Wire> wire = HitToWire.at(iAssn);
        if (wire.isNull()) continue;
        size_t channelID = (size_t) wire->Channel();
        if (WireMap.size() <= channelID) // expand the map of necessary
          WireMap.resize(std::max(channelID + 1, 2 * WireMap.size()), {});
        WireMap[channelID] = std::move(wire);
      } // for
      
      // now go through all the hits...
      for (size_t iHit = 0; iHit < srchits.size(); ++iHit) {
        recob::Hit const& hit = srchits[iHit];
        size_t channelID = (size_t) hit.Channel();
        
        // no association if there is no wire to associate with
        if ((channelID >= WireMap.size()) || !WireMap[channelID]) continue;
        
        // create an association using the same wire pointer
        WireAssns->addSingle(WireMap[channelID], CreatePtr(iHit));
      } // for hits
    } // if wire associations
    
    // now get the associations
    if (RawDigitAssns) {
      // we make the associations anew
      ClearAssociations(*RawDigitAssns);
      
      // find the associations between the hits and the raw digits
      art::FindOneP<raw::RawDigit> HitToDigits(hHits, *event, hits_label);
      if (!HitToDigits.isValid()) {
        throw art::Exception(art::errors::ProductNotFound)
          << "Can't find the associations between hits and raw digits"
          << " produced by '" << hits_label << "'!\n";
      } // if no association
      
      // fill a map of digits vs. channel number
      std::vector<art::Ptr<raw::RawDigit>> DigitMap;
      for (size_t iAssn = 0; iAssn < HitToDigits.size(); ++iAssn) {
        art::Ptr<raw::RawDigit> digits = HitToDigits.at(iAssn);
        if (digits.isNull()) continue;
        size_t channelID = (size_t) digits->Channel();
        if (DigitMap.size() <= channelID) // expand the map of necessary
          DigitMap.resize(std::max(channelID + 1, 2 * DigitMap.size()), {});
        DigitMap[channelID] = std::move(digits);
      } // for
      
      // now go through all the hits...
      for (size_t iHit = 0; iHit < srchits.size(); ++iHit) {
        recob::Hit const& hit = srchits[iHit];
        size_t channelID = (size_t) hit.Channel();
        
        // no association if there is no digits to associate with
        if ((channelID >= DigitMap.size()) || !DigitMap[channelID]) continue;
        
        // create an association using the same digits pointer
        RawDigitAssns->addSingle(DigitMap[channelID], CreatePtr(iHit));
      } // for hits
    } // if digit associations
    
  } // HitRefinerAssociator::put_into()

void recob::HitRefinerAssociator::prepare_associations ( )

inlineprotected

Finds out the associations for the current hits.

Definition at line 958 of file HitCreator.h.

References hits(), and prepare_associations().

Referenced by prepare_associations(), and put_into().

{ prepare_associations(*hits); }

void recob::HitRefinerAssociator::put_into ( art::Event &  )

inline

Moves the data into the event.

The calling module must have already declared the production of these products with the proper instance name. After the move, the collections in this object are empty.

Deprecated:

Use the version with no arguments instead.

Definition at line 939 of file HitCreator.h.

References put_into().

Referenced by cluster::TrajCluster::produce(), and put_into().

{ put_into(); }

void recob::HitRefinerAssociator::put_into

(

)

Moves the data into the event.

The calling module must have already declared the production of these products with the proper instance name. After the move, the collections in this object are empty.

Definition at line 438 of file HitCreator.cxx.

References prepare_associations(), and recob::HitAndAssociationsWriterBase::put_into().

                                      {
    prepare_associations();
    HitAndAssociationsWriterBase::put_into();
  } // HitRefinerAssociator::put_into()

size_t recob::HitAndAssociationsWriterBase::size ( ) const

inlineinherited

Returns the number of hits currently in the collection.

Definition at line 408 of file HitCreator.h.

References hits().

{ return hits? hits->size(): 0; }

void recob::HitRefinerAssociator::use_hits

(

std::unique_ptr< std::vector< recob::Hit >> &&

srchits

)

Uses the specified collection as data product.

Parameters

srchits

the collection to be used as data product

The very same collection is put into the event. This object will temporary own the collection until the hits are put into the event. If there were previous hits in the object, they are lost.

Definition at line 431 of file HitCreator.cxx.

References hits().

Referenced by recob::HitCollectionAssociator::prepare_associations(), cluster::SimpleLineCluster::produce(), and cluster::TrajCluster::produce().

  {
    hits = std::move(srchits);
  } // HitRefinerAssociator::use_hits()

Member Data Documentation

art::Event* recob::HitAndAssociationsWriterBase::event = nullptr

protectedinherited

Pointer to the event we are using.

Definition at line 473 of file HitCreator.h.

Referenced by recob::HitAndAssociationsWriterManager< Writer, ModuleType >::collectionWriter().

art::PtrMaker<recob::Hit> recob::HitAndAssociationsWriterBase::hitPtrMaker

protectedinherited

Tool to create hit pointers,.

Definition at line 475 of file HitCreator.h.

std::unique_ptr<std::vector<recob::Hit> > recob::HitAndAssociationsWriterBase::hits

protectedinherited

Collection of hits.

Definition at line 467 of file HitCreator.h.

Referenced by recob::HitCollectionAssociator::HitCollectionAssociator(), recob::HitCollectionCreator::HitCollectionCreator(), and HitRefinerAssociator().

art::InputTag recob::HitRefinerAssociator::hits_label

protected

Label of the collection of hits.

Definition at line 952 of file HitCreator.h.

std::string recob::HitAndAssociationsWriterBase::prod_instance

protectedinherited

Tame of the instance for data products.

Definition at line 464 of file HitCreator.h.

std::unique_ptr<art::Assns<raw::RawDigit, recob::Hit> > recob::HitAndAssociationsWriterBase::RawDigitAssns

protectedinherited

Associations with raw digits.

Definition at line 471 of file HitCreator.h.

Referenced by recob::HitCollectionAssociator::HitCollectionAssociator().

std::unique_ptr<art::Assns<recob::Wire, recob::Hit> > recob::HitAndAssociationsWriterBase::WireAssns

protectedinherited

Associations with wires.

Definition at line 469 of file HitCreator.h.

Referenced by recob::HitCollectionAssociator::HitCollectionAssociator().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/ArtDataHelper/HitCreator.h
• /cvmfs/larsoft.opensciencegrid.org/products/lardata/v07_01_01/source/lardata/ArtDataHelper/HitCreator.cxx