pynapple.io.interface_nwb.NWBFile#

class pynapple.io.interface_nwb.NWBFile(file, lazy_loading=True)[source]#

Bases: UserDict

Class for reading NWB Files.

Examples

>>> import pynapple as nap
>>> data = nap.load_file("my_file.nwb")
>>> data["units"]
  Index    rate  location      group
-------  ------  ----------  -------
      0    1.0  brain        0
      1    1.0  brain        0
      2    1.0  brain        0

__init__(file, lazy_loading=True)[source]#

Parameters:

file (str or pynwb.file.NWBFile) – Valid file to a NWB file
lazy_loading (bool) – If True return a memory-view of the data, load otherwise.

Raises:

FileNotFoundError – If path is invalid
RuntimeError – If file is not an instance of NWBFile

Methods

`__init__`(file[, lazy_loading])
`clear`()
`close`()	Close the NWB file
`copy`()
`fromkeys`(iterable[, value])
`get`(k[,d])
`items`()
`keys`()
`pop`(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
`popitem`()	as a 2-tuple; but raise KeyError if D is empty.
`setdefault`(k[,d])
`update`([E, ]**F)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
`values`()

clear() → None. Remove all items from D.#

close()[source]#: Close the NWB file

copy()#

classmethod fromkeys(iterable, value=None)#

get(k[, d]) → D[k] if k in D, else d. d defaults to None.#

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

pop(k[, d]) → v, remove specified key and return the corresponding value.#: If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair#: as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D#

update([E, ]**F) → None. Update D from mapping/iterable E and F.#: If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values#