#include "PedAlgoEdges.h"

Inheritance diagram for pmtana::PedAlgoEdges:

Public Types
enum	PED_METHOD { kHEAD = 0, kTAIL, kBOTH }
	enum to define algorithm options More...

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

	PedAlgoEdges (const fhicl::ParameterSet &pset, const std::string name="PedEdges")
	Alternative ctor. 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
size_t	_nsample_front
	ADC sample in front to be used More...

size_t	_nsample_tail
	ADC sample in tail to be used More...

PED_METHOD	_method
	Methods. More...

Detailed Description

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

Definition at line 33 of file PedAlgoEdges.h.

Member Enumeration Documentation

enum pmtana::PedAlgoEdges::PED_METHOD

enum to define algorithm options

Enumerator
kHEAD	Use first N samples.
kTAIL	Use last N samples.
kBOTH	Calculate both and use the one with smaller RMS.

Definition at line 44 of file PedAlgoEdges.h.

                     {
       kHEAD = 0, 
       kTAIL,     
       kBOTH      
     };

Constructor & Destructor Documentation

pmtana::PedAlgoEdges::PedAlgoEdges ( const std::string name = "PedEdges" )

Default constructor.

Definition at line 16 of file PedAlgoEdges.cxx.

References _method, _nsample_front, _nsample_tail, and kHEAD.

                                                  : PMTPedestalBase(name)
   //************************************************
   {
     _nsample_front = 3;
     _nsample_tail = 5;
     _method = kHEAD;
   }

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

Alternative ctor.

Definition at line 25 of file PedAlgoEdges.cxx.

References _method, _nsample_front, _nsample_tail, fhicl::ParameterSet::get(), and kBOTH.

     : PMTPedestalBase(name)
   //*************************************************************
   {
 
     _nsample_front = pset.get<size_t>("NumSampleFront");
     _nsample_tail = pset.get<size_t>("NumSampleTail");
     int method = pset.get<int>("Method");
 
     if (method < 0 || method > kBOTH)
       throw OpticalRecoException("PedAlgoEdges received invalid \"Method\" parameter value!");
 
     _method = (PED_METHOD)method;
   }

Member Function Documentation

bool pmtana::PedAlgoEdges::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 43 of file PedAlgoEdges.cxx.

References _method, _nsample_front, _nsample_tail, kBOTH, kHEAD, kTAIL, pmtana::mean(), and pmtana::std().

   {
 
     double ped_mean = 0;
     double ped_sigma = 0;
     switch (_method) {
     case kHEAD:
       ped_mean = mean(wf, 0, _nsample_front);
       ped_sigma = std(wf, ped_mean, 0, _nsample_front);
       for (auto& v : mean_v)
         v = ped_mean;
       for (auto& v : sigma_v)
         v = ped_sigma;
       break;
     case kTAIL:
       ped_mean = mean(wf, (wf.size() - _nsample_tail), _nsample_tail);
       ped_sigma = std(wf, ped_mean, (wf.size() - _nsample_tail), _nsample_tail);
       for (auto& v : mean_v)
         v = ped_mean;
       for (auto& v : sigma_v)
         v = ped_sigma;
       break;
     case kBOTH:
       double ped_mean_head = mean(wf, 0, _nsample_front);
       double ped_sigma_head = std(wf, ped_mean_head, 0, _nsample_front);
       double ped_mean_tail = mean(wf, (wf.size() - _nsample_tail), _nsample_tail);
       double ped_sigma_tail = std(wf, ped_mean_tail, (wf.size() - _nsample_tail), _nsample_tail);
 
       ped_mean = ped_mean_head;
       ped_sigma = ped_sigma_head;
       if (ped_sigma_tail < ped_sigma) {
         ped_mean = ped_mean_tail;
         ped_sigma = ped_sigma_tail;
       }
       for (auto& v : mean_v)
         v = ped_mean;
       for (auto& v : sigma_v)
         v = ped_sigma;
       break;
     }
     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 30 of file PMTPedestalBase.cxx.

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

Referenced by pmtana::PedAlgoUB::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 50 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_mean_v.

Referenced by pmtana::PedAlgoUB::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 74 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_mean_v.

   {
     return _mean_v;
   }

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

inherited

Name getter.

Definition at line 23 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_name.

   {
     return _name;
   }

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

inherited

Getter of the pedestal standard deviation.

Definition at line 62 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_sigma_v.

Referenced by pmtana::PedAlgoUB::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];
   }

const PedestalSigma_t & pmtana::PMTPedestalBase::Sigma ( ) const

inherited

Getter of the pedestal standard deviation.

Definition at line 81 of file PMTPedestalBase.cxx.

References pmtana::PMTPedestalBase::_sigma_v.

   {
     return _sigma_v;
   }

Member Data Documentation

PED_METHOD pmtana::PedAlgoEdges::_method

private

Methods.

Definition at line 59 of file PedAlgoEdges.h.

Referenced by ComputePedestal(), and PedAlgoEdges().

size_t pmtana::PedAlgoEdges::_nsample_front

private

ADC sample in front to be used

Definition at line 57 of file PedAlgoEdges.h.

Referenced by ComputePedestal(), and PedAlgoEdges().

size_t pmtana::PedAlgoEdges::_nsample_tail

private

ADC sample in tail to be used

Definition at line 58 of file PedAlgoEdges.h.

Referenced by ComputePedestal(), and PedAlgoEdges().

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

larana/v10_00_16/source/larana/OpticalDetector/OpHitFinder/PedAlgoEdges.h
larana/v10_00_16/source/larana/OpticalDetector/OpHitFinder/PedAlgoEdges.cxx

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

ADC sample in front to be used

ADC sample in tail to be used

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

ADC sample in front to be used

ADC sample in tail to be used