NWBFile.hpp

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <cstdint>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include "BaseIO.hpp"
#include "Types.hpp"
#include "nwb/RecordingContainers.hpp"
#include "nwb/base/TimeSeries.hpp"
#include "nwb/file/ElectrodeTable.hpp"
#include "nwb/hdmf/base/Container.hpp"
 
namespace AQNWB::NWB
{
 
class NWBFile : public Container
{
public:
  NWBFile(const std::string& idText, std::shared_ptr<BaseIO> io);
 
  NWBFile(const NWBFile&) = delete;
 
  NWBFile& operator=(const NWBFile&) = delete;
 
  ~NWBFile();
 
  Status initialize(const std::string description = "a recording session",
                    const std::string dataCollection = "");
 
  Status finalize();
 
  Status createElectricalSeries(
      std::vector<Types::ChannelVector> recordingArrays,
      std::vector<std::string> recordingNames,
      const BaseDataType& dataType = BaseDataType::I16,
      RecordingContainers* recordingContainers = nullptr,
      std::vector<SizeType>& containerIndexes = emptyContainerIndexes);
 
  Status createSpikeEventSeries(
      std::vector<Types::ChannelVector> recordingArrays,
      std::vector<std::string> recordingNames,
      const BaseDataType& dataType = BaseDataType::I16,
      RecordingContainers* recordingContainers = nullptr,
      std::vector<SizeType>& containerIndexes = emptyContainerIndexes);
 
protected:
  Status createFileStructure(std::string description,
                             std::string dataCollection);
 
private:
  std::unique_ptr<BaseRecordingData> createRecordingData(
      BaseDataType type,
      const SizeArray& size,
      const SizeArray& chunking,
      const std::string& path);
 
  template<SizeType N>
  void cacheSpecifications(
      const std::string& specPath,
      const std::string& versionNumber,
      const std::array<std::pair<std::string_view, std::string_view>, N>&
          specVariables);
 
  inline const static std::string acquisitionPath = "/acquisition";
  static std::vector<SizeType> emptyContainerIndexes;
 
private:
  std::unique_ptr<ElectrodeTable> m_electrodeTable;
  const std::string m_identifierText;
};
 
}  // namespace AQNWB::NWB