OpWaveform.h

Go to the documentation of this file.

#ifndef LARDATAOBJ_RECOBASE_OPWAVEFORM_H
#define LARDATAOBJ_RECOBASE_OPWAVEFORM_H

// LArSoft libraries
#include "larcoreobj/SimpleTypesAndConstants/RawTypes.h" // raw::ChannelID_t
#include "larcoreobj/SimpleTypesAndConstants/geo_types.h"
#include "lardataobj/Utilities/sparse_vector.h"

// C/C++ standard libraries
#include <cstddef> // std::size_t
#include <vector>

namespace recob {

  class OpWaveform {
  public:
    typedef lar::sparse_vector<float> RegionsOfInterest_t;

    OpWaveform();

  private:
    double fTimeStamp;              
    raw::ChannelID_t fChannel;      
    RegionsOfInterest_t fSignalROI; 

    //friend class OpWaveformCreator; // helper to create wires in art

  public:
    // --- BEGIN -- Constructors ---------------------------------------------
    OpWaveform(double time, raw::ChannelID_t channel, RegionsOfInterest_t const& sigROIlist);

    OpWaveform(double time, raw::ChannelID_t channel, RegionsOfInterest_t&& sigROIlist);
    // --- END -- Constructors -----------------------------------------------

    // --- BEGIN -- Accessors ------------------------------------------------

    std::vector<float> Signal() const;

    const RegionsOfInterest_t& SignalROI() const;

    std::size_t NSignal() const;

    raw::ChannelID_t Channel() const;

    double TimeStamp() const;

    // --- END -- Accessors --------------------------------------------------

    // --- BEGIN -- Sorting and comparison operations ------------------------

    bool operator<(const OpWaveform& than) const;

    // --- END -- Sorting and comparison operations --------------------------

  }; // class OpWaveform

} // namespace recob

//------------------------------------------------------------------------------
//--- inline implementation
//------------------------------------------------------------------------------
inline const recob::OpWaveform::RegionsOfInterest_t& recob::OpWaveform::SignalROI() const
{
  return fSignalROI;
}
inline std::size_t recob::OpWaveform::NSignal() const
{
  return fSignalROI.size();
}
inline raw::ChannelID_t recob::OpWaveform::Channel() const
{
  return fChannel;
}
inline double recob::OpWaveform::TimeStamp() const
{
  return fTimeStamp;
}
inline bool recob::OpWaveform::operator<(const OpWaveform& than) const
{
  return Channel() < than.Channel();
}

//------------------------------------------------------------------------------

#endif // LARDATAOBJ_RECOBASE_OPWAVEFORM_H