recob::ChannelROICreator Class Reference

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

#include <ChannelROICreator.h>

Public Types
using	RegionsOfInterest_t = ChannelROI::RegionsOfInterest_t
	Alias for the type of regions of interest. More...

Public Member Functions
	ChannelROICreator (const RegionsOfInterest_t &sigROIlist, const raw::RawDigit &rawdigit)
	Constructor: uses specified signal in regions of interest. More...
	ChannelROICreator (RegionsOfInterest_t &&sigROIlist, const raw::RawDigit &rawdigit)
	Constructor: uses specified signal in regions of interest. More...
	ChannelROICreator (RegionsOfInterest_t const &sigROIlist, raw::ChannelID_t channel)
	Constructor: uses specified signal in regions of interest. More...
	ChannelROICreator (RegionsOfInterest_t &&sigROIlist, raw::ChannelID_t channel)
	Constructor: uses specified signal in regions of interest. More...
ChannelROI &&	move ()
	Prepares the constructed wire to be moved away. More...
const ChannelROI &	copy () const
	Returns the constructed wire. More...

Protected Attributes
ChannelROI	channelROI
	local instance of the wire being constructed More...

Detailed Description

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

As Gianluca Petrillo points out, the same considerations described in recob::WireCreator apply here as well

Definition at line 31 of file ChannelROICreator.h.

Member Typedef Documentation

using recob::ChannelROICreator::RegionsOfInterest_t = ChannelROI::RegionsOfInterest_t

Alias for the type of regions of interest.

Definition at line 34 of file ChannelROICreator.h.

Constructor & Destructor Documentation

recob::ChannelROICreator::ChannelROICreator	(	const RegionsOfInterest_t &	sigROIlist,
		const raw::RawDigit &	rawdigit
	)

Constructor: uses specified signal in regions of interest.

Parameters

sigROIlist	signal organized in regions of interest
rawdigit	the raw digit this channel is associated to

The information used from the raw digit are the channel ID and the length in samples (TDC ticks) of the original readout window.

Definition at line 21 of file ChannelROICreator.cxx.

                                                                        :
    channelROI(
      sigROIlist,
      rawdigit.Channel()
    )
  {
    // resize fSignalROI again:
    // just in case the user hasn't cared to set sigROIlist size right
    channelROI.fSignalROI.resize(rawdigit.Samples());
  } // Wire::Wire(RegionsOfInterest_t&)

recob::ChannelROICreator::ChannelROICreator	(	RegionsOfInterest_t &&	sigROIlist,
		const raw::RawDigit &	rawdigit
	)

Constructor: uses specified signal in regions of interest.

Parameters

sigROIlist	signal organized in regions of interest
rawdigit	the raw digit this channel is associated to

The information used from the raw digit are the channel ID and the length in samples (TDC ticks) of the original readout window.

Signal information is moved from sigROIlist, that becomes empty.

Definition at line 34 of file ChannelROICreator.cxx.

                                                                   :
    channelROI(
      std::move(sigROIlist),
      rawdigit.Channel()
    )
  {
    // resize fSignalROI again:
    // just in case the user hasn't cared to set sigROIlist size right
    channelROI.fSignalROI.resize(rawdigit.Samples());
  } // Wire::Wire(RegionsOfInterest_t&)

recob::ChannelROICreator::ChannelROICreator	(	RegionsOfInterest_t const &	sigROIlist,
		raw::ChannelID_t	channel
	)

Constructor: uses specified signal in regions of interest.

Parameters

sigROIlist	signal organized in regions of interest
channel	the ID of the channel

The information used from the raw digit are the channel ID and the length in samples (TDC ticks) of the original readout window.

Definition at line 46 of file ChannelROICreator.cxx.

     :
    channelROI(sigROIlist, channel)
    {}

recob::ChannelROICreator::ChannelROICreator	(	RegionsOfInterest_t &&	sigROIlist,
		raw::ChannelID_t	channel
	)

Constructor: uses specified signal in regions of interest.

Parameters

sigROIlist	signal organized in regions of interest
channel	the ID of the channel
view	the view the channel belongs to

The information used from the raw digit are the channel ID and the length in samples (TDC ticks) of the original readout window.

Signal information is moved from sigROIlist, that becomes empty.

Definition at line 54 of file ChannelROICreator.cxx.

     :
    channelROI(std::move(sigROIlist), channel)
    {}

Member Function Documentation

const ChannelROI& recob::ChannelROICreator::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 wire a ChannelROICreator instance:
std::vector<recob::Wire> Wires;
wire.copy();                          // nothing happens
Wires.push_back(wire.copy());         // here a copy happens
recob::Wire single_wire(wire.copy()); // wire is copied again

Definition at line 125 of file ChannelROICreator.h.

{ return channelROI; }

ChannelROI&& recob::ChannelROICreator::move ( )

inline

Prepares the constructed wire to be moved away.

Returns

a right-value reference to the constructed wire

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

// be wire a ChannelROICreator instance:
std::vector<recob::Wire> Wires;
wire.move();                          // nothing happens
Wires.push_back(wire.move());         // here the copy happens
recob::Wire single_wire(wire.move()); // wrong! wire is empty now

Definition at line 108 of file ChannelROICreator.h.

{ return std::move(channelROI); }

Member Data Documentation

ChannelROI recob::ChannelROICreator::channelROI

protected

local instance of the wire being constructed

Definition at line 129 of file ChannelROICreator.h.

---

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

• ChannelROICreator.h
• ChannelROICreator.cxx