pmtana::PMTPulseRecoBase Class Reference

#include <PMTPulseRecoBase.h>

Inheritance diagram for pmtana::PMTPulseRecoBase:

Public Member Functions
	PMTPulseRecoBase (const std::string name="noname")
	Default constructor with fhicl parameters. More...
virtual	~PMTPulseRecoBase ()=default
	Default destructor. More...
const std::string &	Name () const
	Name getter. More...
bool	Status () const
	Status getter. More...
virtual void	Reset ()
	A method to be called event-wise to reset parameters. More...
bool	Reconstruct (const pmtana::Waveform_t &, const pmtana::PedestalMean_t &, const pmtana::PedestalSigma_t &)
const pulse_param &	GetPulse (size_t index=0) const
const pulse_param_array &	GetPulses () const
	A getter for the whole array of pulse_param struct object. More...
size_t	GetNPulse () const
	A getter for the number of reconstructed pulses from the input waveform. More...

Protected Member Functions
virtual bool	RecoPulse (const pmtana::Waveform_t &, const pmtana::PedestalMean_t &, const pmtana::PedestalSigma_t &)=0
bool	Integral (const std::vector< short > &wf, double &result, size_t begin=0, size_t end=0) const
bool	Derivative (const std::vector< short > &wf, std::vector< int32_t > &diff, size_t begin=0, size_t end=0) const
size_t	Max (const std::vector< short > &wf, double &result, size_t begin=0, size_t end=0) const
size_t	Min (const std::vector< short > &wf, double &result, size_t begin=0, size_t end=0) const

Protected Attributes
pulse_param_array	_pulse_v
	A container array of pulse_param struct objects to store (possibly multiple) reconstructed pulse(s). More...
pulse_param	_pulse
	A subject pulse_param object to be filled with the last reconstructed pulse parameters. More...

Private Attributes
std::string	_name
	Unique name. More...
bool	_status
	Status after pulse reconstruction. More...

Detailed Description

The base class of pulse reconstruction algorithms. All algorithms should inherit from this calss to be executed by a manager class, pulse_reco. Note that this class does not depend on the rest of the framework except for the use of constants. In order to reconstruct a pulse, all it requires is a std::vector<short> type object (i.e. raw waveform), waveform pedestal, and its standard deviation. All of these are to be provided by an executer. Reconstructed pulse parameters are stored in the pulse_param struct object.

All methods specified as "virtual" should be implemented by the inherit children class.

This class provides some basic std::vector calculation algorithms such as integral, derivative, max and min algorithms. Inherit children classes are encouraged to use these provided methods when possible.

Definition at line 66 of file PMTPulseRecoBase.h.

Constructor & Destructor Documentation

pmtana::PMTPulseRecoBase::PMTPulseRecoBase

(

const std::string

name = "noname"

)

Default constructor with fhicl parameters.

Definition at line 15 of file PMTPulseRecoBase.cxx.

                                                         : _name   (name)
                                                             , _status (true)
  //*************************************************************************
  { Reset(); }

virtual pmtana::PMTPulseRecoBase::~PMTPulseRecoBase ( )

virtualdefault

Default destructor.

Member Function Documentation

bool pmtana::PMTPulseRecoBase::Derivative ( const std::vector< short > &  wf, std::vector< int32_t > &  diff, size_t  begin = 0, size_t  end = 0  ) const

protected

A method to compute derivative, which is a simple subtraction of previous ADC sample from each sample. The result is stored in the input "diff" reference vector which is int32_t type as a derivative could be negative.

Definition at line 117 of file PMTPulseRecoBase.cxx.

  {

    if(CheckIndex(wf,begin,end)){

      diff.clear();
      diff.reserve(end - begin);

      for(size_t index = begin ; index <= end ; ++index)

        diff.push_back(wf.at(index+1) - wf.at(index));

      return true;
    }

    return false;

  }

size_t pmtana::PMTPulseRecoBase::GetNPulse ( ) const

inline

A getter for the number of reconstructed pulses from the input waveform.

Definition at line 102 of file PMTPulseRecoBase.h.

{return _pulse_v.size();};

const pulse_param & pmtana::PMTPulseRecoBase::GetPulse

(

size_t

index = 0

)

const

A getter for the pulse_param struct object. Reconstruction algorithm may have more than one pulse reconstructed from an input waveform. Note you must, accordingly, provide an index key to specify which pulse_param object to be retrieved.

Definition at line 68 of file PMTPulseRecoBase.cxx.

  {

    if(index >= _pulse_v.size()) {

      std::cerr << "\033[93m"
                << "Invalid pulse index: " << index
                << "\033[00m"
                << std::endl;

      throw std::exception();
    }

    else return _pulse_v.at(index);

  }

const pulse_param_array & pmtana::PMTPulseRecoBase::GetPulses

(

)

const

A getter for the whole array of pulse_param struct object.

Definition at line 87 of file PMTPulseRecoBase.cxx.

  {
    return _pulse_v;
  }

