pmtana::AlgoFixedWindow Class Reference

#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...
virtual	~AlgoFixedWindow ()
	Default destructor. More...
void	Reset ()
	Implementation of AlgoFixedWindow::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 &, 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...

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 33 of file AlgoFixedWindow.h.

Constructor & Destructor Documentation

pmtana::AlgoFixedWindow::AlgoFixedWindow

(

const std::string

name = "FixedWindow"

)

Default ctor.

Definition at line 15 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,
		const std::string	name = "FixedWindow"
	)

Alternative ctor.

Definition at line 26 of file AlgoFixedWindow.cxx.

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

    : PMTPulseRecoBase(name)
  //****************************************************************************************
  {
    Reset();

    _index_start = pset.get<size_t>("StartIndex");

    _index_end = pset.get<size_t>("EndIndex");
  }

pmtana::AlgoFixedWindow::~AlgoFixedWindow ( )

virtual

Default destructor.

Definition at line 40 of file AlgoFixedWindow.cxx.

  {}

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

{return _pulse_v.size();};

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

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

References _index_end, _index_start, pmtana::PMTPulseRecoBase::_pulse_v, pmtana::PMTPulseRecoBase::Integral(), pmtana::PMTPulseRecoBase::Max(), and Reset().

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

virtual

Implementation of AlgoFixedWindow::reset() method.

Reimplemented from pmtana::PMTPulseRecoBase.

Definition at line 45 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();

  }

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

inherited

Status getter.

Definition at line 26 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 58 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 57 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 126 of file PMTPulseRecoBase.h.

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

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

---

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

• larana/v06_21_01/source/larana/OpticalDetector/OpHitFinder/AlgoFixedWindow.h
• larana/v06_21_01/source/larana/OpticalDetector/OpHitFinder/AlgoFixedWindow.cxx