pmtana::PedAlgoFixed Class Reference

Pedestal "algorithm" reading the pedestals from somewhere else. More...

#include <PedAlgoFixed.h>

Inheritance diagram for pmtana::PedAlgoFixed:

Classes
struct	Config
struct	InputSet_t
	Input information. More...

Public Types
using	Parameters = fhicl::Table< Config >

Public Member Functions
	PedAlgoFixed (Parameters const &params, std::string const &name="PedFixed")
std::string const &	waveformSourceName () const
	Returns the name of the configured waveform source. More...
std::string const &	pedestalSourceName () const
	Returns the name of the configured pedestal source. More...
std::string const &	pedestalRMSName () const
	Returns the name of the configured RMS source. More...
void	setParameters (InputSet_t inputSet)
	Records the current pedestals and RMS per channel. More...
void	clearParameters ()
	Removes the pedestal and RMS records. More...
Public Member Functions inherited from pmtana::PMTPedestalBase
	PMTPedestalBase (std::string name="noname")
	Default constructor. More...
virtual	~PMTPedestalBase ()
	Default destructor. More...
const std::string &	Name () const
	Name getter. More...
bool	Evaluate (const pmtana::Waveform_t &wf)
	Method to compute a pedestal. More...
double	Mean (size_t i) const
	Getter of the pedestal mean value. More...
double	Sigma (size_t i) const
	Getter of the pedestal standard deviation. More...
const pmtana::PedestalMean_t &	Mean () const
	Getter of the pedestal mean value. More...
const pmtana::PedestalSigma_t &	Sigma () const
	Getter of the pedestal standard deviation. More...

Protected Member Functions
virtual bool	ComputePedestal (pmtana::Waveform_t const &waveform, pmtana::PedestalMean_t &mean_v, pmtana::PedestalSigma_t &sigma_v) override
	Computes the pedestal of the specified waveform. More...
std::pair< InputSet_t const *, std::size_t >	findWaveform (pmtana::Waveform_t const &waveform) const
	Returns the input set and index of the specified waveform. More...
Protected Member Functions inherited from pmtana::PMTPedestalBase
virtual bool	ComputePedestal (const ::pmtana::Waveform_t &wf, pmtana::PedestalMean_t &mean_v, pmtana::PedestalSigma_t &sigma_v)=0

Protected Attributes
std::string	fWaveformTag
	Name of the data source for waveforms. More...
std::string	fPedestalTag
	Name of the data source for pedestals. More...
std::string	fRMSTag
	Name of the data source for RMS. More...
InputSet_t	fInput
	The set of input waveforms currently registered. More...

Detailed Description

Pedestal "algorithm" reading the pedestals from somewhere else.

Definition at line 64 of file PedAlgoFixed.h.

Member Typedef Documentation

using pmtana::PedAlgoFixed::Parameters = fhicl::Table<Config>

Definition at line 105 of file PedAlgoFixed.h.

Constructor & Destructor Documentation

pmtana::PedAlgoFixed::PedAlgoFixed	(	Parameters const &	params,
		std::string const &	name = "PedFixed"
	)

Definition at line 29 of file PedAlgoFixed.cxx.

  : pmtana::PMTPedestalBase(name)
  , fWaveformTag{ params().WaveformTag() }
  , fPedestalTag{ params().PedestalTag() }
  , fRMSTag{ params().RMSTag().value_or(fPedestalTag) }
  {}

Member Function Documentation

void pmtana::PedAlgoFixed::clearParameters

(

)

Removes the pedestal and RMS records.

Definition at line 69 of file PedAlgoFixed.cxx.

                                         {
  fInput = {};
} // pmtana::PedAlgoFixed::clearParameters()

bool pmtana::PedAlgoFixed::ComputePedestal ( pmtana::Waveform_t const &  waveform, pmtana::PedestalMean_t &  mean_v, pmtana::PedestalSigma_t &  sigma_v  )

overrideprotectedvirtual

Computes the pedestal of the specified waveform.

Parameters

[in]	waveform	the waveform to be processed
[out]	mean_v	the mean value of the pedestal, tick by tick
[out]	sigma_v	the RMS of the pedestal, tick by tick

