Utility Types in MatNWB
“Untyped” Utility types are tools which allow for both flexibility as well as limiting certain constraints that are imposed by the NWB schema. These types are commonly stored in the
+types/+untyped/ package directories in your MatNWB installation.
Sets and Anons
The Set (
types.untyped.Set or Constrained Sets) is used to capture a dynamic number of particular NWB-typed objects. They may contain certain type constraints on what types are allowable to be set. Set keys and values can be set and retrieved using their
value = someSet.get('key name');
someSet.set('key name', value);
Sets also borrow
values methods to retrieve cell arrays of either.
The Anon type (
types.untyped.Anon) can be understood as a Set type with only a single key-value entry. This rarer type is only used for cases where the name for the stored object can be set by the user. Anon types may also hold NWB type constraints like Set.
DataStubs and DataPipes
DataStubs serves as a read-only link to your data. It allows for MATLAB-style indexing to retrieve the data stored on disk.
DataPipes are similar to DataStubs in that they allow you to load data from disk; however, they also provide a wide array of features that allow the user to write data to disk, either by streaming parts of data in at a time or by compressing the data before writing. The DataPipe is an advanced type and users looking to leverage DataPipe’s capabilities to stream/iteratively write or compress data should read the Advanced Data Write Tutorial.