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();

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

  Status finalize();

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

  inline const static std::string electrodeTablePath =
      "/general/extracellular_ephys/electrodes";
 
  DEFINE_REGISTERED_FIELD(
      readLocationColumn,
      VectorDataTyped<std::string>,
      "location",
      "the location of channel within the subject e.g. brain region")
 
  DEFINE_REGISTERED_FIELD(
      readGroupNameColumn,
      VectorDataTyped<std::string>,
      "group_name",
      "the name of the ElectrodeGroup this electrode is a part of")
 
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