recob::HitCollectionCreator Class Reference

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

#include "HitCreator.h"

Inheritance diagram for recob::HitCollectionCreator:

Public Member Functions
size_t	size () const
	Returns the number of hits currently in the collection. More...
void	reserve (size_t new_size)
	Prepares the collection to host at least new_size hits. More...
void	put_into (art::Event &)
	Moves the data into an 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...
Constructors
template<typename ModuleType >
	HitCollectionCreator (ModuleType &producer, art::Event &event, std::string instance_name="", bool doWireAssns=true, bool doRawDigitAssns=true)
	Constructor: sets instance name and whether to build associations. More...
template<typename ModuleType >
	HitCollectionCreator (ModuleType &producer, art::Event &event, bool doWireAssns, bool doRawDigitAssns)
	Constructor: no product instance name. More...
Addition of hits
void	emplace_back (recob::Hit &&hit, art::Ptr< recob::Wire > const &wire=art::Ptr< recob::Wire >(), art::Ptr< raw::RawDigit > const &digits=art::Ptr< raw::RawDigit >())
	Adds the specified hit to the data collection. More...
void	emplace_back (recob::Hit const &hit, art::Ptr< recob::Wire > const &wire=art::Ptr< recob::Wire >(), art::Ptr< raw::RawDigit > const &digits=art::Ptr< raw::RawDigit >())
	Adds the specified hit to the data collection. More...
void	emplace_back (HitCreator &&hit, art::Ptr< recob::Wire > const &wire=art::Ptr< recob::Wire >(), art::Ptr< raw::RawDigit > const &digits=art::Ptr< raw::RawDigit >())
	Adds the specified hit to the data collection. More...
void	emplace_back (recob::Hit &&hit, art::Ptr< raw::RawDigit > const &digits)
	Adds the specified hit to the data collection. More...
void	emplace_back (HitCreator &&hit, art::Ptr< raw::RawDigit > const &digits)
	Adds the specified hit to the data collection. More...
void	emplace_back (HitCreator const &hit, art::Ptr< raw::RawDigit > const &digits)
	Adds the specified hit to the data collection. 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 = HitAndAssociationsWriterBase::HitPtr_t

Protected Member Functions
HitPtr_t	CreatePtrToLastHit () const
	Creates an art pointer to the hit with the last index. More...
void	CreateAssociationsToLastHit (art::Ptr< recob::Wire > const &wire, art::Ptr< raw::RawDigit > const &digits)
	Creates associations between the last hit and the specified pointers. 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

A 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 push hits into this object, and then move it into the event.

Definition at line 513 of file HitCreator.h.

Member Typedef Documentation

using recob::HitCollectionCreator::HitPtr_t = HitAndAssociationsWriterBase::HitPtr_t

protected

Definition at line 680 of file HitCreator.h.

Constructor & Destructor Documentation

template<typename ModuleType >

recob::HitCollectionCreator::HitCollectionCreator	(	ModuleType &	producer,
		art::Event &	event,
		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
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 1159 of file HitCreator.h.

References recob::HitAndAssociationsWriterBase::hits.

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

template<typename ModuleType >

recob::HitCollectionCreator::HitCollectionCreator ( ModuleType &  producer, art::Event &  event, bool  doWireAssns, bool  doRawDigitAssns  )

inline

Constructor: no product instance name.

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
doWireAssns	whether to enable associations to wires
doRawDigitAssns	whether to enable associations to raw digits

Definition at line 547 of file HitCreator.h.

       :
      HitCollectionCreator(producer, event, "", doWireAssns, doRawDigitAssns)
      {}

Member Function Documentation

void recob::HitCollectionCreator::CreateAssociationsToLastHit ( art::Ptr< recob::Wire > const &  wire, art::Ptr< raw::RawDigit > const &  digits  )

protected

Creates associations between the last hit and the specified pointers.

Definition at line 282 of file HitCreator.cxx.

References art::Ptr< T >::isNonnull(), and recob::HitCollectionAssociator::use_hits().

    {
    // if no association is required, we are done
    if (!WireAssns && !RawDigitAssns) return;
    
    // art pointer to the hit we just created
    HitPtr_t hit_ptr(CreatePtrToLastHit());
    
    // association with wires
    if (WireAssns && wire.isNonnull())
      WireAssns->addSingle(wire, hit_ptr); // if it fails, it throws
    
    // association with wires
    if (RawDigitAssns && digits.isNonnull())
      RawDigitAssns->addSingle(digits, hit_ptr); // if it fails, it throws
    
  } // HitCollectionCreator::CreateAssociationsToLastHit()

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); }

HitPtr_t recob::HitCollectionCreator::CreatePtrToLastHit ( ) const

inlineprotected

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

Definition at line 683 of file HitCreator.h.

References hits().

      { return hits->empty()? HitPtr_t(): CreatePtr(hits->size() - 1); }

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

void recob::HitCollectionCreator::emplace_back	(	recob::Hit &&	hit,
		art::Ptr< recob::Wire > const &	wire = art::Ptr<recob::Wire>(),
		art::Ptr< raw::RawDigit > const &	digits = art::Ptr<raw::RawDigit>()
	)

Adds the specified hit to the data collection.

Parameters

hit	the hit that will be moved into the collection
wire	art pointer to the wire to be associated to this hit
digits	art pointer to the raw digits to be associated to this hit

