recob::HitCollectionAssociator Class Reference

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

#include <HitCreator.h>

Inheritance diagram for recob::HitCollectionAssociator:

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...
Constructors
	HitCollectionAssociator (art::Event &event, std::string instance_name, art::InputTag const &WireModuleLabel, art::InputTag const &RawDigitModuleLabel)
	Constructor: sets instance name and whether to build associations. More...
	HitCollectionAssociator (art::Event &event, art::InputTag const &WireModuleLabel, art::InputTag const &RawDigitModuleLabel)
	Constructor: sets instance name and whether to build associations. More...
	HitCollectionAssociator (art::Event &event, std::string instance_name, art::InputTag const &WireModuleLabel, bool doRawDigitAssns)
	Constructor: sets instance name and whether to build associations. More...
	HitCollectionAssociator (art::Event &event, art::InputTag const &WireModuleLabel, bool doRawDigitAssns)
	Constructor: sets instance name and whether to build associations. More...
Public Member Functions inherited from recob::HitAndAssociationsWriterBase
size_t	size () const
	Returns the number of hits currently in the collection. More...
void	put_into (art::Event &)
	Moves the data into the event. More...
void	put_into ()
	Moves the data into the event. More...
std::vector< recob::Hit > const &	peek () const
	Returns a read-only reference to the current list of hits. 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...
Protected Member Functions inherited from recob::HitAndAssociationsWriterBase
	HitAndAssociationsWriterBase (art::Event &event, std::string instance_name, bool doWireAssns, bool doRawDigitAssns)
	Constructor: sets instance name and whether to build associations. More...
HitPtr_t	CreatePtr (size_t index) const
	Creates an art pointer to the hit with the specified index. More...

Protected Attributes
art::InputTag	wires_label
	Label of the collection of wires to associate. More...
art::InputTag	digits_label
	Label of raw digits collection to associate. More...
Protected Attributes inherited from recob::HitAndAssociationsWriterBase
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...

Additional Inherited Members
Static Public Member Functions inherited from recob::HitAndAssociationsWriterBase
static void	declare_products (art::ProducesCollector &collector, std::string instance_name="", bool doWireAssns=true, bool doRawDigitAssns=true)
	Declares the hit products we are going to fill. More...
Protected Types inherited from recob::HitAndAssociationsWriterBase
using	HitPtr_t = art::Ptr< recob::Hit >
	Type of art pointer to Hit. More...

Detailed Description

A class handling a collection of hits and its associations.

---

Use this object if you already have a collection of recob::Hit and you simply want the hits associated to the wire and digit with the same channel.

Definition at line 692 of file HitCreator.h.

Constructor & Destructor Documentation

recob::HitCollectionAssociator::HitCollectionAssociator	(	art::Event &	event,
		std::string	instance_name,
		art::InputTag const &	WireModuleLabel,
		art::InputTag const &	RawDigitModuleLabel
	)

Constructor: sets instance name and whether to build associations.

Parameters

event	the event the products are going to be put into
instance_name	name of the instance for all data products
WireModuleLabel	label of the module used to create wires
RawDigitModuleLabel	label of the module used to create raw digits

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

If a label is empty, the corresponding association will not be produced.

Definition at line 350 of file HitCreator.cxx.

    : HitAndAssociationsWriterBase(
        event, instance_name,
        WireModuleLabel != "", RawDigitModuleLabel != ""
        )
    , wires_label(WireModuleLabel)
    , digits_label(RawDigitModuleLabel)
  {
    hits.reset(new std::vector<recob::Hit>);
  } // HitCollectionAssociator::HitCollectionAssociator()

recob::HitCollectionAssociator::HitCollectionAssociator ( art::Event &  event, art::InputTag const &  WireModuleLabel, art::InputTag const &  RawDigitModuleLabel  )

inline

Constructor: sets instance name and whether to build associations.

Parameters

event	the event the products are going to be put into
WireModuleLabel	label of the module used to create wires
RawDigitModuleLabel	label of the module used to create raw digits

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

If a label is empty, the corresponding association will not be produced.

Definition at line 726 of file HitCreator.h.

       :
      HitCollectionAssociator
        (event, "", WireModuleLabel, RawDigitModuleLabel)
      {}

recob::HitCollectionAssociator::HitCollectionAssociator	(	art::Event &	event,
		std::string	instance_name,
		art::InputTag const &	WireModuleLabel,
		bool	doRawDigitAssns
	)

Constructor: sets instance name and whether to build associations.

Parameters

event	the event the products are going to be put into
instance_name	name of the instance for all data products
WireModuleLabel	label of the module used to create wires
doRawDigitAssns	whether to write associations with raw digits

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

The raw digit association is built out of their existing associations with wires, rather than by directly using the raw digits data product.

Definition at line 367 of file HitCreator.cxx.

    : HitAndAssociationsWriterBase(
        event, instance_name,
        WireModuleLabel != "", doRawDigitAssns
        )
    , wires_label(WireModuleLabel)
    , digits_label()
  {
    if (RawDigitAssns && !WireAssns) {
      throw art::Exception(art::errors::LogicError)
        << "HitCollectionAssociator can't create hit <--> raw digit"
        " associations through wires, without wires!\n";
    }
    hits.reset(new std::vector<recob::Hit>);
  } // HitCollectionAssociator::HitCollectionAssociator()

recob::HitCollectionAssociator::HitCollectionAssociator ( art::Event &  event, art::InputTag const &  WireModuleLabel, bool  doRawDigitAssns  )

inline

