icarus::WaveformRMS Struct Reference

Class containing a waveform baseline RMS value. More...

#include <WaveformRMS.h>

Public Types
using	BaselineRMS_t = float
	Type of baseline RMS value. More...

Public Member Functions
	WaveformRMS ()=default
	Constructor: default baseline RMS (0). More...
	WaveformRMS (BaselineRMS_t RMS)
	Constructor: sets the baseline RMS. More...
Access to the baseline RMS
In addition to the direct method (RMS()) a few candies are offered: a function-like operator for baseline RMS access.
BaselineRMS_t	RMS () const
BaselineRMS_t	operator() () const
	Returns the current baseline RMS value. More...

Public Attributes
BaselineRMS_t	fRMS {}
	The current value of the baseline RMS. More...

Detailed Description

Class containing a waveform baseline RMS value.

See Also

icarus::WaveformBaseline

The baseline RMS is stored as a floating point value.

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

Example of simple usage

icarus::WaveformRMS const RMS { 3.2f };

std::cout << "RMS: " << RMS << " ADC" << std::endl;

will print RMS: 3.2 ADC.

Definition at line 51 of file WaveformRMS.h.

Member Typedef Documentation

using icarus::WaveformRMS::BaselineRMS_t = float

Type of baseline RMS value.

Definition at line 53 of file WaveformRMS.h.

Constructor & Destructor Documentation

icarus::WaveformRMS::WaveformRMS ( )

default

Constructor: default baseline RMS (0).

icarus::WaveformRMS::WaveformRMS ( BaselineRMS_t  RMS )

inline

Constructor: sets the baseline RMS.

Definition at line 64 of file WaveformRMS.h.

: fRMS(RMS) {}

Member Function Documentation

BaselineRMS_t icarus::WaveformRMS::operator() ( ) const

inline

Returns the current baseline RMS value.

Definition at line 82 of file WaveformRMS.h.

{ return RMS(); }

BaselineRMS_t icarus::WaveformRMS::RMS ( ) const

inline

Returns the current baseline RMS value.

Definition at line 79 of file WaveformRMS.h.

{ return fRMS; }

Member Data Documentation

BaselineRMS_t icarus::WaveformRMS::fRMS {}

The current value of the baseline RMS.

Definition at line 55 of file WaveformRMS.h.

---

The documentation for this struct was generated from the following file:

• WaveformRMS.h