#include "AlgoThreshold.h"

Inheritance diagram for pmtana::AlgoThreshold:

Public Member Functions
	AlgoThreshold (const std::string name="AlgoThreshold")
	Default constructor. More...

	AlgoThreshold (const fhicl::ParameterSet &pset, const std::string name="AlgoThreshold")
	Alternative constructor. More...

virtual	~AlgoThreshold ()
	Default destructor. More...

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

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

const 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 &wf, const pmtana::PedestalMean_t &mean_v, const pmtana::PedestalSigma_t &sigma_v)
	Implementation of AlgoThreshold::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
double	_start_adc_thres
	A variable holder for a user-defined absolute ADC threshold value. More...

double	_end_adc_thres

double	_nsigma_start
	A variable holder for a multiplicative factor for the pedestal standard deviation to define the threshold. More...

double	_nsigma_end

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 threshold algorithm to AlgoThreshold 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 33 of file AlgoThreshold.h.

Constructor & Destructor Documentation

pmtana::AlgoThreshold::AlgoThreshold ( const std::string name = "AlgoThreshold" )

Default constructor.

Definition at line 15 of file AlgoThreshold.cxx.

References Reset().

                                                    : PMTPulseRecoBase(name)
   //***************************************************************************
   {
     //_adc_thres = 3;
     //_nsigma = 5;
     Reset();
   }

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

Alternative constructor.

Definition at line 24 of file AlgoThreshold.cxx.

References _end_adc_thres, _nsigma_end, _nsigma_start, _start_adc_thres, fhicl::ParameterSet::get(), and Reset().

     : PMTPulseRecoBase(name)
   //*******************************************************
   {
 
     _start_adc_thres = pset.get<double>("StartADCThreshold");
     _end_adc_thres = pset.get<double>("EndADCThreshold");
   
     //_nsigma = pset.get<double>("NSigmaThreshold");
     
     _nsigma_start = pset.get<double>("NSigmaThresholdStart");
     _nsigma_end   = pset.get<double>("NSigmaThresholdEnd");
 
     Reset();
 
   }

pmtana::AlgoThreshold::~AlgoThreshold ( )

virtual

Default destructor.

Definition at line 44 of file AlgoThreshold.cxx.

46 {}

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

References evd::details::begin(), pmtana::CheckIndex(), and evd::details::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 106 of file PMTPulseRecoBase.h.

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

