IWaveform.h

Go to the documentation of this file.

/** This is an interface to data about a waveform.  It is a contiguous
 * floating point sampling over a regular period and relative to some
 * start (eg, start time).
 */

#ifndef WIRECELL_IFACE_IWAVEFORM
#define WIRECELL_IFACE_IWAVEFORM

#include "WireCellIface/IData.h"

#include <vector>

namespace WireCell {

    class IWaveform : IData<IWaveform> {
    public:
        typedef std::vector<float> sequence_type;

        virtual ~IWaveform() ;
        // The starting point of the sampling
        virtual double waveform_start() const = 0;
        // The sampling period aka bin width
        virtual double waveform_period() const = 0;
        // The collection of samples 
        virtual const sequence_type& waveform_samples() const = 0;
        
    };
}

#endif