Class containing a waveform baseline value. More...

#include <WaveformBaseline.h>

Public Types
using	Baseline_t = float
	Type of baseline value. More...

Public Member Functions
	WaveformBaseline ()=default
	Constructor: default baseline (`0`). More...

	WaveformBaseline (Baseline_t baseline)
	Constructor: sets the baseline. More...

Access to the baseline
In addition to the direct method (`baseline()`) a few candies are offered: a function-like operator for baseline access.
Baseline_t	baseline () const

Baseline_t	operator() () const
	Returns the current baseline value. More...

Public Attributes
Baseline_t	fBaseline {}
	The current value of the baseline. More...

Detailed Description

Class containing a waveform baseline value.

The baseline is stored as a floating point value, not to lose precision.

This class is a data product wrapper for a simple value, with some usability candies attached.

Example of simple usage

icarus::WaveformBaseline const baseline { 1.2f };
std::cout << "Baseline: " << baseline << " ADC" << std::endl;

will print Baseline: 1.2 ADC.

Example of usage with quantity values

The following is a more complex example showing baseline subtraction. We assume we are using the type util::quantities::counts as ADC count type (defined in lardataalg/Utilities/quantities/electronics.h) for the waveform.

using ADCCount_t = util::quantities::counts;
std::vector<ADCCount_t> subtractBaseline
  (std::vector<ADCCount_t> const& data, icarus::WaveformBaseline const& baseline)
{
  icarus::waveform_operations::NegativePolarityOperations<float> const
    waveOps { baseline() };
  std::vector<ADCCount_t> subtracted;
  subtracted.reserve(data.size());
  for (auto sample: data) {
    subtracted.emplace_back
      (std::round(waveOps.subtractBaseline(sample.value())));
  }
  return subtracted;
} // subtractBaseline()

The subtracted waveform is positive and baseline-subtracted. We use ICARUS utilities to manage the polarity of the waveform (hard-coded negative). Note that the subtraction is less than trivial because of the integral type waveform on top of the floating point baseline. The samples are converted into floating point for the subtraction, then reconverted (rounded) back.

Definition at line 84 of file WaveformBaseline.h.