LArSoft  v07_07_03
Liquid Argon Software toolkit - http://larsoft.org/
recob::Wire Class Reference

Class holding the deconvoluted signals from a channel. More...

#include "Wire.h"

Public Types

typedef lar::sparse_vector< float > RegionsOfInterest_t
 a region of interest is a pair (TDC offset, readings) More...
 

Public Member Functions

 Wire ()
 Default constructor: a wire with no signal information. More...
 
 Wire (RegionsOfInterest_t const &sigROIlist, raw::ChannelID_t channel, geo::View_t view)
 Constructor: uses specified signal in regions of interest. More...
 
 Wire (RegionsOfInterest_t &&sigROIlist, raw::ChannelID_t channel, geo::View_t view)
 Constructor: uses specified signal in regions of interest. More...
 
bool operator< (const Wire &than) const
 Returns whether this channel ID is smaller than the other. More...
 
Accessors
std::vector< float > Signal () const
 Return a zero-padded full length vector filled with RoI signal. More...
 
const RegionsOfInterest_tSignalROI () const
 Returns the list of regions of interest. More...
 
size_t NSignal () const
 Returns the number of time ticks, or samples, in the channel. More...
 
geo::View_t View () const
 Returns the view the channel belongs to. More...
 
raw::ChannelID_t Channel () const
 Returns the ID of the channel (or InvalidChannelID) More...
 

Private Attributes

raw::ChannelID_t fChannel
 ID of the associated channel. More...
 
geo::View_t fView
 View corresponding to the plane of this wire. More...
 
RegionsOfInterest_t fSignalROI
 Signal on the channel. More...
 

Friends

class WireCreator
 

Detailed Description

Class holding the deconvoluted signals from a channel.

Note
Despite the name, this class is associated to a readout channel, not just a wire

The channel content is expected to have been filtered from noise and corrected for electronics response. The content is presented as calibrated ADC counts, pedestal removed, as function of time in discrete TDC units (use TimeService to discover the exact extent of each tick). The content is organized as time intervals where some signal is present ("regions of interest", RoI), outside which we assume no signal, i.e, calibrated ADC counts of 0. Strictly speaking, the definition of the regions of interest is a negative one: we first define where we are sure no signal is present; the rest will constitute regions of interest. The identification of such regions is responsibility of the algorithm creating the Wire object. In the simple approach, the whole readout window is stored in a single region of interest, meaning that we don't claim any of the channel signal to be definitely signal free.

Algorithms using the regions of interest can access the channel signal information either ignoring the regions of interest, and being potentially flooded by zeroes from the non-signal regions:

for (float ADCcount: wire.Signal()) ...

or they can analyze region by region:

for (auto iROI = wire.begin_range(); wire.end_range(); ++iROI) {
  const datarange_t& ROI = *iROI;
  const int FirstTick = ROI.begin_index();
  const int EndTick = ROI.end_index();
  const float FirstADC = ROI[FirstTick]; // index access is by absolute tick number
  for (float ADC: ROI) // ... or you can just iterate through
  // ...
} // for

Note that the indexed access is always by absolute tick number. More examples of the use of SignalROI() return value are documented in lar::sparse_vector .

Each channel is associated with a raw::RawDigit object. These associations should be stored together with recob::Wire by the producer in a art::Assns data product.

Definition at line 80 of file Wire.h.

Member Typedef Documentation

a region of interest is a pair (TDC offset, readings)

Definition at line 83 of file Wire.h.

Constructor & Destructor Documentation

recob::Wire::Wire ( )

Default constructor: a wire with no signal information.

Definition at line 17 of file Wire.cxx.

20  , fSignalROI()
21  {}
Unknown view.
Definition: geo_types.h:83
raw::ChannelID_t fChannel
ID of the associated channel.
Definition: Wire.h:89
geo::View_t fView
View corresponding to the plane of this wire.
Definition: Wire.h:90
constexpr ChannelID_t InvalidChannelID
ID of an invalid channel.
Definition: RawTypes.h:31
RegionsOfInterest_t fSignalROI
Signal on the channel.
Definition: Wire.h:91
recob::Wire::Wire ( RegionsOfInterest_t const &  sigROIlist,
raw::ChannelID_t  channel,
geo::View_t  view 
)

Constructor: uses specified signal in regions of interest.

