PMTPulseRecoBase.h

Go to the documentation of this file.

/**
 * \file PMTPulseRecoBase.h
 *
 * \ingroup PulseReco
 *
 * \brief Class definition file of PMTPulseRecoBase
 *
 * @author Kazu - Nevis 2013
 */

/** \addtogroup PulseReco

@{*/

#ifndef PMTPULSERECOBASE_H
#define PMTPULSERECOBASE_H

// STL
#include <string>
#include <vector>

#include "OpticalRecoTypes.h"

namespace pmtana
{

  struct pulse_param{
  public:
    double peak, area, ped_mean, ped_sigma;
    double t_start, t_max, t_end;

    //for vic
    double t_cfdcross;

    pulse_param(){
      reset_param();
    }

    void reset_param(){
      area = 0;
      peak = -1;
      ped_mean = ped_sigma = -1;
      t_start = t_max = t_end = -1;
      t_cfdcross = -1;
    }

  };

  typedef std::vector<pmtana::pulse_param> pulse_param_array;

  /**
   \class PMTPulseRecoBase
   The base class of pulse reconstruction algorithms. All algorithms should inherit from this calss
   to be executed by a manager class, pulse_reco. Note that this class does not depend on the rest
   of the framework except for the use of constants. In order to reconstruct a pulse, all it requires
   is a std::vector<short> type object (i.e. raw waveform), waveform pedestal, and its standard
   deviation. All of these are to be provided by an executer. Reconstructed pulse parameters are
   stored in the pulse_param struct object.

   All methods specified as "virtual" should be implemented by the inherit children class.

   This class provides some basic std::vector calculation algorithms such as integral, derivative,
   max and min algorithms. Inherit children classes are encouraged to use these provided methods
   when possible.
  */
  class PMTPulseRecoBase {

  public:

    /// Default constructor with fhicl parameters
    PMTPulseRecoBase(const std::string name="noname");

    /// Default destructor
    virtual ~PMTPulseRecoBase() = default;

    /// Name getter
    const std::string& Name() const;

    /// Status getter
    bool Status() const;

    /// A method to be called event-wise to reset parameters
    virtual void Reset();

    /** A core method: this executes the algorithm and stores reconstructed parameters
      in the pulse_param struct object.
    */
    bool Reconstruct( const pmtana::Waveform_t&,
                      const pmtana::PedestalMean_t&,
                      const pmtana::PedestalSigma_t& );

    /** 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.
    */
    const pulse_param& GetPulse(size_t index=0) const;

    /// A getter for the whole array of pulse_param struct object.
    const pulse_param_array& GetPulses() const;

    /// A getter for the number of reconstructed pulses from the input waveform
    size_t GetNPulse() const {return _pulse_v.size();};

  private:

    /// Unique name
    std::string _name;

    /// Status after pulse reconstruction
    bool _status;

  protected:

    virtual bool RecoPulse( const pmtana::Waveform_t&,
                            const pmtana::PedestalMean_t&,
                            const pmtana::PedestalSigma_t&     ) = 0;

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

    /// A subject pulse_param object to be filled with the last reconstructed pulse parameters
    pulse_param _pulse;

  protected:

    /**
     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.
    */
    bool Integral   (const std::vector<short> &wf, double &result, size_t begin=0, size_t end=0) const;

    /**
     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.
    */
    bool Derivative (const std::vector<short> &wf, std::vector<int32_t> &diff, size_t begin=0, size_t end=0) const;

    /**
     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.
    */
    size_t Max(const std::vector<short> &wf, double &result, size_t begin=0, size_t end=0) const;

    /**
     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.
    */
    size_t Min(const std::vector<short> &wf, double &result, size_t begin=0, size_t end=0) const;

  };

}
#endif

/** @} */ // end of doxygen group