SpikeEventSeries.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#include "Channel.hpp"
#include "Utils.hpp"
#include "io/BaseIO.hpp"
#include "io/ReadIO.hpp"
#include "nwb/ecephys/ElectricalSeries.hpp"
 
namespace AQNWB::NWB
{
class SpikeEventSeries : public ElectricalSeries
{
public:
  // Register the TimeSeries as a subclass of Container
  REGISTER_SUBCLASS(SpikeEventSeries, "core")
 
  
  SpikeEventSeries(const std::string& path, std::shared_ptr<IO::BaseIO> io);

  ~SpikeEventSeries();

  void initialize(const IO::ArrayDataSetConfig& dataConfig,
                  const Types::ChannelVector& channelVector,
                  const std::string& description,
                  const float& conversion = 1.0f,
                  const float& resolution = -1.0f,
                  const float& offset = 0.0f);

  Status writeSpike(const SizeType& numSamples,
                    const SizeType& numChannels,
                    const void* dataInput,
                    const void* timestampsInput,
                    const void* controlInput = nullptr);
 
  DEFINE_FIELD(readData, DatasetField, std::any, "data", Spike waveforms)
 
  DEFINE_FIELD(readDataUnit,
               AttributeField,
               std::string,
               "data/unit",
               Unit of measurement for waveforms.
               This is fixed to volts)
 
private:
  SizeType m_eventsRecorded;
};
}  // namespace AQNWB::NWB