#include "PedAlgoUB.h"

Inheritance diagram for pmtana::PedAlgoUB:

Public Member Functions
	PedAlgoUB (const std::string name="PedCD")
	Default constructor. More...

	PedAlgoUB (const fhicl::ParameterSet &pset, const std::string name="PedAlgoUB")
	Alternative ctor. More...

virtual	~PedAlgoUB ()
	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...

const pmtana::PedestalMean_t &	Mean () const
	Getter of the pedestal mean value. More...

double	Sigma (size_t i) const
	Getter of the pedestal standard deviation. More...

const pmtana::PedestalSigma_t &	Sigma () const
	Getter of the pedestal standard deviation. More...

Protected Member Functions
bool	ComputePedestal (const pmtana::Waveform_t &wf, pmtana::PedestalMean_t &mean_v, pmtana::PedestalSigma_t &sigma_v)
	Method to compute a pedestal of the input waveform using "nsample" ADC samples from "start" index. More...

virtual bool	ComputePedestal (const ::pmtana::Waveform_t &wf, pmtana::PedestalMean_t &mean_v, pmtana::PedestalSigma_t &sigma_v)=0

Private Attributes
PedAlgoRmsSlider	_beamgatealgo

unsigned int	_beam_gate_samples

Detailed Description

A class that calculates pedestal mean & standard deviation (here and elsewhere called as "RMS").

Definition at line 32 of file PedAlgoUB.h.

Constructor & Destructor Documentation

pmtana::PedAlgoUB::PedAlgoUB ( const std::string name = "PedCD" )

Default constructor.

Definition at line 17 of file PedAlgoUB.cxx.

     : PMTPedestalBase(name),
       _beamgatealgo(name)
   //************************************************
   {}

pmtana::PedAlgoUB::PedAlgoUB	(	const fhicl::ParameterSet &	pset,
		const std::string	name = `"PedAlgoUB"`
	)

Alternative ctor.

Definition at line 24 of file PedAlgoUB.cxx.

References _beam_gate_samples, and fhicl::ParameterSet::get().

     : PMTPedestalBase(name)
     //, _beamgatealgo(pset.get_pset("BeamGateAlgo"),"BeamGateAlgo")
     , _beamgatealgo(pset,"BeamGateAlgo")
       //*************************************************************
   {
     _beam_gate_samples = pset.get<unsigned int>("BeamGateSamples");
   }

pmtana::PedAlgoUB::~PedAlgoUB ( )

virtual

Default destructor.

Definition at line 36 of file PedAlgoUB.cxx.

38 {}

Member Function Documentation

bool pmtana::PedAlgoUB::ComputePedestal	(	const pmtana::Waveform_t &	wf,
		pmtana::PedestalMean_t &	mean_v,
		pmtana::PedestalSigma_t &	sigma_v
	)

protected

Method to compute a pedestal of the input waveform using "nsample" ADC samples from "start" index.

Definition at line 41 of file PedAlgoUB.cxx.

References _beam_gate_samples, _beamgatealgo, pmtana::PMTPedestalBase::Evaluate(), pmtana::PMTPedestalBase::Mean(), and pmtana::PMTPedestalBase::Sigma().

   {
 
     if ( wf.size() < _beam_gate_samples ) { 
     
       double ped_mean  = wf.front(); //first sample
       double ped_sigma = 0;
 
       for( auto &v : mean_v  ) v = ped_mean;
       for( auto &v : sigma_v ) v = ped_sigma;
     
       return true;
     
     }
 
     else {
 
       _beamgatealgo.Evaluate(wf);
       mean_v  = _beamgatealgo.Mean();
       sigma_v = _beamgatealgo.Sigma();
 
       return true;
     }
     
   }

virtual bool pmtana::PMTPedestalBase::ComputePedestal	(	const ::pmtana::Waveform_t &	wf,
		pmtana::PedestalMean_t &	mean_v,
		pmtana::PedestalSigma_t &	sigma_v
	)

protectedpure virtualinherited

Method to compute pedestal: mean and sigma array should be filled per ADC. The length of each array is guaranteed to be same.

Referenced by pmtana::PMTPedestalBase::Evaluate().

bool pmtana::PMTPedestalBase::Evaluate ( const pmtana::Waveform_t & wf )

inherited

Method to compute a pedestal.

Definition at line 33 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_mean_v, pmtana::PMTPedestalBase::_sigma_v, and pmtana::PMTPedestalBase::ComputePedestal().

Referenced by ComputePedestal(), and pmtana::PulseRecoManager::Reconstruct().

   {
     _mean_v.resize(wf.size(),0);
     _sigma_v.resize(wf.size(),0);
 
     for(size_t i=0; i<wf.size(); ++i)
       _mean_v[i] = _sigma_v[i] = 0;
 
     const bool res = ComputePedestal(wf, _mean_v, _sigma_v);
 
     if(wf.size() != _mean_v.size())
       throw OpticalRecoException("Internal error: computed pedestal mean array length changed!");
     if(wf.size() != _sigma_v.size())
       throw OpticalRecoException("Internal error: computed pedestal sigma array length changed!");
 
     return res;
   }

double pmtana::PMTPedestalBase::Mean ( size_t i ) const

inherited

Getter of the pedestal mean value.

Definition at line 53 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_mean_v, and ss.

Referenced by ComputePedestal(), and pmtana::PulseRecoManager::Reconstruct().

   {
     if(i > _mean_v.size()) {
       std::stringstream ss;
       ss << "Invalid index: no pedestal mean exist @ " << i;
       throw OpticalRecoException(ss.str());
     }
     return _mean_v[i];
   }

const PedestalMean_t & pmtana::PMTPedestalBase::Mean ( ) const

inherited

Getter of the pedestal mean value.

Definition at line 77 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_mean_v.

79 { return _mean_v; }

pmtana::PMTPedestalBase::_mean_v

pmtana::PedestalMean_t _mean_v

A variable holder for pedestal mean value.

Definition: PMTPedestalBase.h:72

const std::string & pmtana::PMTPedestalBase::Name ( ) const

inherited

Name getter.

Definition at line 28 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_name.

30 { return _name;}

pmtana::PMTPedestalBase::_name

std::string _name

Name.

Definition: PMTPedestalBase.h:69

double pmtana::PMTPedestalBase::Sigma ( size_t i ) const

inherited

Getter of the pedestal standard deviation.

Definition at line 65 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_sigma_v, and ss.

Referenced by ComputePedestal(), and pmtana::PulseRecoManager::Reconstruct().

   {
     if(i > _sigma_v.size()) {
       std::stringstream ss;
       ss << "Invalid index: no pedestal sigma exist @ " << i;
       throw OpticalRecoException(ss.str());
     }
     return _sigma_v[i];
   }