#include "AlgoFixedWindow.h"

Inheritance diagram for pmtana::AlgoFixedWindow:

Public Member Functions
	AlgoFixedWindow (const std::string name="FixedWindow")
	Default ctor. More...

	AlgoFixedWindow (const fhicl::ParameterSet &pset, std::unique_ptr< pmtana::RiseTimeCalculatorBase > risetimecalculator=nullptr, const std::string name="FixedWindow")
	Alternative ctor. More...

void	Reset ()
	Implementation of AlgoFixedWindow::reset() method. More...

const std::string &	Name () const
	Name getter. More...

bool	Status () const
	Status getter. 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
bool	RecoPulse (const pmtana::Waveform_t &, const pmtana::PedestalMean_t &, const pmtana::PedestalSigma_t &)
	Implementation of AlgoFixedWindow::reco() method. More...

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
size_t	_index_start
	index marker for the beginning of the pulse time window More...

size_t	_index_end
	index marker for the end of pulse time window More...

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

std::unique_ptr< pmtana::RiseTimeCalculatorBase >	_risetime_calc_ptr = nullptr
	Tool for rise time calculation. More...

Detailed Description

This class implements fixed_window algorithm to AlgoFixedWindow class. The algorithm defines a pulse in user-specified time window. A typical usage is to set the beginning of the window to be 0 (= start of the waveform) and integrate over the time of interest. By default, the ending is set to index=0, in which case it uses the ending index of the input waveform (i.e. full integration).

Definition at line 38 of file AlgoFixedWindow.h.

Constructor & Destructor Documentation

pmtana::AlgoFixedWindow::AlgoFixedWindow ( const std::string name = "FixedWindow" )

Default ctor.

Definition at line 14 of file AlgoFixedWindow.cxx.

References _index_end, _index_start, and Reset().

                                                        : PMTPulseRecoBase(name)
   //*******************************************************************************
   {
     Reset();
 
     _index_start = 0;
 
     _index_end = 0;
   }

pmtana::AlgoFixedWindow::AlgoFixedWindow	(	const fhicl::ParameterSet &	pset,
		std::unique_ptr< pmtana::RiseTimeCalculatorBase >	risetimecalculator = `nullptr`,
		const std::string	name = `"FixedWindow"`
	)

Alternative ctor.

Definition at line 25 of file AlgoFixedWindow.cxx.

References _index_end, _index_start, pmtana::PMTPulseRecoBase::_risetime_calc_ptr, fhicl::ParameterSet::get(), and Reset().

     : PMTPulseRecoBase(name)
   //****************************************************************************************
   {
     _risetime_calc_ptr = std::move(risetimecalculator);
 
     Reset();
 
     _index_start = pset.get<size_t>("StartIndex");
 
     _index_end = pset.get<size_t>("EndIndex");
   }

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

protectedinherited

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 121 of file PMTPulseRecoBase.cxx.

