pynwb.base module

class pynwb.base.ProcessingModule(name, source, description, containers=None, parent=None)

Bases: pynwb.core.NWBContainer

Processing module. This is a container for one or more containers that provide data at intermediate levels of analysis

ProcessingModules should be created through calls to NWB.create_module(). They should not be instantiated directly

Parameters:
  • name (str) – The name of this processing module
  • source (str) – the source of the data
  • description (str) – Description of this processing module
  • containers (list or dict) – NWBContainers that belong to this ProcessingModule
  • parent (NWBContainer) – The parent NWBContainer for this NWBContainer
add_container(container)

Add an NWBContainer to this ProcessingModule

Parameters:container (NWBContainer) – the NWBContainer to add to this Module
containers
description
get_container(container_name)

Retrieve an NWBContainer from this ProcessingModule

Parameters:container_name (str) – the name of the NWBContainer to retrieve
class pynwb.base.TimeSeries(name, source, data, unit, resolution=0.0, conversion=1.0, timestamps=None, starting_time=None, rate=None, comments=no comments, description=no description, control=None, control_description=None, parent=None)

Bases: pynwb.core.NWBContainer

Standard TimeSeries constructor

All time series are created by calls to NWB.create_timeseries(). They should not not be instantiated directly

Create a TimeSeries object

Parameters:
  • name (str) – The name of this TimeSeries dataset
  • source (str) – Name of TimeSeries or Modules that serve as the source for the data contained here. It can also be the name of a device, for stimulus or acquisition data
  • data (Iterable or TimeSeries or DataChunkIterator) – The data this TimeSeries dataset stores. Can also store binary data e.g. image frames
  • unit (str) – The base unit of measurement (should be SI unit)
  • resolution (str or float) – The smallest meaningful difference (in specified unit) between values in data
  • conversion (str or float) – Scalar to multiply each element in data to convert it to the specified unit
  • timestamps (Iterable or TimeSeries or DataChunkIterator) – Timestamps for samples stored in data
  • starting_time (float) – The timestamp of the first sample
  • rate (float) – Sampling rate in Hz
  • comments (str) – Human-readable comments about this TimeSeries dataset
  • description (str) – Description of this TimeSeries dataset
  • control (Iterable) – Numerical labels that apply to each element in data
  • control_description (Iterable) – Description of each control value
  • parent (NWBContainer) – The parent NWBContainer for this NWBContainer
ancestry
comments
control
control_description
conversion
data
description
help
interval
neurodata_type
num_samples
rate
rate_unit
resolution
starting_time
time_unit
timestamps
timestamps_unit
unit