pynwb.core module

class pynwb.core.NWBMixin(name)[source]

Bases: AbstractContainer

Parameters:: name (str) – the name of this container

get_ancestor(neurodata_type=None)[source]

Traverse parent hierarchy and return first instance of the specified data_type

Parameters:: neurodata_type (str) – the data_type to search for

property data_type: Return the spec data type associated with this container, i.e., the neurodata_type.

class pynwb.core.NWBContainer(name)[source]

Bases: NWBMixin, Container

Parameters:: name (str) – the name of this container

namespace = 'core'

neurodata_type = 'NWBContainer'

class pynwb.core.NWBDataInterface(name)[source]

Bases: NWBContainer

Parameters:: name (str) – the name of this container

namespace = 'core'

neurodata_type = 'NWBDataInterface'

class pynwb.core.NWBData(name, data)[source]

Bases: NWBMixin, Data

Parameters:

name (str) – the name of this container
data (str or int or float or bytes or bool or ndarray or list or tuple or Dataset or Array or StrDataset or HDMFDataset or AbstractDataChunkIterator or DataIO or Data) – the source of the data

property data: The data managed by this object

__getitem__(args)[source]

append(arg)[source]

Append a single element to the data

Note: The arg to append should be 1 dimension less than the data. For example, if the data is a 2D array, arg should be a 1D array. Appending to scalar data is not supported. To append multiple elements, use extend.

extend(arg)[source]: Extend the data with multiple elements.

namespace = 'core'

neurodata_type = 'NWBData'

class pynwb.core.ScratchData(name, data, notes=None, description=None)[source]

Bases: NWBData

Parameters:

name (str) – the name of this container
data (str or int or float or bytes or bool or ndarray or list or tuple or Dataset or Array or StrDataset or HDMFDataset or AbstractDataChunkIterator or DataIO or Data) – the source of the data
notes (str) – notes about the data. This argument will be deprecated. Use description instead
description (str) – notes about the data

property notes: Get the notes attribute. Use of ScratchData.notes has been deprecated and will be removed in PyNWB 4.0.

namespace = 'core'

neurodata_type = 'ScratchData'

class pynwb.core.NWBTable(columns, name, data=[])[source]

Bases: Table

Defined in PyNWB for API backward compatibility. See HDMF Table for details.

Parameters:

columns (list or tuple) – a list of the columns in this table
name (str) – the name of this container
data (ndarray or list or tuple or Dataset or Array or StrDataset or HDMFDataset or AbstractDataChunkIterator or DataIO) – the source of the data

class pynwb.core.MultiContainerInterface(name)[source]

Bases: NWBDataInterface, MultiContainerInterface

Defined in PyNWB for API backward compatibility. See HDMF MultiContainterInterface for details.

Parameters:: name (str) – the name of this container