pynwb.core module

pynwb.core.prepend_string(string, prepend='    ')

class pynwb.core.NWBMixin(name)

Bases: AbstractContainer

Parameters:

name (str) – the name of this container

get_ancestor(neurodata_type=None)

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)

Bases: NWBMixin, Container

Parameters:

name (str) – the name of this container

namespace = 'core'

neurodata_type = 'NWBContainer'

class pynwb.core.NWBDataInterface(name)

Bases: NWBContainer

Parameters:

name (str) – the name of this container

namespace = 'core'

neurodata_type = 'NWBDataInterface'

class pynwb.core.NWBData(name, data)

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

__getitem__(args)

append(arg)

extend(arg)

The extend_data method adds all the elements of the iterable arg to the end of the data of this Data container.

Parameters:

arg – The iterable to add to the end of this VectorData

namespace = 'core'

neurodata_type = 'NWBData'

class pynwb.core.ScratchData(name, data, notes='', description=None)

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

namespace = 'core'

neurodata_type = 'ScratchData'

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

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)

Bases: NWBDataInterface, MultiContainerInterface

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

Parameters:

name (str) – the name of this container