Parameters
sigROIlistsignal organized in regions of interest
channelthe ID of the channel
viewthe 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 is copied into the Wire object. If possible, use the other constructor that moves the data instead.

Definition at line 24 of file Wire.cxx.

29  : fChannel(channel)
30  , fView(view)
31  , fSignalROI(sigROIlist)
32  {}
raw::ChannelID_t fChannel
ID of the associated channel.
Definition: Wire.h:89
geo::View_t fView
View corresponding to the plane of this wire.
Definition: Wire.h:90
RegionsOfInterest_t fSignalROI
Signal on the channel.
Definition: Wire.h:91
recob::Wire::Wire ( RegionsOfInterest_t &&  sigROIlist,
raw::ChannelID_t  channel,
geo::View_t  view 
)

Constructor: uses specified signal in regions of interest.

Parameters
sigROIlistsignal organized in regions of interest
channelthe ID of the channel
viewthe 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 35 of file Wire.cxx.

40  : fChannel(channel)
41  , fView(view)
42  , fSignalROI(std::move(sigROIlist))
43  {}
raw::ChannelID_t fChannel
ID of the associated channel.
Definition: Wire.h:89
geo::View_t fView
View corresponding to the plane of this wire.
Definition: Wire.h:90
RegionsOfInterest_t fSignalROI
Signal on the channel.
Definition: Wire.h:91

Member Function Documentation

size_t recob::Wire::NSignal ( ) const
inline

Returns the number of time ticks, or samples, in the channel.

Definition at line 162 of file Wire.h.

Referenced by caldata::DumpWires::PrintWire().

162 { return fSignalROI.size(); }
size_type size() const
Returns the size of the vector.
RegionsOfInterest_t fSignalROI
Signal on the channel.
Definition: Wire.h:91
bool recob::Wire::operator< ( const Wire than) const
inline

Returns whether this channel ID is smaller than the other.

Definition at line 165 of file Wire.h.

References Channel().

166  { return Channel() < than.Channel(); }
raw::ChannelID_t Channel() const
Returns the ID of the channel (or InvalidChannelID)
Definition: Wire.h:164
std::vector< float > recob::Wire::Signal ( ) const

Return a zero-padded full length vector filled with RoI signal.

Definition at line 47 of file Wire.cxx.

References lar::sparse_vector< T >::begin(), lar::sparse_vector< T >::end(), and fSignalROI.

Referenced by hit::GausHitFinderAna::analyze(), lar_pandora::PFParticleHitDumper::FillRecoWires(), hit::TTHitFinder::produce(), hit::FFTHitFinder::produce(), and hit::CCHitFinderAlg::RunCCHitFinder().

47  {
48  return { fSignalROI.begin(), fSignalROI.end() };
49  } // Wire::Signal()
iterator end()
Standard iterators interface.
RegionsOfInterest_t fSignalROI
Signal on the channel.
Definition: Wire.h:91
iterator begin()
Standard iterators interface.
const recob::Wire::RegionsOfInterest_t & recob::Wire::SignalROI ( ) const
inline

Returns the list of regions of interest.

Definition at line 161 of file Wire.h.

Referenced by hit::HitAnaAlg::FillWireInfo(), caldata::DumpWires::PrintWire(), hit::GausHitFinder::produce(), and hit::DPRawHitFinder::produce().

161 { return fSignalROI; }
RegionsOfInterest_t fSignalROI
Signal on the channel.
Definition: Wire.h:91
geo::View_t recob::Wire::View ( ) const
inline

Returns the view the channel belongs to.

Definition at line 163 of file Wire.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit(), hit::HitAnaAlg::FillWireInfo(), caldata::DumpWires::PrintWire(), and hit::CCHitFinderAlg::StoreHits().

163 { return fView; }
geo::View_t fView
View corresponding to the plane of this wire.
Definition: Wire.h:90

Friends And Related Function Documentation

friend class WireCreator
friend

Definition at line 94 of file Wire.h.

Member Data Documentation

raw::ChannelID_t recob::Wire::fChannel
private

ID of the associated channel.

Definition at line 89 of file Wire.h.

RegionsOfInterest_t recob::Wire::fSignalROI
private

Signal on the channel.

Definition at line 91 of file Wire.h.

Referenced by Signal().

geo::View_t recob::Wire::fView
private

View corresponding to the plane of this wire.

Definition at line 90 of file Wire.h.


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