recob::HitCreator Class Reference

Class managing the creation of a new recob::Hit object. More...

#include <HitCreator.h>

Public Types
using	RegionOfInterest_t = recob::Wire::RegionsOfInterest_t::datarange_t
	Type of one region of interest. More...

Public Member Functions
	HitCreator (raw::RawDigit const &digits, geo::WireID const &wireID, raw::TDCtick_t start_tick, raw::TDCtick_t end_tick, float rms, float peak_time, float sigma_peak_time, float peak_amplitude, float sigma_peak_amplitude, float hit_integral, float hit_sigma_integral, float summedADC, short int multiplicity, short int local_index, float goodness_of_fit, int dof)
	Constructor: extracts some information from raw digit. More...
	HitCreator (recob::Wire const &wire, geo::WireID const &wireID, raw::TDCtick_t start_tick, raw::TDCtick_t end_tick, float rms, float peak_time, float sigma_peak_time, float peak_amplitude, float sigma_peak_amplitude, float hit_integral, float hit_sigma_integral, float summedADC, short int multiplicity, short int local_index, float goodness_of_fit, int dof)
	Constructor: extracts some information from wire. More...
	HitCreator (recob::Wire const &wire, geo::WireID const &wireID, raw::TDCtick_t start_tick, raw::TDCtick_t end_tick, float rms, float peak_time, float sigma_peak_time, float peak_amplitude, float sigma_peak_amplitude, float hit_integral, float hit_sigma_integral, short int multiplicity, short int local_index, float goodness_of_fit, int dof)
	Constructor: computes sum of ADC from wire. More...
	HitCreator (recob::Wire const &wire, geo::WireID const &wireID, float rms, float peak_time, float sigma_peak_time, float peak_amplitude, float sigma_peak_amplitude, float hit_integral, float hit_sigma_integral, float summedADC, short int multiplicity, short int local_index, float goodness_of_fit, int dof, RegionOfInterest_t const &signal)
	Constructor: uses region of interest specified by index. More...
	HitCreator (recob::Wire const &wire, geo::WireID const &wireID, float rms, float peak_time, float sigma_peak_time, float peak_amplitude, float sigma_peak_amplitude, float hit_integral, float hit_sigma_integral, float summedADC, short int multiplicity, short int local_index, float goodness_of_fit, int dof, size_t iSignalRoI)
	Constructor: uses region of interest specified by index. More...
	HitCreator (recob::Hit const &from)
	Constructor: copies from an existing hit. More...
	HitCreator (recob::Hit const &from, geo::WireID const &wireID)
	Constructor: copies from an existing hit, changing wire ID. More...
recob::Hit &&	move ()
	Prepares the constructed hit to be moved away. More...
recob::Hit const &	copy () const
	Returns the constructed wire. More...

Protected Attributes
recob::Hit	hit
	Local instance of the hit being constructed. More...

Detailed Description

Class managing the creation of a new recob::Hit object.

---

