recob::HitAndAssociationsWriterBase Class Reference

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

#include <HitCreator.h>

Inheritance diagram for recob::HitAndAssociationsWriterBase:

Public Member Functions
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...

Static Public Member Functions
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
using	HitPtr_t = art::Ptr< recob::Hit >
	Type of art pointer to Hit. More...

Protected Member Functions
	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
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

Base class handling a collection of hits and its associations.

---

Instead of creating a collection of hits, one for its association with wires and one for its association with raw digits, one can use a class derived from this one:

• HitCollectionCreator: push new hits one by one
• HitCollectionAssociator: push a complete collection of hits
• HitRefinerAssociator: push a complete collection of hits deriving their associations from other hits Using put_into() will transfer into the event the data.

The typical usage is to have the constructor of the module call the static function

HitAndAssociationsWriterBase::declare_products(*this);

(this example declares a collection with empty instance name and that we want associations to both wires and raw digits), and then in produce():

HitAndAssociationsWriterDerived hcol(*this, event);

// ... fill hcol in the proper way ...

hcol.put_into(); // calls art::Event::put()

Definition at line 400 of file HitCreator.h.

Member Typedef Documentation

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

protected

Type of art pointer to Hit.

Definition at line 460 of file HitCreator.h.

Constructor & Destructor Documentation

recob::HitAndAssociationsWriterBase::HitAndAssociationsWriterBase ( art::Event &  event, std::string  instance_name, bool  doWireAssns, bool  doRawDigitAssns  )

protected

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
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 233 of file HitCreator.cxx.

    : prod_instance(instance_name)
    , hits()
    , WireAssns
      (doWireAssns? new art::Assns<recob::Wire, recob::Hit>: nullptr)
    , RawDigitAssns
      (doRawDigitAssns? new art::Assns<raw::RawDigit, recob::Hit>: nullptr)
    , event(&event)
    , hitPtrMaker(*(this->event), prod_instance)
  {} // HitAndAssociationsWriterBase::HitAndAssociationsWriterBase()

Member Function Documentation

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

inlineprotected

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

Definition at line 494 of file HitCreator.h.

{ return hitPtrMaker(index); }

void recob::HitAndAssociationsWriterBase::declare_products ( art::ProducesCollector &  collector, std::string  instance_name = "", bool  doWireAssns = true, bool  doRawDigitAssns = true  )

static

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 248 of file HitCreator.cxx.

    {
    collector.produces<std::vector<recob::Hit>>(instance_name);

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

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

inline

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

Definition at line 432 of file HitCreator.h.

{ return *hits; }

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

{ put_into(); }

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

                                              {
    assert(event);
    if (hits) event->put(std::move(hits), prod_instance);
    if (WireAssns) event->put(std::move(WireAssns), prod_instance);
    if (RawDigitAssns) event->put(std::move(RawDigitAssns), prod_instance);
  } // HitAndAssociationsWriterBase::put_into()

size_t recob::HitAndAssociationsWriterBase::size ( ) const

inline

Returns the number of hits currently in the collection.

Definition at line 407 of file HitCreator.h.

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

Member Data Documentation

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

protected

Pointer to the event we are using.

Definition at line 471 of file HitCreator.h.

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

protected

Tool to create hit pointers,.

Definition at line 473 of file HitCreator.h.

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

protected

Collection of hits.

Definition at line 465 of file HitCreator.h.

std::string recob::HitAndAssociationsWriterBase::prod_instance

protected

Tame of the instance for data products.

Definition at line 462 of file HitCreator.h.

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

protected

Associations with raw digits.

Definition at line 469 of file HitCreator.h.

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

protected

Associations with wires.

Definition at line 467 of file HitCreator.h.

---

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

• HitCreator.h
• HitCreator.cxx