Returns

whether the pedestal was successfully found

The algorithm is quite simple, since it picks the baseline that was provided in the configuration.

Definition at line 75 of file PedAlgoFixed.cxx.

  {
  
  auto const [ inputSet, waveformIndex ] = findWaveform(wf);
  if (!inputSet) {
    // this means that this work is hopeless
    throw std::logic_error{
      "pmtana::PedAlgoFixed::ComputePedestal(): input waveform (address="
      + std::to_string(reinterpret_cast<std::intptr_t>(&wf))
      + ") not registered in any input (ID: "
      + std::to_string(fInput.inputID) + ")"
      };
  }
  
  std::size_t const nSamples = inputSet->waveforms[waveformIndex]->size();
  
  mean_v.resize(nSamples);
  std::fill(mean_v.begin(), mean_v.end(), inputSet->pedestals[waveformIndex]);
  
  sigma_v.resize(nSamples);
  std::fill(sigma_v.begin(), sigma_v.end(), inputSet->RMSs[waveformIndex]);
  
  return true;

} // pmtana::PedAlgoFixed::ComputePedestal()

auto pmtana::PedAlgoFixed::findWaveform ( pmtana::Waveform_t const &  waveform ) const

protected

Returns the input set and index of the specified waveform.

Definition at line 107 of file PedAlgoFixed.cxx.

{
  InputSet_t const* inputSet = &fInput;
  auto const wbegin = inputSet->waveforms.begin();
  auto const wend = inputSet->waveforms.end();
  if (auto it = std::find(wbegin, wend, &waveform); it == wend)
    return { nullptr, std::numeric_limits<std::size_t>::max() };
  else
    return { inputSet, std::distance(wbegin, it) };
  
} // pmtana::PedAlgoFixed::findWaveform()

std::string const& pmtana::PedAlgoFixed::pedestalRMSName ( ) const

inline

Returns the name of the configured RMS source.

Definition at line 122 of file PedAlgoFixed.h.

{ return fRMSTag; }

std::string const& pmtana::PedAlgoFixed::pedestalSourceName ( ) const

inline

Returns the name of the configured pedestal source.

Definition at line 119 of file PedAlgoFixed.h.

{ return fPedestalTag; }

void pmtana::PedAlgoFixed::setParameters

(

InputSet_t

inputSet

)

Records the current pedestals and RMS per channel.

Definition at line 50 of file PedAlgoFixed.cxx.

                                                          {
  if (
    (inputSet.pedestals.size() != inputSet.waveforms.size())
    || (inputSet.RMSs.size() != inputSet.waveforms.size())
  ) {
    throw std::runtime_error{
      "pmtana::PedAlgoFixed::setParameters(): inconsistent sizes of input: "
      + std::to_string(inputSet.waveforms.size()) + " waveforms, "
      + std::to_string(inputSet.pedestals.size()) + " pedestals, "
      + std::to_string(inputSet.RMSs.size()) + " RMS.\n"
      };
  }
  
  fInput = std::move(inputSet);
  
} // pmtana::PedAlgoFixed::setParameters()

std::string const& pmtana::PedAlgoFixed::waveformSourceName ( ) const

inline

Returns the name of the configured waveform source.

Definition at line 116 of file PedAlgoFixed.h.

{ return fWaveformTag; }

Member Data Documentation

InputSet_t pmtana::PedAlgoFixed::fInput

protected

The set of input waveforms currently registered.

Definition at line 142 of file PedAlgoFixed.h.

std::string pmtana::PedAlgoFixed::fPedestalTag

protected

Name of the data source for pedestals.

Definition at line 138 of file PedAlgoFixed.h.

std::string pmtana::PedAlgoFixed::fRMSTag

protected

Name of the data source for RMS.

Definition at line 139 of file PedAlgoFixed.h.

std::string pmtana::PedAlgoFixed::fWaveformTag

protected

Name of the data source for waveforms.

Definition at line 137 of file PedAlgoFixed.h.

---

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

• PedAlgoFixed.h
• PedAlgoFixed.cxx