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"
#include "spec/core.hpp"
 
namespace AQNWB::NWB
{
class SpikeEventSeries : public ElectricalSeries
{
public:
  // Register the TimeSeries as a subclass of Container
  REGISTER_SUBCLASS(SpikeEventSeries,
                    ElectricalSeries,
                    AQNWB::SPEC::CORE::namespaceName)
 
protected:
  SpikeEventSeries(const std::string& path, std::shared_ptr<IO::BaseIO> io);
 
public:
  ~SpikeEventSeries();

  Status 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_DATASET_FIELD(readData, recordData, std::any, "data", Spike waveforms)
 
  DEFINE_ATTRIBUTE_FIELD(readDataUnit,
                        std::string,
                        "data/unit",
                        Unit of measurement for waveforms.
                        This is fixed to volts)
 
private:
  SizeType m_eventsRecorded;
};
}  // namespace AQNWB::NWB