pynwb.epoch module

class pynwb.epoch.EventTable(name, data=[])

Bases: pynwb.core.NWBTable

Parameters:
  • name (str) – the name of this table
  • data (ndarray or list or tuple or Dataset or AbstractDataChunkIterator or DataIO or FORMDataset) – the data in this table
add_row(start_time, stop_time, tags, timeseries)
Parameters:
  • start_time (float) – Start time of epoch, in seconds
  • stop_time (float) – Stop time of epoch, in seconds
  • tags (str or list or tuple) – user-defined tags uesd throughout epochs
  • timeseries (RegionSlicer) – the TimeSeries the epoch applies to
namespace = 'core'
neurodata_type = 'EpochTable'
class pynwb.epoch.EpochTable(name='epochs', data=[])

Bases: pynwb.core.NWBTable

Parameters:
  • name (str) – the name of this table
  • data (ndarray or list or tuple or Dataset or AbstractDataChunkIterator or DataIO or FORMDataset) – the data in this table
add_row(start_time, stop_time, tags, timeseries, description)
Parameters:
  • start_time (float) – Start time of epoch, in seconds
  • stop_time (float) – Stop time of epoch, in seconds
  • tags (str or list or tuple) – user-defined tags uesd throughout epochs
  • timeseries (RegionSlicer) – the TimeSeries the epoch applies to
  • description (str) – a description of this epoch
namespace = 'core'
neurodata_type = 'EpochTable'
class pynwb.epoch.EpochTableRegion(table, region, description, name='epochs')

Bases: pynwb.core.NWBTableRegion

A subsetting of an EpochTable

Parameters:
  • table (EpochTable) – the EpochTable this region applies to
  • region (slice or list or tuple) – the indices of the table
  • description (str) – a brief description of what this subset of epochs is
  • name (str) – the name of this container
description

a brief description of what this subset of epochs is

namespace = 'core'
neurodata_type = 'EpochTableRegion'
class pynwb.epoch.TimeSeriesIndex(name='timeseries_index', data=[])

Bases: pynwb.core.NWBTable

Parameters:
  • name (str) – the name of this table
  • data (ndarray or list or tuple or Dataset or AbstractDataChunkIterator or DataIO or FORMDataset) – the data in this table
add_row(idx_start, count, timeseries)
Parameters:
  • idx_start (int) – start index into the TimeSeries.data field
  • count (int) – number of data samples available in this TimeSeries
  • timeseries (TimeSeries) – the TimeSeries object this index applies to
namespace = 'core'
neurodata_type = 'TimeSeriesIndex'
class pynwb.epoch.Epochs(source, name='epochs', epochs=None, timeseries_index=None)

Bases: pynwb.core.NWBContainer

Parameters:
  • source (str) – the source of the data
  • name (str) – the name of this epoch table
  • epochs (EpochTable) – the EpochTable holding information about each epoch
  • timeseries_index (TimeSeriesIndex) – the TimeSeriesIndex table holding indices into each TimeSeries for each epoch
epochs

the EpochTable holding information about each epoch

timeseries_index

the TimeSeriesIndex table holding indices into each TimeSeries for each epoch

add_epoch(description, start_time, stop_time, tags, timeseries)
Parameters:
  • description (str) – a description of this epoch
  • start_time (float) – Start time of epoch, in seconds
  • stop_time (float) – Stop time of epoch, in seconds
  • tags (str or list or tuple) – user-defined tags uesd throughout epochs
  • timeseries (list or tuple or TimeSeries) – the TimeSeries this epoch applies to
get_timeseries(epoch_idx, ts_name)
namespace = 'core'
neurodata_type = 'Epochs'