ElectrodeTable.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#include "io/BaseIO.hpp"
#include "nwb/hdmf/table/DynamicTable.hpp"
#include "nwb/hdmf/table/ElementIdentifiers.hpp"
#include "nwb/hdmf/table/VectorData.hpp"
 
namespace AQNWB::NWB
{
class ElectrodeTable : public DynamicTable
{
public:
  // Register the ElectrodeTable as a subclass of Container
  // REGISTER_SUBCLASS(ElectrodeTable, "core")
  REGISTER_SUBCLASS_WITH_TYPENAME(ElectrodeTable, "core", "DynamicTable")
 
  
  ElectrodeTable(std::shared_ptr<IO::BaseIO> io);
 
  // required so we can call create
  ElectrodeTable(const std::string& path, std::shared_ptr<IO::BaseIO> io);

  ~ElectrodeTable();

  void initialize(const std::string& description =
                      "metadata about extracellular electrodes");

  void finalize();

  void addElectrodes(std::vector<Channel> channelsInput);

  inline std::string getGroupPath() const
  {
    // all channels in ChannelVector should have the same groupName
    return m_groupReferences[0];
  }

  void setGroupPath(const std::string& groupPath);

  inline const static std::string electrodeTablePath =
      "/general/extracellular_ephys/electrodes";
 
private:
  std::vector<int> m_electrodeNumbers;

  std::vector<std::string> m_groupNames;

  std::vector<std::string> m_locationNames;

  std::vector<std::string> m_groupReferences;

  inline const static std::string m_groupPathBase =
      "/general/extracellular_ephys";

  std::unique_ptr<ElementIdentifiers> m_electrodeDataset;

  std::unique_ptr<VectorData> m_groupNamesDataset;

  std::unique_ptr<VectorData> m_locationsDataset;
};
}  // namespace AQNWB::NWB