LArSoft
v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
|
Class holding the regions of interest of signal 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... | |
Accessors | |
std::vector< float > | Signal () const |
Return a zero-padded full length vector filled with RoI signal. More... | |
const RegionsOfInterest_t & | SignalROI () const |
Returns the list of regions of interest. More... | |
std::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... | |
Sorting and comparison operations | |
bool | operator< (const Wire &than) const |
Returns whether this channel ID is smaller than the other. 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 as function of time tick. More... | |
Friends | |
class | WireCreator |
Class holding the regions of interest of signal from a channel.
The channel content is expected to have been filtered from noise and corrected for electronics response, a process often called in jargon "deconvolution".
The content is presented as calibrated ADC counts, pedestal removed, as function of time in discrete TDC units. The time is expected to be the same as for the raw::RawDigit
that originates it, i.e. starting from TPC electronics start time (use detinfo::DetectorClocks
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. By principle, the definition of the regions of interest is a negative one: we determine time intervals where we are confident no signal is present; the rest will constitute regions of interest where there might be signal. The identification of such regions is responsibility of the algorithm creating the Wire
object. In the simplest 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. More generally, the first tick of the waveform is #0, and if the first region of interest starts after that tick, it implies that the region between tick #0 and the start of that first region lacks signal. Likewise, any samples in the end of the covered time window (defined above) which lack signal are indicated by the overall size of the content, while the last region of interest ends earlier.
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:
or they can analyze region by region:
An alternative to the first form is:
which does not create a temporary dense vector, as Signal()
does instead.
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.
recob::Wire
objects LArSoft "protocol" prescribes:
recob::Wire
with the raw::RawDigit
it comes from; the association should be created by the same art module producing the recob::Wire
collectionrecob::Wire
time span should be the same as its raw::RawDigit
Two patterns can be followed for creating a recob::Wire
:
recob::WireCreator
, which extracts some relevant information from the source raw::RawDigit
but does not help with their associationIn both cases, please read the documentation of recob::Wire
constructors.
typedef lar::sparse_vector<float> recob::Wire::RegionsOfInterest_t |
recob::Wire::Wire | ( | ) |
Default constructor: a wire with no signal information.
Definition at line 17 of file Wire.cxx.
recob::Wire::Wire | ( | RegionsOfInterest_t const & | sigROIlist, |
raw::ChannelID_t | channel, | ||
geo::View_t | view | ||
) |
Constructor: uses specified signal in regions of interest.
sigROIlist | signal organized in regions of interest |
channel | the ID of the channel |
view | the view the channel belongs to |
Signal is copied into the recob::Wire
object, including the sparse region of interest structure within sigROIlist
. If possible, use the other constructor that moves the data instead.
For more details, see the other constructor documentation.
Definition at line 20 of file Wire.cxx.
recob::Wire::Wire | ( | RegionsOfInterest_t && | sigROIlist, |
raw::ChannelID_t | channel, | ||
geo::View_t | view | ||
) |
Constructor: uses specified signal in regions of interest.
sigROIlist | signal organized in regions of interest |
channel | the ID of the channel |
view | the view the channel belongs to |
The recob::Wire
object is constructed with the waveform information in sigROIlist
and assigned the specified channel
and view
.
The signal is stored in a sparse vector, each entry corresponding to a tick in the calibrated waveform. The tick range of the sparse vector reflects the one in the wire, i.e. the first sample in sigROIlist
becomes the sample #0 of the recob::Wire
waveform. The total length of the waveform (that is, its duration in ticks) is also learned from the (nominal) size of sigROIlist
(see also lar::sparse_vector::resize()
), which can and should extend beyond the last region of interest.
This constructor moves the signal information is moved sigROIlist
, that becomes invalid. This also preserves the sparse region of interest structure within sigROIlist
.
Definition at line 25 of file Wire.cxx.
|
inline |
Returns the ID of the channel (or InvalidChannelID)
Definition at line 223 of file Wire.h.
References fChannel.
Referenced by nnet::RawWaveformDump::analyze(), hit::RFFHitFinderAlg::EmplaceHit(), evdb_tool::DrawWireData::Fill(), evdb_tool::DrawWireHist::Fill(), lar_pandora::PFParticleHitDumper::FillRecoWires(), hit::HitAnaAlg::FillWireInfo(), lar_cluster3d::StandardHit3DBuilder::makeWireAssns(), lar_cluster3d::SnippetHit3DBuilder::makeWireAssns(), operator<(), recob::HitCollectionAssociator::prepare_associations(), recob::HitRefinerAssociator::prepare_associations(), caldata::DumpWires::PrintWire(), hit::TTHitFinder::produce(), hit::FFTHitFinder::produce(), hit::HitCheater::produce(), hit::GausHitFinder::produce(), hit::DPRawHitFinder::produce(), hit::CCHitFinderAlg::RunCCHitFinder(), and hit::CCHitFinderAlg::StoreHits().
|
inline |
Returns the number of time ticks, or samples, in the channel.
Definition at line 215 of file Wire.h.
References fSignalROI, and lar::sparse_vector< T >::size().
Referenced by caldata::DumpWires::PrintWire().
|
inline |
Returns whether this channel ID is smaller than the other.
Definition at line 227 of file Wire.h.
References Channel().
std::vector< float > recob::Wire::Signal | ( | ) | const |
Return a zero-padded full length vector filled with RoI signal.
Definition at line 30 of file Wire.cxx.
References lar::sparse_vector< T >::begin(), lar::sparse_vector< T >::end(), and fSignalROI.
Referenced by hit::GausHitFinderAna::analyze(), nnet::RawWaveformDump::analyze(), evdb_tool::DrawWireData::Fill(), evdb_tool::DrawWireHist::Fill(), lar_pandora::PFParticleHitDumper::FillRecoWires(), hit::TTHitFinder::produce(), hit::FFTHitFinder::produce(), and hit::CCHitFinderAlg::RunCCHitFinder().
|
inline |
Returns the list of regions of interest.
Definition at line 211 of file Wire.h.
References fSignalROI.
Referenced by hit::HitAnaAlg::FillWireInfo(), caldata::DumpWires::PrintWire(), hit::GausHitFinder::produce(), and hit::DPRawHitFinder::produce().
|
inline |
Returns the view the channel belongs to.
Definition at line 219 of file Wire.h.
References fView.
Referenced by hit::RFFHitFinderAlg::EmplaceHit(), hit::HitAnaAlg::FillWireInfo(), caldata::DumpWires::PrintWire(), and hit::CCHitFinderAlg::StoreHits().
|
friend |
|
private |
|
private |
Signal on the channel as function of time tick.
Definition at line 127 of file Wire.h.
Referenced by NSignal(), Signal(), SignalROI(), and recob::WireCreator::WireCreator().
|
private |