After this call, hit will be invalid. If a art pointer is not valid, that association will not be stored.

Definition at line 245 of file HitCreator.cxx.

References hits().

Referenced by CRHitRemoval::copyAllHits(), CRHitRemoval::copyInTimeHits(), hit::DisambigCheater::MakeDisambigHit(), hit::TTHitFinder::produce(), apa::APAHitFinder::produce(), hit::HitCheater::produce(), hit::FFTHitFinder::produce(), hit::RawHitFinder::produce(), hit::GausHitFinder::produce(), and hit::DPRawHitFinder::produce().

    {
    
    // add the hit to the collection
    hits->emplace_back(std::move(hit));
    
    CreateAssociationsToLastHit(wire, digits);
  } // HitCollectionCreator::emplace_back(Hit&&)

void recob::HitCollectionCreator::emplace_back	(	recob::Hit const &	hit,
		art::Ptr< recob::Wire > const &	wire = art::Ptr<recob::Wire>(),
		art::Ptr< raw::RawDigit > const &	digits = art::Ptr<raw::RawDigit>()
	)

Adds the specified hit to the data collection.

Parameters

hit	the hit that will be copied into the collection
wire	art pointer to the wire to be associated to this hit
digits	art pointer to the raw digits to be associated to this hit

If a art pointer is not valid, that association will not be stored.

Definition at line 258 of file HitCreator.cxx.

References hits().

    {
    
    // add the hit to the collection
    hits->push_back(hit);
    
    CreateAssociationsToLastHit(wire, digits);
  } // HitCollectionCreator::emplace_back(Hit)

void recob::HitCollectionCreator::emplace_back ( HitCreator &&  hit, art::Ptr< recob::Wire > const &  wire = art::Ptr<recob::Wire>(), art::Ptr< raw::RawDigit > const &  digits = art::Ptr<raw::RawDigit>()  )

inline

Adds the specified hit to the data collection.

Parameters

hit	the HitCreator object containing the hit
wire	art pointer to the wire to be associated to this hit
digits	art pointer to the raw digits to be associated to this hit

After this call, the hit creator will be empty. If a art pointer is not valid, that association will not be stored.

Definition at line 601 of file HitCreator.h.

      { emplace_back(hit.move(), wire, digits); }

void recob::HitCollectionCreator::emplace_back ( recob::Hit &&  hit, art::Ptr< raw::RawDigit > const &  digits  )

inline

Adds the specified hit to the data collection.

Parameters

hit	the hit that will be moved into the collection
digits	art pointer to the raw digits to be associated to this hit

After this call, hit will be invalid. If the digit pointer is not valid, its association will not be stored.

Definition at line 617 of file HitCreator.h.

      { emplace_back(std::move(hit), art::Ptr<recob::Wire>(), digits); }

void recob::HitCollectionCreator::emplace_back ( HitCreator &&  hit, art::Ptr< raw::RawDigit > const &  digits  )

inline

Adds the specified hit to the data collection.

Parameters

hit	the HitCreator object containing the hit
digits	art pointer to the raw digits to be associated to this hit

After this call, the hit creator will be empty. If the digit pointer is not valid, its association will not be stored.

Definition at line 629 of file HitCreator.h.

      { emplace_back(std::move(hit), art::Ptr<recob::Wire>(), digits); }

void recob::HitCollectionCreator::emplace_back ( HitCreator const &  hit, art::Ptr< raw::RawDigit > const &  digits  )

inline

Adds the specified hit to the data collection.

Parameters

hit	the HitCreator object containing the hit
digits	art pointer to the raw digits to be associated to this hit

If the digit pointer is not valid, its association will not be stored.

Definition at line 641 of file HitCreator.h.

References recob::HitCreator::copy().

      { emplace_back(std::move(hit.copy()), art::Ptr<recob::Wire>(), digits); }

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

inline

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

Definition at line 676 of file HitCreator.h.

References hits().

{ return *hits; }

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

inline

Moves the data into an 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 663 of file HitCreator.h.

References put_into().

Referenced by hit::DisambigCheater::produce(), hit::TTHitFinder::produce(), apa::APAHitFinder::produce(), hit::HitCheater::produce(), hit::FFTHitFinder::produce(), hit::RawHitFinder::produce(), hit::GausHitFinder::produce(), hit::DPRawHitFinder::produce(), and put_into().

{ put_into(); }

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

References hits(), art::errors::LogicError, and recob::HitAndAssociationsWriterBase::put_into().

                                      {
    if (!hits) {
      throw art::Exception(art::errors::LogicError)
        << "HitCollectionCreator is trying to put into the event"
        " a hit collection that was never created!\n";
    }
    HitAndAssociationsWriterBase::put_into();
  } // HitCollectionCreator::put_into()

void recob::HitCollectionCreator::reserve ( size_t  new_size )

inline

Prepares the collection to host at least new_size hits.

Definition at line 651 of file HitCreator.h.

References hits().

Referenced by hit::RawHitFinder::produce().

{ if (hits) hits->reserve(new_size); }

size_t recob::HitCollectionCreator::size ( ) const

inline

Returns the number of hits currently in the collection.

Definition at line 647 of file HitCreator.h.

References hits().

Referenced by hit::TTHitFinder::produce(), and hit::HitCheater::produce().

{ return hits->size(); }

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(), HitCollectionCreator(), and recob::HitRefinerAssociator::HitRefinerAssociator().

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