bool pmtana::PMTPulseRecoBase::Integral ( const std::vector< short > &  wf, double &  result, size_t  begin = 0, size_t  end = 0  ) const

protected

A method to integrate an waveform from index "begin" to the "end". The result is filled in "result" reference. If the "end" is default (=0), then "end" is set to the last index of the waveform.

Definition at line 94 of file PMTPulseRecoBase.cxx.

  {

    if(!CheckIndex(wf,begin,end)) return false;

    std::vector<short>::const_iterator begin_iter(wf.begin());

    std::vector<short>::const_iterator end_iter(wf.begin());

    begin_iter = begin_iter + begin;

    end_iter = end_iter + end + 1;

    result = (double)(std::accumulate(begin_iter, end_iter, 0));

    return true;
  }

size_t pmtana::PMTPulseRecoBase::Max ( const std::vector< short > &  wf, double &  result, size_t  begin = 0, size_t  end = 0  ) const

protected

A method to return the maximum value of ADC sample within the index from "begin" to "end". If the "end" is default (=0), then "end" is set to the last index of the waveform.

Definition at line 141 of file PMTPulseRecoBase.cxx.

  {

    size_t target_index = wf.size() + 1;

    result = 0;

    if(CheckIndex(wf,begin,end)) {

      for(size_t index = begin; index <= end; ++index)

        if( result < wf.at(index)) { target_index = index; result = (double)(wf.at(index)); }

    }

    return target_index;

  }

size_t pmtana::PMTPulseRecoBase::Min ( const std::vector< short > &  wf, double &  result, size_t  begin = 0, size_t  end = 0  ) const

protected

A method to return the minimum value of ADC sample within the index from "begin" to "end". If the "end" is default (=0), then "end" is set to the last index of the waveform.

Definition at line 165 of file PMTPulseRecoBase.cxx.

  {

    size_t target_index = wf.size() + 1;

    result = 4096;

    if(CheckIndex(wf,begin,end)) {

      for(size_t index = begin; index <= end; ++index)

        if( result > wf.at(index)) { target_index = index; result = (double)(wf.at(index)); }

    }

    return target_index;

  }

const std::string & pmtana::PMTPulseRecoBase::Name

(

void

)

const

Name getter.

Definition at line 21 of file PMTPulseRecoBase.cxx.

  { return _name; }

bool pmtana::PMTPulseRecoBase::Reconstruct	(	const pmtana::Waveform_t &	wf,
		const pmtana::PedestalMean_t &	mean_v,
		const pmtana::PedestalSigma_t &	sigma_v
	)

A core method: this executes the algorithm and stores reconstructed parameters in the pulse_param struct object.

Definition at line 31 of file PMTPulseRecoBase.cxx.

  {
    _status = this->RecoPulse(wf,mean_v,sigma_v);
    return _status;
  }

virtual bool pmtana::PMTPulseRecoBase::RecoPulse ( const pmtana::Waveform_t &  , const pmtana::PedestalMean_t &  , const pmtana::PedestalSigma_t &    )

protectedpure virtual

Implemented in pmtana::AlgoFixedWindow, pmtana::AlgoThreshold, pmtana::AlgoCFD, pmtana::AlgoSlidingWindow, pmtana::AlgoSiPM, and pmtana::AlgoSSPLeadingEdge.

void pmtana::PMTPulseRecoBase::Reset ( void  )

virtual

A method to be called event-wise to reset parameters.

Reimplemented in pmtana::AlgoFixedWindow, pmtana::AlgoThreshold, pmtana::AlgoCFD, pmtana::AlgoSlidingWindow, pmtana::AlgoSSPLeadingEdge, and pmtana::AlgoSiPM.

Definition at line 57 of file PMTPulseRecoBase.cxx.

  {
    _pulse.reset_param();

    _pulse_v.clear();

    _pulse_v.reserve(3);
  }

bool pmtana::PMTPulseRecoBase::Status

(

void

)

const

Status getter.

Definition at line 26 of file PMTPulseRecoBase.cxx.

  { return _status; }

Member Data Documentation

std::string pmtana::PMTPulseRecoBase::_name

private

Unique name.

Definition at line 102 of file PMTPulseRecoBase.h.

pulse_param pmtana::PMTPulseRecoBase::_pulse

protected

A subject pulse_param object to be filled with the last reconstructed pulse parameters.

Definition at line 122 of file PMTPulseRecoBase.h.

pulse_param_array pmtana::PMTPulseRecoBase::_pulse_v

protected

A container array of pulse_param struct objects to store (possibly multiple) reconstructed pulse(s).

Definition at line 119 of file PMTPulseRecoBase.h.

bool pmtana::PMTPulseRecoBase::_status

private

Status after pulse reconstruction.

Definition at line 110 of file PMTPulseRecoBase.h.

---

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

• larana/larana/OpticalDetector/OpHitFinder/PMTPulseRecoBase.h
• larana/larana/OpticalDetector/OpHitFinder/PMTPulseRecoBase.cxx