Constructor: sets instance name and whether to build associations.

Parameters

event	the event the products are going to be put into
WireModuleLabel	label of the module used to create wires
doRawDigitAssns	whether to write associations with raw digits

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

The raw digit association is built out of their existing associations with wires, rather than by directly using the raw digits data product.

Definition at line 767 of file HitCreator.h.

       :
      HitCollectionAssociator
        (event, "", WireModuleLabel, doRawDigitAssns)
      {}

Member Function Documentation

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

protected

Finds out the associations for the specified hits.

Definition at line 405 of file HitCreator.cxx.

  {
    if (!RawDigitAssns && !WireAssns) return; // no associations needed
    assert(event);

    // we make the associations anew
    if (RawDigitAssns) ClearAssociations(*RawDigitAssns);
    if (WireAssns)     ClearAssociations(*WireAssns);

    // the following is true is we want associations with digits
    // but we don't know where digits are; in that case, we try to use wires
    const bool bUseWiresForDigits = RawDigitAssns && (digits_label == "");

    if (WireAssns || bUseWiresForDigits) {
      // do we use wires for digit associations too?

      // get the wire collection
      art::ValidHandle<std::vector<recob::Wire>> hWires
        = event->getValidHandle<std::vector<recob::Wire>>(wires_label);

      // fill a map of wire index vs. channel number
      std::vector<size_t> WireMap
        = util::MakeIndex(*hWires, std::mem_fn(&recob::Wire::Channel));

      // use raw rigit - wire association, assuming they have been produced
      // by the same producer as the wire and with the same instance name;
      // we don't check whether the data product is found, but the following
      // code will have FindOneP throw if that was not the case
      // (that's what we would do here anyway, maybe with a better message...)
      std::unique_ptr<art::FindOneP<raw::RawDigit>> WireToDigit;
      if (bUseWiresForDigits) {
        WireToDigit.reset
          (new art::FindOneP<raw::RawDigit>(hWires, *event, wires_label));
      }

      // add associations, hit by hit:
      for (size_t iHit = 0; iHit < srchits.size(); ++iHit) {

        // find the channel
        size_t iChannel = size_t(srchits[iHit].Channel()); // forcibly converted

        // find the wire associated to that channel
        size_t iWire = std::numeric_limits<size_t>::max();
        if (iChannel < WireMap.size()) iWire = WireMap[iChannel];
        if (iWire == std::numeric_limits<size_t>::max()) {
          throw art::Exception(art::errors::LogicError)
            << "No wire associated to channel #" << iChannel << " whence hit #"
            << iHit << " comes!\n";
        } // if no channel

        // make the association with wires
        if (WireAssns) {
          art::Ptr<recob::Wire> wire(hWires, iWire);
          WireAssns->addSingle(wire, CreatePtr(iHit));
        }

        if (bUseWiresForDigits) {
          // find the digit associated to that channel
          art::Ptr<raw::RawDigit> const& digit = WireToDigit->at(iWire);
          if (digit.isNull()) {
            throw art::Exception(art::errors::LogicError)
              << "No raw digit associated to channel #" << iChannel
              << " whence hit #" << iHit << " comes!\n";
          } // if no channel

          // make the association
          RawDigitAssns->addSingle(digit, CreatePtr(iHit));
        } // if create digit associations through wires
      } // for hit

    } // if wire associations

    if (RawDigitAssns && !bUseWiresForDigits) {
      // get the digit collection
      art::ValidHandle<std::vector<raw::RawDigit>> hDigits
        = event->getValidHandle<std::vector<raw::RawDigit>>(digits_label);

      // fill a map of wire index vs. channel number
      std::vector<size_t> DigitMap
        = util::MakeIndex(*hDigits, std::mem_fn(&raw::RawDigit::Channel));

      // add associations, hit by hit:
      for (size_t iHit = 0; iHit < srchits.size(); ++iHit) {

        // find the channel
        size_t iChannel = size_t(srchits[iHit].Channel()); // forcibly converted

        // find the digit associated to that channel
        size_t iDigit = std::numeric_limits<size_t>::max();
        if (iChannel < DigitMap.size()) iDigit = DigitMap[iChannel];
        if (iDigit == std::numeric_limits<size_t>::max()) {
          throw art::Exception(art::errors::LogicError)
            << "No raw digit associated to channel #" << iChannel
            << " whence hit #" << iHit << " comes!\n";
        } // if no channel

        // make the association
        art::Ptr<raw::RawDigit> digit(hDigits, iDigit);
        RawDigitAssns->addSingle(digit, CreatePtr(iHit));

      } // for hit
    } // if we have rawdigit label

  } // HitCollectionAssociator::put_into()

void recob::HitCollectionAssociator::prepare_associations ( )

inlineprotected

Finds out the associations for the current hits.

Definition at line 823 of file HitCreator.h.

{ prepare_associations(*hits); }

void recob::HitCollectionAssociator::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 801 of file HitCreator.h.

{ put_into(); }

void recob::HitCollectionAssociator::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 397 of file HitCreator.cxx.

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

void recob::HitCollectionAssociator::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 390 of file HitCreator.cxx.

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

Member Data Documentation

art::InputTag recob::HitCollectionAssociator::digits_label

protected

Label of raw digits collection to associate.

Definition at line 817 of file HitCreator.h.

art::InputTag recob::HitCollectionAssociator::wires_label

protected

Label of the collection of wires to associate.

Definition at line 815 of file HitCreator.h.

---

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

• HitCreator.h
• HitCreator.cxx