References util::begin(), pmtana::CheckIndex(), and util::end().

   {
 
     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

inlineinherited

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

Definition at line 101 of file PMTPulseRecoBase.h.

Referenced by opdet::LEDCalibrationAna::analyze().

101 { return _pulse_v.size(); };

pmtana::PMTPulseRecoBase::_pulse_v

pulse_param_array _pulse_v

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

Definition: PMTPulseRecoBase.h:116

const pulse_param & pmtana::PMTPulseRecoBase::GetPulse ( size_t index = 0 ) const

inherited

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 74 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_pulse_v.

Referenced by opdet::LEDCalibrationAna::analyze().

   {
 
     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

inherited

A getter for the whole array of pulse_param struct object.

Definition at line 91 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_pulse_v.

Referenced by opdet::RunHitFinder().

   {
     return _pulse_v;
   }

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

protectedinherited

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 98 of file PMTPulseRecoBase.cxx.

References util::begin(), pmtana::CheckIndex(), and util::end().

Referenced by RecoPulse().

   {
 
     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

protectedinherited

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 144 of file PMTPulseRecoBase.cxx.

References util::begin(), pmtana::CheckIndex(), and util::end().

Referenced by RecoPulse().

   {
 
     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

protectedinherited

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 169 of file PMTPulseRecoBase.cxx.

References util::begin(), pmtana::CheckIndex(), and util::end().

   {
 
     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 ( ) const

inherited

Name getter.

Definition at line 22 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_name.

   {
     return _name;
   }

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

inherited

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

Definition at line 36 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_status, and pmtana::PMTPulseRecoBase::RecoPulse().

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

bool pmtana::AlgoFixedWindow::RecoPulse	(	const pmtana::Waveform_t &	wf,
		const pmtana::PedestalMean_t &	mean_v,
		const pmtana::PedestalSigma_t &	sigma_v
	)

protectedvirtual

Implementation of AlgoFixedWindow::reco() method.

Implements pmtana::PMTPulseRecoBase.

Definition at line 52 of file AlgoFixedWindow.cxx.

References _index_end, _index_start, pmtana::PMTPulseRecoBase::_pulse, pmtana::PMTPulseRecoBase::_pulse_v, pmtana::PMTPulseRecoBase::_risetime_calc_ptr, pmtana::PMTPulseRecoBase::Integral(), pmtana::PMTPulseRecoBase::Max(), Reset(), pmtana::pulse_param::t_end, and pmtana::pulse_param::t_start.

   {
     this->Reset();
 
     if (_index_start >= wf.size()) return true;
 
     _pulse_v[0].t_start = (double)(_index_start);
 
     _pulse_v[0].ped_mean = mean_v.front();
 
     _pulse_v[0].ped_sigma = sigma_v.front();
 
     if (!_index_end)
 
       _pulse_v[0].t_end = (double)(wf.size() - 1);
 
     else if (_index_end < wf.size())
 
       _pulse_v[0].t_end = (double)_index_end;
 
     else
 
       _pulse_v[0].t_end = wf.size() - 1;
 
     _pulse_v[0].t_max =
       PMTPulseRecoBase::Max(wf, _pulse_v[0].peak, _index_start, _pulse_v[0].t_end);
 
     _pulse_v[0].peak -= mean_v.front();
 
     PMTPulseRecoBase::Integral(wf, _pulse_v[0].area, _index_start, _pulse_v[0].t_end);
 
     _pulse_v[0].area =
       _pulse_v[0].area - (_pulse_v[0].t_end - _pulse_v[0].t_start + 1) * mean_v.front();
 
     if (_risetime_calc_ptr)
       _pulse_v[0].t_rise = _risetime_calc_ptr->RiseTime(
         {wf.begin() + _pulse.t_start, wf.begin() + _pulse.t_end},
         {mean_v.begin() + _pulse.t_start, mean_v.begin() + _pulse.t_end},
         true);
 
     return true;
   }

void pmtana::AlgoFixedWindow::Reset ( )

virtual

Implementation of AlgoFixedWindow::reset() method.

Reimplemented from pmtana::PMTPulseRecoBase.

Definition at line 43 of file AlgoFixedWindow.cxx.

References pmtana::PMTPulseRecoBase::_pulse, and pmtana::PMTPulseRecoBase::_pulse_v.

Referenced by AlgoFixedWindow(), and RecoPulse().

   {
     if (!(_pulse_v.size())) _pulse_v.push_back(_pulse);
 
     _pulse_v[0].reset_param();
   }

bool pmtana::PMTPulseRecoBase::Status ( ) const

inherited

Status getter.

Definition at line 29 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_status.

   {
     return _status;
   }

Member Data Documentation

size_t pmtana::AlgoFixedWindow::_index_end

protected

index marker for the end of pulse time window

Definition at line 60 of file AlgoFixedWindow.h.

Referenced by AlgoFixedWindow(), and RecoPulse().

size_t pmtana::AlgoFixedWindow::_index_start

protected

index marker for the beginning of the pulse time window

Definition at line 59 of file AlgoFixedWindow.h.

Referenced by AlgoFixedWindow(), and RecoPulse().

pulse_param pmtana::PMTPulseRecoBase::_pulse

protectedinherited

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

Definition at line 119 of file PMTPulseRecoBase.h.

Referenced by pmtana::AlgoSiPM::RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoThreshold::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), RecoPulse(), Reset(), and pmtana::PMTPulseRecoBase::Reset().

pulse_param_array pmtana::PMTPulseRecoBase::_pulse_v

protectedinherited

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

Definition at line 116 of file PMTPulseRecoBase.h.

Referenced by pmtana::PMTPulseRecoBase::GetPulse(), pmtana::PMTPulseRecoBase::GetPulses(), pmtana::AlgoSiPM::RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), pmtana::AlgoThreshold::RecoPulse(), RecoPulse(), Reset(), and pmtana::PMTPulseRecoBase::Reset().

std::unique_ptr<pmtana::RiseTimeCalculatorBase> pmtana::PMTPulseRecoBase::_risetime_calc_ptr = nullptr

protectedinherited

Tool for rise time calculation.

Definition at line 122 of file PMTPulseRecoBase.h.

Referenced by pmtana::AlgoCFD::AlgoCFD(), AlgoFixedWindow(), pmtana::AlgoSiPM::AlgoSiPM(), pmtana::AlgoSlidingWindow::AlgoSlidingWindow(), pmtana::AlgoThreshold::AlgoThreshold(), pmtana::AlgoSiPM::RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoThreshold::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), and RecoPulse().

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

larana/v09_15_05/source/larana/OpticalDetector/OpHitFinder/AlgoFixedWindow.h
larana/v09_15_05/source/larana/OpticalDetector/OpHitFinder/AlgoFixedWindow.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation