ElectrodesTable.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"
#include "spec/core.hpp"
 
namespace AQNWB::NWB
{
class ElectrodesTable : public AQNWB::NWB::DynamicTable
{
public:
  // Register the ElectrodesTable as a subclass of Container
  REGISTER_SUBCLASS(ElectrodesTable,
                    DynamicTable,
                    AQNWB::SPEC::CORE::namespaceName)
 
protected:
  explicit ElectrodesTable(std::shared_ptr<IO::BaseIO> io);
 
  // required so we can call create
  ElectrodesTable(const std::string& path, std::shared_ptr<IO::BaseIO> io);
 
public:
  static std::shared_ptr<ElectrodesTable> create(std::shared_ptr<IO::BaseIO> io)
  {
    return RegisteredType::create<ElectrodesTable>(
        ElectrodesTable::electrodesTablePath, io);
  }

  ~ElectrodesTable() override;

  Status validateDataSpecs(
      const std::vector<DataSpecPtr>& dataSpecs) const override;

  static std::vector<DataSpecPtr> createDefaultDataSpecs(
      const SizeType rowChunkSize = 100);

  Status initialize(const std::string& description =
                        "metadata about extracellular electrodes",
                    const std::vector<DataSpecPtr>& columnSpecs = {});

  Status finalize() override;

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

  inline const static std::string electrodesTablePath =
      "/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";
};
 
}  // namespace AQNWB::NWB