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

  Status initialize(const IO::BaseArrayDataSetConfig& 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 writeChannel(SizeType channelInd,
                      const SizeType& numSamples,
                      const void* dataInput,
                      const void* timestampsInput,
                      const void* controlInput = nullptr);

  Status writeAllChannels(const SizeType& numSamples,
                          const void* dataInput,
                          const void* timestampsInput = nullptr,
                          const void* controlInput = nullptr);

  bool channelsAtSameSampleOffset() const;

  Types::ChannelVector m_channelVector;
 
  DEFINE_DATASET_FIELD(readChannelConversion,
                       recordChannelConversion,
                       float,
                       "channel_conversion",
                       Channel - specific conversion factor)
 
  DEFINE_DATASET_FIELD(
      readData, recordData, float, "data", Recorded voltage data)
 
  DEFINE_ATTRIBUTE_FIELD(readDataUnit,
                        std::string,
                        "data/unit",
                        Base unit of measurement for working with the data. 
                        This value is fixed to volts)
 
  DEFINE_DATASET_FIELD(
      readElectrodes,
      recordElectrodes,
      int,
      "electrodes",
      The indices of the electrodes that generated this electrical series.)
 
  DEFINE_ATTRIBUTE_FIELD(readElectrodesDescription,
                         std::string,
                         "electrodes/description",
                         The electrodes that generated this electrical series.)
 
  DEFINE_REFERENCED_REGISTERED_FIELD(
      readElectrodesTable,
      ElectrodesTable,
      "electrodes/table",
      The electrodes table retrieved from the object referenced in the 
      `electrodes / table` attribute.)
 
private:
  SizeArray m_samplesRecorded;
};
}  // namespace AQNWB::NWB