106 {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:123

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 73 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 92 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 99 of file PMTPulseRecoBase.cxx.

References evd::details::begin(), pmtana::CheckIndex(), and evd::details::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 146 of file PMTPulseRecoBase.cxx.

References evd::details::begin(), pmtana::CheckIndex(), and evd::details::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 170 of file PMTPulseRecoBase.cxx.

References evd::details::begin(), pmtana::CheckIndex(), and evd::details::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 21 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_name.

23 { return _name; }

pmtana::PMTPulseRecoBase::_name

std::string _name

Unique name.

Definition: PMTPulseRecoBase.h:106

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::AlgoThreshold::RecoPulse	(	const pmtana::Waveform_t &	wf,
		const pmtana::PedestalMean_t &	mean_v,
		const pmtana::PedestalSigma_t &	sigma_v
	)

protectedvirtual

Implementation of AlgoThreshold::reco() method.

Implements pmtana::PMTPulseRecoBase.

Definition at line 56 of file AlgoThreshold.cxx.

References _end_adc_thres, _nsigma_end, _nsigma_start, pmtana::PMTPulseRecoBase::_pulse, pmtana::PMTPulseRecoBase::_pulse_v, _start_adc_thres, pmtana::pulse_param::area, pmtana::pulse_param::peak, pmtana::pulse_param::ped_mean, pmtana::pulse_param::ped_sigma, Reset(), pmtana::pulse_param::reset_param(), pmtana::pulse_param::t_end, pmtana::pulse_param::t_max, pmtana::pulse_param::t_start, and fhicl::detail::atom::value().

   {
     bool fire = false;
     
     double counter=0;
 
     double ped_mean = mean_v.front();
     double ped_rms  = sigma_v.front();
 
     //double threshold = ( _adc_thres > (_nsigma * ped_rms) ? _adc_thres : (_nsigma * ped_rms) );
     auto start_threshold = ( _start_adc_thres > (_nsigma_start * ped_rms) ? _start_adc_thres : (_nsigma_start * ped_rms) );
     auto end_threshold   = ( _end_adc_thres   > (_nsigma_end   * ped_rms) ? _end_adc_thres   : (_nsigma_end * ped_rms) );
     
     //    threshold += ped_mean
 
     start_threshold += ped_mean;
     end_threshold   += ped_mean;
 
     Reset();
 
     for(auto const &value : wf){
       
       if( !fire && ((double)value) >= start_threshold ){
 
         // Found a new pulse
 
         fire = true;
 
         _pulse.ped_mean  = ped_mean;
         _pulse.ped_sigma = ped_rms;
 
         //vic: i move t_start back one, this helps with porch
 
         _pulse.t_start = counter - 1 > 0 ? counter - 1 : counter;
         //std::cout << "counter: " << counter << " tstart : " << _pulse.t_start << "\n";
         
       }
       
       if( fire && ((double)value) < end_threshold ){
         
         // Found the end of a pulse
         
         fire = false;
 
         //vic: i move t_start forward one, this helps with tail
         _pulse.t_end = counter < wf.size()  ? counter : counter - 1;
         
         _pulse_v.push_back(_pulse);
 
         _pulse.reset_param();
 
       }
 
       //std::cout << "\tFire=" << fire << std::endl;
 
       if(fire){
 
         // Add this adc count to the integral
         
         _pulse.area += ((double)value - (double)ped_mean);
 
         if(_pulse.peak < ((double)value - (double)ped_mean)) {
 
           // Found a new maximum
           
           _pulse.peak = ((double)value - (double)ped_mean);
 
           _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;
     
       _pulse_v.push_back(_pulse);
     
       _pulse.reset_param();
 
     }
 
     return true;
 
   }

void pmtana::AlgoThreshold::Reset ( )

virtual

Implementation of AlgoThreshold::reset() method.

Reimplemented from pmtana::PMTPulseRecoBase.

Definition at line 49 of file AlgoThreshold.cxx.

References pmtana::PMTPulseRecoBase::Reset().

Referenced by AlgoThreshold(), and RecoPulse().

   {
     PMTPulseRecoBase::Reset();
   }

const bool pmtana::PMTPulseRecoBase::Status ( ) const

inherited

Status getter.

Definition at line 26 of file PMTPulseRecoBase.cxx.

References pmtana::PMTPulseRecoBase::_status.

28 { return _status; }

pmtana::PMTPulseRecoBase::_status

bool _status

Status after pulse reconstruction.

Definition: PMTPulseRecoBase.h:114

Member Data Documentation

double pmtana::AlgoThreshold::_end_adc_thres

protected

Definition at line 60 of file AlgoThreshold.h.

Referenced by AlgoThreshold(), and RecoPulse().

double pmtana::AlgoThreshold::_nsigma_end

protected

Definition at line 65 of file AlgoThreshold.h.

Referenced by AlgoThreshold(), and RecoPulse().

double pmtana::AlgoThreshold::_nsigma_start

protected

A variable holder for a multiplicative factor for the pedestal standard deviation to define the threshold.

Definition at line 64 of file AlgoThreshold.h.

Referenced by AlgoThreshold(), 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 126 of file PMTPulseRecoBase.h.

Referenced by pmtana::AlgoSiPM::RecoPulse(), pmtana::AlgoSlidingWindow::RecoPulse(), pmtana::AlgoCFD::RecoPulse(), 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 123 of file PMTPulseRecoBase.h.

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

double pmtana::AlgoThreshold::_start_adc_thres

protected

A variable holder for a user-defined absolute ADC threshold value.

Definition at line 59 of file AlgoThreshold.h.

Referenced by AlgoThreshold(), and RecoPulse().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation