pmtana::PMTPedestalBase Class Reference

#include "PMTPedestalBase.h"

Inheritance diagram for pmtana::PMTPedestalBase:

Public Member Functions
	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 (const ::pmtana::Waveform_t &wf, pmtana::PedestalMean_t &mean_v, pmtana::PedestalSigma_t &sigma_v)=0

Private Attributes
std::string	_name
	Name. More...
pmtana::PedestalMean_t	_mean_v
	A variable holder for pedestal mean value. More...
pmtana::PedestalSigma_t	_sigma_v
	A variable holder for pedestal standard deviation. More...

Detailed Description

A base class for pedestal calculation

Definition at line 28 of file PMTPedestalBase.h.

Constructor & Destructor Documentation

pmtana::PMTPedestalBase::PMTPedestalBase

(

std::string

name = "noname"

)

Default constructor.

Definition at line 16 of file PMTPedestalBase.cxx.

                                                 : _name(name)
                                     , _mean_v()
                                     , _sigma_v()
  //**************************************************************
  {}

pmtana::PMTPedestalBase::~PMTPedestalBase ( )

virtual

Default destructor.

Definition at line 23 of file PMTPedestalBase.cxx.

  {}

Member Function Documentation

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

protectedpure virtual

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 Evaluate().

bool pmtana::PMTPedestalBase::Evaluate

(

const pmtana::Waveform_t &

wf

)

Method to compute a pedestal.

Definition at line 33 of file PMTPedestalBase.cxx.

References _mean_v, _sigma_v, and 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

Getter of the pedestal mean value.

Definition at line 53 of file PMTPedestalBase.cxx.

References _mean_v, and ss.

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

Getter of the pedestal mean value.

Definition at line 77 of file PMTPedestalBase.cxx.

References _mean_v.

  { return _mean_v; }

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

(

)

const

Name getter.

Definition at line 28 of file PMTPedestalBase.cxx.

References _name.

  { return _name;}

double pmtana::PMTPedestalBase::Sigma

(

size_t

i

)

const

Getter of the pedestal standard deviation.

Definition at line 65 of file PMTPedestalBase.cxx.

References _sigma_v, and ss.

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

Getter of the pedestal standard deviation.

Definition at line 82 of file PMTPedestalBase.cxx.

References _sigma_v.

  { return _sigma_v; }

Member Data Documentation

pmtana::PedestalMean_t pmtana::PMTPedestalBase::_mean_v

private

A variable holder for pedestal mean value.

Definition at line 72 of file PMTPedestalBase.h.

Referenced by Evaluate(), and Mean().

std::string pmtana::PMTPedestalBase::_name

private

Name.

Definition at line 69 of file PMTPedestalBase.h.

Referenced by Name().

pmtana::PedestalSigma_t pmtana::PMTPedestalBase::_sigma_v

private

A variable holder for pedestal standard deviation.

Definition at line 75 of file PMTPedestalBase.h.

Referenced by Evaluate(), and Sigma().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larana/v07_04_02/source/larana/OpticalDetector/OpHitFinder/PMTPedestalBase.h
• /cvmfs/larsoft.opensciencegrid.org/products/larana/v07_04_02/source/larana/OpticalDetector/OpHitFinder/PMTPedestalBase.cxx