#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, const std::string name="FixedWindow")
	Alternative ctor. More...

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

Public Member Functions inherited from pmtana::PMTPulseRecoBase
	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...

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

Protected Member Functions inherited from pmtana::PMTPulseRecoBase
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...

Protected Attributes inherited from pmtana::PMTPulseRecoBase
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...

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

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

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

Alternative ctor.

Definition at line 25 of file AlgoFixedWindow.cxx.

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

Member Function Documentation

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 51 of file AlgoFixedWindow.cxx.

   {
     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();
 
     return true;
 
   }

void pmtana::AlgoFixedWindow::Reset ( void )

virtual

Implementation of AlgoFixedWindow::reset() method.

Reimplemented from pmtana::PMTPulseRecoBase.

Definition at line 39 of file AlgoFixedWindow.cxx.

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

Member Data Documentation

size_t pmtana::AlgoFixedWindow::_index_end

protected

index marker for the end of pulse time window

Definition at line 57 of file AlgoFixedWindow.h.

size_t pmtana::AlgoFixedWindow::_index_start

protected

index marker for the beginning of the pulse time window

Definition at line 56 of file AlgoFixedWindow.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation