pmtana::PedAlgoEdges Class Reference

#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...
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
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...
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

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 32 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, ///< Use first N samples
      kTAIL,     ///< Use last N samples
      kBOTH      ///< Calculate both and use the one with smaller RMS
    };

Constructor & Destructor Documentation

pmtana::PedAlgoEdges::PedAlgoEdges

(

const std::string

name = "PedEdges"

)

Default constructor.

Definition at line 16 of file PedAlgoEdges.cxx.

    : 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 26 of file PedAlgoEdges.cxx.

    : 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 44 of file PedAlgoEdges.cxx.

  {

    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;

  }

Member Data Documentation

PED_METHOD pmtana::PedAlgoEdges::_method

private

Methods.

Definition at line 59 of file PedAlgoEdges.h.

size_t pmtana::PedAlgoEdges::_nsample_front

private

ADC sample in front to be used

Definition at line 57 of file PedAlgoEdges.h.

size_t pmtana::PedAlgoEdges::_nsample_tail

private

ADC sample in tail to be used

Definition at line 58 of file PedAlgoEdges.h.

---

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

• PedAlgoEdges.h
• PedAlgoEdges.cxx