TraceAlgorithm.h

Go to the documentation of this file.

#ifndef _utl_TraceAlgorithm_h_
#define _utl_TraceAlgorithm_h_

#include <utl/Trace-fwd.h>
#include <utl/AugerException.h>
#include <vector>


namespace utl {

  class InvalidTraceBoundException : public AugerException {
  public:
    InvalidTraceBoundException(const std::string& message = std::string())
      : AugerException(message) { }

    virtual std::string GetExceptionName() const
    { return "Invalid Trace Bound"; }
  };


  class TraceAlgorithm {
  public:
    template<typename T>
    static double Min(const Trace<T>& trace,
                      const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double Max(const Trace<T>& trace,
                      const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double Mean(const Trace<T>& trace,
                       const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double Median(const Trace<T>& trace,
                         const unsigned int bin1, const unsigned int bin2,
                         const unsigned int sortAlgorithmLimit = 40);


    template<typename T>
    static double ShapeParameter(const Trace<T>& trace,
                                 const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double RMS(const Trace<T>& trace,
                      const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double RootMeanSquare(const Trace<T>& trace,
                                 const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double StandardDeviation(const Trace<T>& trace,
                                 const unsigned int bin1, const unsigned int bin2);


    template<typename T>
    static double TimeAtRelativeSignalX(const Trace<T>& trace,
                                        const unsigned int bin1, const unsigned int bin2,
                                        const double percent);

    template<typename T>
    static double RiseTime(const Trace<T>& trace,
                           const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double FallTime(const Trace<T>& trace,
                           unsigned int bin1, unsigned int bin2);

    template<typename T>
    static double Sum(const Trace<T>& trace,
                      const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static double Centroid(const Trace<T>& trace,
                           const unsigned int bin1, const unsigned int bin2);

  private:
    template<typename T>
    static bool BoundsOk(const Trace<T>& trace,
                         const unsigned int bin1, const unsigned int bin2);

    template<typename T>
    static inline double Mean(const std::vector<T>& v);
  };


}


#endif