In order to be as simple as possible (Plain Old Data), data products like recob::Hit need to be stripped of most of their functions, including the ability to communicate whether a value we try to store is invalid (that would require a art::Exception` – art – or at least a message on the screen – MessageFacility) and the ability to read things from event, services (e.g. geometry) etc.

A Creator is a class that creates a temporary data product, and at the end it yields it to the caller for storage. This last step should be by move construction, although a copy method is also provided.

An example of creating a recob::Hit object (assuming all the relevant variables have been assigned proper values):

recob::HitCreator hit(
  wire, wireID,
  start_tick, end_tick, rms,
  peak_time, sigma_peak_time, peak_amplitude, sigma_peak_amplitude,
  hit_integral, hit_sigma_integral, summedADC,
  multiplicity, local_index, goodness_of_fit, dof
  );
hit.push_back(hit.move()); // hit content is not valid any more

This is a one-step creation object: the hit is constructed at the same time the HitCreator is, and no facility is offered to modify the constructed hit, or to create another one.

The constructors currently provided are:

1. from RawDigit (extracts channel, view and signal type [CVS] thanks to geometry)
2. from recob::Wire, [CVS]
3. from recob::Wire, [CVS], summedADC is automatically computed from wire
4. from recob::Wire, [CVS], start and stop time from a region of interest
5. from recob::Wire, [CVS], start and stop time from index of region of interest

Definition at line 83 of file HitCreator.h.

Member Typedef Documentation

using recob::HitCreator::RegionOfInterest_t = recob::Wire::RegionsOfInterest_t::datarange_t

Type of one region of interest.

Definition at line 86 of file HitCreator.h.

Constructor & Destructor Documentation

recob::HitCreator::HitCreator	(	raw::RawDigit const &	digits,
		geo::WireID const &	wireID,
		raw::TDCtick_t	start_tick,
		raw::TDCtick_t	end_tick,
		float	rms,
		float	peak_time,
		float	sigma_peak_time,
		float	peak_amplitude,
		float	sigma_peak_amplitude,
		float	hit_integral,
		float	hit_sigma_integral,
		float	summedADC,
		short int	multiplicity,
		short int	local_index,
		float	goodness_of_fit,
		int	dof
	)

Constructor: extracts some information from raw digit.

Parameters

digits	a pointer to a raw::RawDigit (for channel, view, signal type)
wireID	ID of the wire the hit is on
start_tick	first tick in the region the hit was extracted from
end_tick	first tick after the region the hit was extracted from
rms	RMS of the signal hit, in TDC time units
peak_time	time at peak of the signal, in TDC time units
sigma_peak_time	uncertainty on time at peak, in TDC time units
peak_amplitude	amplitude of the signal at peak, in ADC units
sigma_peak_amplitude	uncertainty on amplitude at peak
hit_integral	total charge integrated under the hit signal
hit_sigma_integral	uncertainty on the total hit charge
summedADC	total ADC count in the region assigned to the hit
multiplicity	number of hits in the region it was extracted from
local_index	index of this hit in the region it was extracted from
goodness_of_fit	quality parameter for the hit
dof	degrees of freedom in the definition of the hit shape

The information used from the raw digit is the channel ID; view and signal type are obtained from geometry.

Definition at line 50 of file HitCreator.cxx.

     :
    hit(
      digits.Channel(),
      start_tick,
      end_tick,
      peak_time,
      sigma_peak_time,
      rms,
      peak_amplitude,
      sigma_peak_amplitude,
      summedADC,
      hit_integral,
      hit_sigma_integral,
      multiplicity,
      local_index,
      goodness_of_fit,
      dof,
      art::ServiceHandle<geo::Geometry const>()->View(digits.Channel()),
      art::ServiceHandle<geo::Geometry const>()->SignalType(digits.Channel()),
      wireID
      )
  {} // HitCreator::HitCreator(RawDigit)

recob::HitCreator::HitCreator	(	recob::Wire const &	wire,
		geo::WireID const &	wireID,
		raw::TDCtick_t	start_tick,
		raw::TDCtick_t	end_tick,
		float	rms,
		float	peak_time,
		float	sigma_peak_time,
		float	peak_amplitude,
		float	sigma_peak_amplitude,
		float	hit_integral,
		float	hit_sigma_integral,
		float	summedADC,
		short int	multiplicity,
		short int	local_index,
		float	goodness_of_fit,
		int	dof
	)

Constructor: extracts some information from wire.

Parameters

wire	a pointer to a recob::Wire (for channel, view, signal type)
wireID	ID of the wire the hit is on
start_tick	first tick in the region the hit was extracted from
end_tick	first tick after the region the hit was extracted from
rms	RMS of the signal hit, in TDC time units
peak_time	time at peak of the signal, in TDC time units
sigma_peak_time	uncertainty on time at peak, in TDC time units
peak_amplitude	amplitude of the signal at peak, in ADC units
sigma_peak_amplitude	uncertainty on amplitude at peak
hit_integral	total charge integrated under the hit signal
hit_sigma_integral	uncertainty on the total hit charge
summedADC	total ADC count in the region assigned to the hit
multiplicity	number of hits in the region it was extracted from
local_index	index of this hit in the region it was extracted from
goodness_of_fit	quality parameter for the hit
dof	degrees of freedom in the definition of the hit shape

The information used from the wire are the channel ID and view; the signal type is obtained from geometry.

Definition at line 92 of file HitCreator.cxx.

     :
    hit(
      wire.Channel(),
      start_tick,
      end_tick,
      peak_time,
      sigma_peak_time,
      rms,
      peak_amplitude,
      sigma_peak_amplitude,
      summedADC,
      hit_integral,
      hit_sigma_integral,
      multiplicity,
      local_index,
      goodness_of_fit,
      dof,
      wire.View(),
      art::ServiceHandle<geo::Geometry const>()->SignalType(wire.Channel()),
      wireID
      )
  {} // HitCreator::HitCreator(Wire)

recob::HitCreator::HitCreator	(	recob::Wire const &	wire,
		geo::WireID const &	wireID,
		raw::TDCtick_t	start_tick,
		raw::TDCtick_t	end_tick,
		float	rms,
		float	peak_time,
		float	sigma_peak_time,
		float	peak_amplitude,
		float	sigma_peak_amplitude,
		float	hit_integral,
		float	hit_sigma_integral,
		short int	multiplicity,
		short int	local_index,
		float	goodness_of_fit,
		int	dof
	)

Constructor: computes sum of ADC from wire.

Parameters

wire	a pointer to a recob::Wire (for channel, view, signal type)
wireID	ID of the wire the hit is on
start_tick	first tick in the region the hit was extracted from
end_tick	first tick after the region the hit was extracted from
rms	RMS of the signal hit, in TDC time units
peak_time	time at peak of the signal, in TDC time units
sigma_peak_time	uncertainty on time at peak, in TDC time units
peak_amplitude	amplitude of the signal at peak, in ADC units
sigma_peak_amplitude	uncertainty on amplitude at peak
hit_integral	total charge integrated under the hit signal
hit_sigma_integral	uncertainty on the total hit charge
multiplicity	number of hits in the region it was extracted from
local_index	index of this hit in the region it was extracted from
goodness_of_fit	quality parameter for the hit
dof	degrees of freedom in the definition of the hit shape

The information used from the wire are the channel ID, view; the signal type is obtained from geometry.

The sum of ADC counts is automatically computed over the whole range of the wire signal between start_tick and end_tick (the latter excluded).

Definition at line 134 of file HitCreator.cxx.

     :
    HitCreator(
      wire, wireID, start_tick, end_tick,
      rms, peak_time, sigma_peak_time, peak_amplitude, sigma_peak_amplitude,
      hit_integral, hit_sigma_integral,
      std::accumulate(
        wire.SignalROI().begin() + start_tick,
        wire.SignalROI().begin() + end_tick,
        0.
        ), // sum of ADC counts between start_tick and end_tick
      multiplicity, local_index,
      goodness_of_fit, dof
      )
  {} // HitCreator::HitCreator(Wire; no summed ADC)

recob::HitCreator::HitCreator	(	recob::Wire const &	wire,
		geo::WireID const &	wireID,
		float	rms,
		float	peak_time,
		float	sigma_peak_time,
		float	peak_amplitude,
		float	sigma_peak_amplitude,
		float	hit_integral,
		float	hit_sigma_integral,
		float	summedADC,
		short int	multiplicity,
		short int	local_index,
		float	goodness_of_fit,
		int	dof,
		RegionOfInterest_t const &	signal
	)

Constructor: uses region of interest specified by index.

Parameters

wire	a pointer to a recob::Wire (for channel, view, signal type)
wireID	ID of the wire the hit is on
rms	RMS of the signal hit, in TDC time units
peak_time	time at peak of the signal, in TDC time units
sigma_peak_time	uncertainty on time at peak, in TDC time units
peak_amplitude	amplitude of the signal at peak, in ADC units
sigma_peak_amplitude	uncertainty on amplitude at peak
hit_integral	total charge integrated under the hit signal
hit_sigma_integral	uncertainty on the total hit charge
summedADC	total ADC count in the region assigned to the hit
multiplicity	number of hits in the region it was extracted from
local_index	index of this hit in the region it was extracted from
goodness_of_fit	quality parameter for the hit
dof	degrees of freedom in the definition of the hit shape
signal	the signal region the hit was extracted from

The information used from the wire are the channel ID, view and the region of interest; the signal type is obtained from geometry.

Signal start and end ticks are extracted from the region of interest.

Definition at line 167 of file HitCreator.cxx.

     :
    HitCreator(
      wire, wireID, signal.begin_index(), signal.end_index(),
      rms, peak_time, sigma_peak_time, peak_amplitude, sigma_peak_amplitude,
      hit_integral, hit_sigma_integral, summedADC, multiplicity, local_index,
      goodness_of_fit, dof
      )
  {} // HitCreator::HitCreator(Wire; RoI)

recob::HitCreator::HitCreator	(	recob::Wire const &	wire,
		geo::WireID const &	wireID,
		float	rms,
		float	peak_time,
		float	sigma_peak_time,
		float	peak_amplitude,
		float	sigma_peak_amplitude,
		float	hit_integral,
		float	hit_sigma_integral,
		float	summedADC,
		short int	multiplicity,
		short int	local_index,
		float	goodness_of_fit,
		int	dof,
		size_t	iSignalRoI
	)

Constructor: uses region of interest specified by index.

Parameters

wire	a pointer to a recob::Wire (for channel, view, signal type)
wireID	ID of the wire the hit is on
rms	RMS of the signal hit, in TDC time units
peak_time	time at peak of the signal, in TDC time units
sigma_peak_time	uncertainty on time at peak, in TDC time units
peak_amplitude	amplitude of the signal at peak, in ADC units
sigma_peak_amplitude	uncertainty on amplitude at peak
hit_integral	total charge integrated under the hit signal
hit_sigma_integral	uncertainty on the total hit charge
summedADC	total ADC count in the region assigned to the hit
multiplicity	number of hits in the region it was extracted from
local_index	index of this hit in the region it was extracted from
goodness_of_fit	quality parameter for the hit
dof	degrees of freedom in the definition of the hit shape
iSignalRoI	index in the wire of the signal region the hit was extracted from

The information used from the wire are the channel ID, view and the region of interest; the signal type is obtained from geometry.

Signal start and end ticks are extracted from the region of interest.

Definition at line 194 of file HitCreator.cxx.

     :
    HitCreator(
      wire, wireID, rms, peak_time, sigma_peak_time, peak_amplitude, sigma_peak_amplitude,
      hit_integral, hit_sigma_integral, summedADC, multiplicity, local_index,
      goodness_of_fit, dof, wire.SignalROI().range(iSignalRoI)
      )
  {} // HitCreator::HitCreator(Wire; RoI index)

recob::HitCreator::HitCreator

(

recob::Hit const &

from

)

Constructor: copies from an existing hit.

Parameters

from	the original hit

Definition at line 219 of file HitCreator.cxx.

: hit(from) {}

recob::HitCreator::HitCreator	(	recob::Hit const &	from,
		geo::WireID const &	wireID
	)

Constructor: copies from an existing hit, changing wire ID.

Parameters

from	the original hit
wireID	ID of the new wire the hit is on

Definition at line 222 of file HitCreator.cxx.

                                                                     :
    hit(from)
  {
    hit.fWireID = wireID;
  } // HitCreator::HitCreator(new wire ID)

Member Function Documentation

recob::Hit const& recob::HitCreator::copy ( ) const

inline

Returns the constructed wire.

Returns

a constant reference to the constructed wire

Despite the name, no copy happens in this function. Copy takes place in the caller code as proper; for example:

// be Hit a HitCreator instance:
std::vector<recob::Hit> Hits;
hit.copy();                        // nothing happens
Hits.push_back(hit.copy());        // here a copy happens
recob::Hit single_hit(hit.copy()); // hit is copied again

Definition at line 361 of file HitCreator.h.

{ return hit; }

recob::Hit&& recob::HitCreator::move ( )

inline

Prepares the constructed hit to be moved away.

Returns

a right-value reference to the constructed hit

Despite the name, no move happens in this function. Move takes place in the caller code as proper; for example:

// be hit a HitCreator instance:
std::vector<recob::Hit> Hits;
hit.move();                        // nothing happens
Hits.push_back(hit.move());        // here the copy happens
recob::Hit single_hit(hit.move()); // wrong! hit is empty now

Definition at line 343 of file HitCreator.h.

{ return std::move(hit); }

Member Data Documentation

recob::Hit recob::HitCreator::hit

protected

Local instance of the hit being constructed.

Definition at line 365 of file HitCreator.h.

---

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

• HitCreator.h
• HitCreator.cxx