pynwb.base module

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

Bases: pynwb.core.MultiContainerInterface

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
  • data_interfaces (list or tuple or dict) – NWBDataInterfacess that belong to this ProcessingModule
  • parent (NWBContainer) – The parent NWBContainer for this NWBContainer
description

Description of this processing module

data_interfaces

a dictionary containing the NWBDataInterface in this ProcessingModule container

containers
__getitem__(name=None)

Get a NWBDataInterface from this ProcessingModule

Parameters:name (str) – the name of the NWBDataInterface
Returns:the NWBDataInterface with the given name
Return type:NWBDataInterface
add_container(container)

Add an NWBContainer to this ProcessingModule

Parameters:container (NWBDataInterface) – the NWBDataInterface to add to this Module
get_container(container_name)

Retrieve an NWBContainer from this ProcessingModule

Parameters:container_name (str) – the name of the NWBContainer to retrieve
add_data_interface(data_interfaces)

Add a NWBDataInterface to this ProcessingModule

Parameters:data_interfaces (list or tuple or dict or NWBDataInterface) – the NWBDataInterface to add
get_data_interface(name=None)

Get a NWBDataInterface from this ProcessingModule

Parameters:name (str) – the name of the NWBDataInterface
Returns:the NWBDataInterface with the given name
Return type:NWBDataInterface
namespace = 'core'
neurodata_type = 'ProcessingModule'
class pynwb.base.TimeSeries(name, source, data=None, unit=None, 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.NWBDataInterface

A generic base class for time series data

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 (ndarray or list or tuple or Dataset or AbstractDataChunkIterator or DataIO or FORMDataset or TimeSeries) – 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 (ndarray or list or tuple or Dataset or AbstractDataChunkIterator or DataIO or FORMDataset or TimeSeries) – 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
timestamps_unit
interval
starting_time

The timestamp of the first sample

rate

Sampling rate in Hz

rate_unit
help
data
comments

Human-readable comments about this TimeSeries dataset

control

Numerical labels that apply to each element in data

control_description

Description of each control value

conversion

Scalar to multiply each element in data to convert it to the specified unit

description

Description of this TimeSeries dataset

namespace = 'core'
neurodata_type = 'TimeSeries'
num_samples
resolution

The smallest meaningful difference (in specified unit) between values in data

timestamps
unit

The base unit of measurement (should be SI unit)

time_unit