#include "AlgoSiPM.h"

Inheritance diagram for pmtana::AlgoSiPM:

Public Member Functions
	AlgoSiPM (const fhicl::ParameterSet &pset, std::unique_ptr< pmtana::RiseTimeCalculatorBase > risetimecalculator=nullptr, const std::string name="AlgoSiPM")

void	Reset ()
	A method to be called event-wise to reset parameters. 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 &)

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
double	_adc_thres

int	_min_width

double	_2nd_thres

double	_pedestal

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

Definition at line 24 of file AlgoSiPM.h.

Constructor & Destructor Documentation

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

Definition at line 12 of file AlgoSiPM.cxx.

References _2nd_thres, _adc_thres, _min_width, _pedestal, pmtana::PMTPulseRecoBase::_risetime_calc_ptr, fhicl::ParameterSet::get(), and Reset().

     : PMTPulseRecoBase(name)
   {
 
     _adc_thres = pset.get<float>("ADCThreshold");
     _min_width = pset.get<float>("MinWidth");
     _2nd_thres = pset.get<float>("SecondThreshold");
     _pedestal = pset.get<float>("Pedestal");
 
     _risetime_calc_ptr = std::move(risetimecalculator);
 
     //    _nsigma = 5;
 
     Reset();
   }

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 pmtana::AlgoFixedWindow::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 pmtana::AlgoFixedWindow::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::AlgoSiPM::RecoPulse	(	const pmtana::Waveform_t &	wf,
		const pmtana::PedestalMean_t &	ped_mean,
		const pmtana::PedestalSigma_t &	ped_rms
	)

protectedvirtual

Implements pmtana::PMTPulseRecoBase.

Definition at line 37 of file AlgoSiPM.cxx.

References _2nd_thres, _adc_thres, _min_width, pmtana::PMTPulseRecoBase::_pulse, pmtana::PMTPulseRecoBase::_pulse_v, pmtana::PMTPulseRecoBase::_risetime_calc_ptr, pmtana::pulse_param::area, util::counter(), pmtana::pulse_param::peak, Reset(), pmtana::pulse_param::reset_param(), pmtana::pulse_param::t_end, pmtana::pulse_param::t_max, pmtana::pulse_param::t_rise, pmtana::pulse_param::t_start, and value.

   {
 
     bool fire = false;
     bool record_hit = false;
     int counter = 0;
     //    double threshold   = (_2nd_thres > (_nsigma*_ped_rms) ? _2nd_thres
     //                                                    : (_nsigma*_ped_rms));
     //double pedestal      = _pedestal;
     double pedestal =
       ped_mean
         .front(); //Switch pedestal definition to incoroprate pedestal finder - K.S. 04/18/2019
 
     double threshold = _adc_thres;
     threshold += pedestal;
     double pre_threshold = _2nd_thres;
     pre_threshold += pedestal;
 
     Reset();
 
     for (short const& value : wf) {
 
       if (!fire && (double(value) >= pre_threshold)) {
 
         // Found a new pulse
         fire = true;
         record_hit = false;
         _pulse.t_start = counter;
       }
 
       if (fire && (double(value) < pre_threshold)) {
 
         // Found the end of a pulse
         fire = false;
         _pulse.t_end = counter - 1;
         if (record_hit && ((_pulse.t_end - _pulse.t_start) >= _min_width)) {
           if (_risetime_calc_ptr)
             _pulse.t_rise = _risetime_calc_ptr->RiseTime(
               {wf.begin() + _pulse.t_start, wf.begin() + _pulse.t_end},
               {ped_mean.begin() + _pulse.t_start, ped_mean.begin() + _pulse.t_end},
               true);
 
           _pulse_v.push_back(_pulse);
           record_hit = false;
         }
         _pulse.reset_param();
       }
 
       if (fire) {
 
         // We want to record the hit only if _adc_thres is reached
         if (!record_hit && (double(value) >= threshold)) record_hit = true;
 
         // Add this ADC count to the integral
         _pulse.area += (double(value) - double(pedestal));
 
         if (_pulse.peak < (double(value) - double(pedestal))) {
 
           // Found a new maximum
           _pulse.peak = (double(value) - double(pedestal));
           _pulse.t_max = counter;
         }
       }
 
       counter++;
     }
 
     if (fire) {
 
       // Take care of a pulse that did not finish within the readout window
       fire = false;
       _pulse.t_end = counter - 1;
       if (record_hit && ((_pulse.t_end - _pulse.t_start) >= _min_width)) {
         if (_risetime_calc_ptr)
           _pulse.t_rise = _risetime_calc_ptr->RiseTime(
             {wf.begin() + _pulse.t_start, wf.begin() + _pulse.t_end},
             {ped_mean.begin() + _pulse.t_start, ped_mean.begin() + _pulse.t_end},
             true);
 
         _pulse_v.push_back(_pulse);
         record_hit = false;
       }
       _pulse.reset_param();
     }
 
     return true;
   }

void pmtana::AlgoSiPM::Reset ( )

virtual

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

Reimplemented from pmtana::PMTPulseRecoBase.

Definition at line 31 of file AlgoSiPM.cxx.

References pmtana::PMTPulseRecoBase::Reset().

Referenced by AlgoSiPM(), and RecoPulse().

   {
     PMTPulseRecoBase::Reset();
   }

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

double pmtana::AlgoSiPM::_2nd_thres

protected

Definition at line 53 of file AlgoSiPM.h.

Referenced by AlgoSiPM(), and RecoPulse().

double pmtana::AlgoSiPM::_adc_thres

protected

Definition at line 47 of file AlgoSiPM.h.

Referenced by AlgoSiPM(), and RecoPulse().

int pmtana::AlgoSiPM::_min_width

protected

Definition at line 50 of file AlgoSiPM.h.

Referenced by AlgoSiPM(), and RecoPulse().

double pmtana::AlgoSiPM::_pedestal

protected

Definition at line 56 of file AlgoSiPM.h.

Referenced by AlgoSiPM().

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 RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), pmtana::AlgoThreshold::RecoPulse(), pmtana::AlgoFixedWindow::RecoPulse(), pmtana::AlgoFixedWindow::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(), RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), pmtana::AlgoThreshold::RecoPulse(), pmtana::AlgoFixedWindow::RecoPulse(), pmtana::AlgoFixedWindow::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(), pmtana::AlgoFixedWindow::AlgoFixedWindow(), AlgoSiPM(), pmtana::AlgoSlidingWindow::AlgoSlidingWindow(), pmtana::AlgoThreshold::AlgoThreshold(), RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoThreshold::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), and pmtana::AlgoFixedWindow::RecoPulse().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation