From 30e5059f700b286137b4f672280ca172c0ca0f88 Mon Sep 17 00:00:00 2001 From: stephprince <40640337+stephprince@users.noreply.github.com> Date: Wed, 7 Aug 2024 21:03:21 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh=5Fpages=20from=20@=20Neurod?= =?UTF-8?q?ataWithoutBorders/aqnwb@e36766fe33c812aa84bd077d886d3afa14a9044?= =?UTF-8?q?2=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _base_i_o_8hpp_source.html | 161 ++++++------ _h_d_f5_i_o_8cpp.html | 1 + _h_d_f5_i_o_8cpp__incl.map | 64 ++--- _h_d_f5_i_o_8cpp__incl.md5 | 2 +- _h_d_f5_i_o_8cpp__incl.svg | 244 ++++++++++-------- _h_d_f5_i_o_8cpp__incl_org.svg | 244 ++++++++++-------- _h_d_f5_i_o_8hpp_source.html | 159 ++++++------ _n_w_b_file_8hpp_source.html | 141 +++++----- _n_w_b_recording_8hpp_source.html | 4 +- class_a_q_n_w_b_1_1_base_i_o-members.html | 57 ++-- class_a_q_n_w_b_1_1_base_i_o.html | 99 +++++++ class_a_q_n_w_b_1_1_base_i_o.js | 3 + ...w_b_1_1_h_d_f5_1_1_h_d_f5_i_o-members.html | 69 ++--- ...s_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.html | 115 ++++++++- class_a_q_n_w_b_1_1_h_d_f5_1_1_h_d_f5_i_o.js | 5 +- ..._w_b_1_1_n_w_b_1_1_n_w_b_file-members.html | 9 +- class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html | 60 +++-- class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.js | 5 +- doxygen_crawl.html | 13 +- functions_c.html | 1 + functions_f.html | 2 +- functions_func.html | 8 +- functions_i.html | 2 +- functions_s.html | 3 +- index.html | 2 +- navtreedata.js | 4 +- navtreeindex0.js | 192 +++++++------- navtreeindex1.js | 54 ++-- navtreeindex2.js | 14 + search/all_2.js | 71 ++--- search/all_5.js | 2 +- search/all_7.js | 2 +- search/all_8.js | 2 +- search/all_f.js | 9 +- search/functions_2.js | 39 +-- search/functions_5.js | 2 +- search/functions_7.js | 2 +- search/functions_8.js | 2 +- search/functions_c.js | 5 +- 39 files changed, 1101 insertions(+), 772 deletions(-) diff --git a/_base_i_o_8hpp_source.html b/_base_i_o_8hpp_source.html index 903d5288..52379be6 100644 --- a/_base_i_o_8hpp_source.html +++ b/_base_i_o_8hpp_source.html @@ -227,72 +227,78 @@
- - - - - - - - - - - - - + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + - -#include <vector>
#include "HDF5IO.hpp"
#include <H5Cpp.h>
#include <H5Fpublic.h>
#include "Utils.hpp"
BaseIO() | AQNWB::BaseIO | |
BaseIO(const BaseIO &)=delete | AQNWB::BaseIO | |
close()=0 | AQNWB::BaseIO | pure virtual |
createArrayDataSet(const BaseDataType &type, const SizeArray &size, const SizeArray &chunking, const std::string &path)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const BaseDataType &type, const void *data, const std::string &path, const std::string &name, const SizeType &size=1)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const std::string &data, const std::string &path, const std::string &name)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const std::vector< std::string > &data, const std::string &path, const std::string &name)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const std::vector< const char * > &data, const std::string &path, const std::string &name, const SizeType &maxSize)=0 | AQNWB::BaseIO | pure virtual |
createCommonNWBAttributes(const std::string &path, const std::string &objectNamespace, const std::string &neurodataType="", const std::string &description="") | AQNWB::BaseIO | |
createDataAttributes(const std::string &path, const float &conversion, const float &resolution, const std::string &unit) | AQNWB::BaseIO | |
createGroup(const std::string &path)=0 | AQNWB::BaseIO | pure virtual |
createGroupIfDoesNotExist(const std::string &path)=0 | AQNWB::BaseIO | protectedpure virtual |
createLink(const std::string &path, const std::string &reference)=0 | AQNWB::BaseIO | pure virtual |
createReferenceAttribute(const std::string &referencePath, const std::string &path, const std::string &name)=0 | AQNWB::BaseIO | pure virtual |
createReferenceDataSet(const std::string &path, const std::vector< std::string > &references)=0 | AQNWB::BaseIO | pure virtual |
createStringDataSet(const std::string &path, const std::string &value)=0 | AQNWB::BaseIO | pure virtual |
createStringDataSet(const std::string &path, const std::vector< std::string > &values)=0 | AQNWB::BaseIO | pure virtual |
createTimestampsAttributes(const std::string &path) | AQNWB::BaseIO | |
filename | AQNWB::BaseIO | |
getDataSet(const std::string &path)=0 | AQNWB::BaseIO | pure virtual |
getFileName()=0 | AQNWB::BaseIO | pure virtual |
isOpen() const | AQNWB::BaseIO | |
isReadyToOpen() const | AQNWB::BaseIO | |
open()=0 | AQNWB::BaseIO | pure virtual |
open(bool newfile)=0 | AQNWB::BaseIO | pure virtual |
opened | AQNWB::BaseIO | protected |
operator=(const BaseIO &)=delete | AQNWB::BaseIO | |
readyToOpen | AQNWB::BaseIO | protected |
~BaseIO() | AQNWB::BaseIO | virtual |
canModifyObjects() | AQNWB::BaseIO | virtual |
close()=0 | AQNWB::BaseIO | pure virtual |
createArrayDataSet(const BaseDataType &type, const SizeArray &size, const SizeArray &chunking, const std::string &path)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const BaseDataType &type, const void *data, const std::string &path, const std::string &name, const SizeType &size=1)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const std::string &data, const std::string &path, const std::string &name)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const std::vector< std::string > &data, const std::string &path, const std::string &name)=0 | AQNWB::BaseIO | pure virtual |
createAttribute(const std::vector< const char * > &data, const std::string &path, const std::string &name, const SizeType &maxSize)=0 | AQNWB::BaseIO | pure virtual |
createCommonNWBAttributes(const std::string &path, const std::string &objectNamespace, const std::string &neurodataType="", const std::string &description="") | AQNWB::BaseIO | |
createDataAttributes(const std::string &path, const float &conversion, const float &resolution, const std::string &unit) | AQNWB::BaseIO | |
createGroup(const std::string &path)=0 | AQNWB::BaseIO | pure virtual |
createGroupIfDoesNotExist(const std::string &path)=0 | AQNWB::BaseIO | protectedpure virtual |
createLink(const std::string &path, const std::string &reference)=0 | AQNWB::BaseIO | pure virtual |
createReferenceAttribute(const std::string &referencePath, const std::string &path, const std::string &name)=0 | AQNWB::BaseIO | pure virtual |
createReferenceDataSet(const std::string &path, const std::vector< std::string > &references)=0 | AQNWB::BaseIO | pure virtual |
createStringDataSet(const std::string &path, const std::string &value)=0 | AQNWB::BaseIO | pure virtual |
createStringDataSet(const std::string &path, const std::vector< std::string > &values)=0 | AQNWB::BaseIO | pure virtual |
createTimestampsAttributes(const std::string &path) | AQNWB::BaseIO | |
filename | AQNWB::BaseIO | |
getDataSet(const std::string &path)=0 | AQNWB::BaseIO | pure virtual |
getFileName()=0 | AQNWB::BaseIO | pure virtual |
isOpen() const | AQNWB::BaseIO | |
isReadyToOpen() const | AQNWB::BaseIO | |
open()=0 | AQNWB::BaseIO | pure virtual |
open(bool newfile)=0 | AQNWB::BaseIO | pure virtual |
opened | AQNWB::BaseIO | protected |
operator=(const BaseIO &)=delete | AQNWB::BaseIO | |
readyToOpen | AQNWB::BaseIO | protected |
startRecording()=0 | AQNWB::BaseIO | pure virtual |
stopRecording()=0 | AQNWB::BaseIO | pure virtual |
~BaseIO() | AQNWB::BaseIO | virtual |
+
|
+ +virtual | +
Returns true if the file is in a mode where objects can be added or deleted. Note, this does not apply to the modification of raw data on already existing objects. Derived classes should override this function to check if objects can be modified.
+Reimplemented in AQNWB::HDF5::HDF5IO.
+ +
+
|
+ +pure virtual | +
Starts the recording process.
+Implemented in AQNWB::HDF5::HDF5IO.
+ +
+
|
+ +pure virtual | +
Stops the recording process.
+Implemented in AQNWB::HDF5::HDF5IO.
+BaseIO() | AQNWB::BaseIO | |
BaseIO(const BaseIO &)=delete | AQNWB::BaseIO | |
close() override | AQNWB::HDF5::HDF5IO | virtual |
createArrayDataSet(const BaseDataType &type, const SizeArray &size, const SizeArray &chunking, const std::string &path) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const BaseDataType &type, const void *data, const std::string &path, const std::string &name, const SizeType &size=1) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const std::string &data, const std::string &path, const std::string &name) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const std::vector< std::string > &data, const std::string &path, const std::string &name) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const std::vector< const char * > &data, const std::string &path, const std::string &name, const SizeType &maxSize) override | AQNWB::HDF5::HDF5IO | virtual |
createCommonNWBAttributes(const std::string &path, const std::string &objectNamespace, const std::string &neurodataType="", const std::string &description="") | AQNWB::BaseIO | |
createDataAttributes(const std::string &path, const float &conversion, const float &resolution, const std::string &unit) | AQNWB::BaseIO | |
createGroup(const std::string &path) override | AQNWB::HDF5::HDF5IO | virtual |
createGroupIfDoesNotExist(const std::string &path) override | AQNWB::HDF5::HDF5IO | protectedvirtual |
createLink(const std::string &path, const std::string &reference) override | AQNWB::HDF5::HDF5IO | virtual |
createReferenceAttribute(const std::string &referencePath, const std::string &path, const std::string &name) override | AQNWB::HDF5::HDF5IO | virtual |
createReferenceDataSet(const std::string &path, const std::vector< std::string > &references) override | AQNWB::HDF5::HDF5IO | virtual |
createStringDataSet(const std::string &path, const std::string &value) override | AQNWB::HDF5::HDF5IO | virtual |
createStringDataSet(const std::string &path, const std::vector< std::string > &values) override | AQNWB::HDF5::HDF5IO | virtual |
createTimestampsAttributes(const std::string &path) | AQNWB::BaseIO | |
filename | AQNWB::HDF5::HDF5IO | protected |
getDataSet(const std::string &path) override | AQNWB::HDF5::HDF5IO | virtual |
getFileName() override | AQNWB::HDF5::HDF5IO | virtual |
getH5Type(BaseDataType type) | AQNWB::HDF5::HDF5IO | static |
getNativeType(BaseDataType type) | AQNWB::HDF5::HDF5IO | static |
getObjectType(const std::string &path) | AQNWB::HDF5::HDF5IO | |
HDF5IO() | AQNWB::HDF5::HDF5IO | |
HDF5IO(const std::string &fileName) | AQNWB::HDF5::HDF5IO | |
isOpen() const | AQNWB::BaseIO | |
isReadyToOpen() const | AQNWB::BaseIO | |
open() override | AQNWB::HDF5::HDF5IO | virtual |
open(bool newfile) override | AQNWB::HDF5::HDF5IO | virtual |
opened | AQNWB::BaseIO | protected |
operator=(const BaseIO &)=delete | AQNWB::BaseIO | |
readyToOpen | AQNWB::BaseIO | protected |
~BaseIO() | AQNWB::BaseIO | virtual |
~HDF5IO() | AQNWB::HDF5::HDF5IO | |
canModifyObjects() override | AQNWB::HDF5::HDF5IO | virtual |
close() override | AQNWB::HDF5::HDF5IO | virtual |
createArrayDataSet(const BaseDataType &type, const SizeArray &size, const SizeArray &chunking, const std::string &path) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const BaseDataType &type, const void *data, const std::string &path, const std::string &name, const SizeType &size=1) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const std::string &data, const std::string &path, const std::string &name) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const std::vector< std::string > &data, const std::string &path, const std::string &name) override | AQNWB::HDF5::HDF5IO | virtual |
createAttribute(const std::vector< const char * > &data, const std::string &path, const std::string &name, const SizeType &maxSize) override | AQNWB::HDF5::HDF5IO | virtual |
createCommonNWBAttributes(const std::string &path, const std::string &objectNamespace, const std::string &neurodataType="", const std::string &description="") | AQNWB::BaseIO | |
createDataAttributes(const std::string &path, const float &conversion, const float &resolution, const std::string &unit) | AQNWB::BaseIO | |
createGroup(const std::string &path) override | AQNWB::HDF5::HDF5IO | virtual |
createGroupIfDoesNotExist(const std::string &path) override | AQNWB::HDF5::HDF5IO | protectedvirtual |
createLink(const std::string &path, const std::string &reference) override | AQNWB::HDF5::HDF5IO | virtual |
createReferenceAttribute(const std::string &referencePath, const std::string &path, const std::string &name) override | AQNWB::HDF5::HDF5IO | virtual |
createReferenceDataSet(const std::string &path, const std::vector< std::string > &references) override | AQNWB::HDF5::HDF5IO | virtual |
createStringDataSet(const std::string &path, const std::string &value) override | AQNWB::HDF5::HDF5IO | virtual |
createStringDataSet(const std::string &path, const std::vector< std::string > &values) override | AQNWB::HDF5::HDF5IO | virtual |
createTimestampsAttributes(const std::string &path) | AQNWB::BaseIO | |
filename | AQNWB::HDF5::HDF5IO | protected |
getDataSet(const std::string &path) override | AQNWB::HDF5::HDF5IO | virtual |
getFileName() override | AQNWB::HDF5::HDF5IO | virtual |
getH5Type(BaseDataType type) | AQNWB::HDF5::HDF5IO | static |
getNativeType(BaseDataType type) | AQNWB::HDF5::HDF5IO | static |
getObjectType(const std::string &path) | AQNWB::HDF5::HDF5IO | |
HDF5IO() | AQNWB::HDF5::HDF5IO | |
HDF5IO(const std::string &fileName, const bool disableSWMRMode=false) | AQNWB::HDF5::HDF5IO | |
isOpen() const | AQNWB::BaseIO | |
isReadyToOpen() const | AQNWB::BaseIO | |
open() override | AQNWB::HDF5::HDF5IO | virtual |
open(bool newfile) override | AQNWB::HDF5::HDF5IO | virtual |
opened | AQNWB::BaseIO | protected |
operator=(const BaseIO &)=delete | AQNWB::BaseIO | |
readyToOpen | AQNWB::BaseIO | protected |
startRecording() override | AQNWB::HDF5::HDF5IO | virtual |
stopRecording() override | AQNWB::HDF5::HDF5IO | virtual |
~BaseIO() | AQNWB::BaseIO | virtual |
~HDF5IO() | AQNWB::HDF5::HDF5IO |
+
|
+ +overridevirtual | +
Checks whether the file is in a mode where objects can be added or deleted. Note, this does not apply to the modification of raw data on already existing objects.
+Reimplemented from AQNWB::BaseIO.
+ +
+
|
+ +overridevirtual | +
Start SWMR write to start recording process.
+Implements AQNWB::BaseIO.
+ +
+
|
+ +overridevirtual | +
Stops the recording process.
+Implements AQNWB::BaseIO.
+createElectricalSeries(std::vector< Types::ChannelVector > recordingArrays, const BaseDataType &dataType=BaseDataType::I16) | AQNWB::NWB::NWBFile | |
createFileStructure() | AQNWB::NWB::NWBFile | protected |
finalize() | AQNWB::NWB::NWBFile | |
finalize() | AQNWB::NWB::NWBFile | |
getTimeSeries(const SizeType ×eriesInd) | AQNWB::NWB::NWBFile | |
HDMFExperimentalVersion | AQNWB::NWB::NWBFile | |
HDMFVersion | AQNWB::NWB::NWBFile | |
initialize() | AQNWB::NWB::NWBFile | |
initialize() | AQNWB::NWB::NWBFile | |
NWBFile(const std::string &idText, std::shared_ptr< BaseIO > io) | AQNWB::NWB::NWBFile | |
NWBFile(const NWBFile &)=delete | AQNWB::NWB::NWBFile | |
NWBVersion | AQNWB::NWB::NWBFile | |
operator=(const NWBFile &)=delete | AQNWB::NWB::NWBFile | |
stopRecording() | AQNWB::NWB::NWBFile | |
~NWBFile() | AQNWB::NWB::NWBFile | |
startRecording() | AQNWB::NWB::NWBFile | |
stopRecording() | AQNWB::NWB::NWBFile | |
~NWBFile() | AQNWB::NWB::NWBFile |
Create ElectricalSeries objects to record data into. Created objects are stored in recordingContainers.
+Create ElectricalSeries objects to record data into. Created objects are stored in recordingContainers. Note, this function will fail if the file is in a mode where new objects cannot be added, which can be checked via nwbfile.io->canModifyObjects()
recordingArrays | vector of ChannelVector indicating the electrodes to record from. A separate ElectricalSeries will be created for each ChannelVector |
recordingArrays | vector of ChannelVector indicating the electrodes to record from. A separate ElectricalSeries will be created for each ChannelVector. |
dataType | The data type of the elements in the data block. |
Creates the default file structure.
+Creates the default file structure. Note, this function will fail if the file is in a mode where new objects cannot be added, which can be checked via nwbfile.io->canModifyObjects()
void NWBFile::finalize | +Status NWBFile::finalize | ( | ) | @@ -345,14 +348,14 @@ |
void NWBFile::initialize | +Status NWBFile::initialize | ( | ) | @@ -389,6 +392,25 @@ |
Status NWBFile::startRecording | +( | +) | ++ |
Starts the recording.
+Closes the relevant datasets.
+Stops the recording.
diff --git a/class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.js b/class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.js index 7af05a68..16870d01 100644 --- a/class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.js +++ b/class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.js @@ -5,10 +5,11 @@ var class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file = [ "~NWBFile", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#aa92925025c0a04da1d6b03b82af99da3", null ], [ "createElectricalSeries", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a825990d044b4351788590210440bcdac", null ], [ "createFileStructure", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#ab67a18abb35c3f280a437b906dd6a82e", null ], - [ "finalize", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#add9716af464c4e3cdef6eabc719be127", null ], + [ "finalize", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#af7b3285fd7e02b444372fb1ab4341674", null ], [ "getTimeSeries", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a2f99f38468fdb727adb9500a475b9d12", null ], - [ "initialize", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#ab7ea3337dbfaa6c403f03bdcf8cad38b", null ], + [ "initialize", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a49d305931788b0f57a04a557b46d6596", null ], [ "operator=", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a941d5b775441fac6c787cd55a8276461", null ], + [ "startRecording", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a902d040b7b4b811eb7d7ebeb65f90dbe", null ], [ "stopRecording", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a725e81c69195c8a9616aa4d2e7c21cb0", null ], [ "HDMFExperimentalVersion", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a7e787fd25b2117c1a922813bbcc5da2e", null ], [ "HDMFVersion", "class_a_q_n_w_b_1_1_n_w_b_1_1_n_w_b_file.html#a63c5b473dd46c9aa469431057e2e9559", null ], diff --git a/doxygen_crawl.html b/doxygen_crawl.html index 95db4e51..21d174fd 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -285,6 +285,7 @@ + @@ -297,6 +298,7 @@ + @@ -306,6 +308,7 @@ + @@ -337,6 +340,7 @@ + @@ -347,13 +351,15 @@ + + - + @@ -426,16 +432,17 @@ + + - - + diff --git a/functions_c.html b/functions_c.html index 079b47e0..e64b6c2b 100644 --- a/functions_c.html +++ b/functions_c.html @@ -103,6 +103,7 @@>= 3.15
>= 1.10