pynwb.ogen module

class pynwb.ogen.OptogeneticStimulusSite(name, device, description, excitation_lambda, location)[source]

Bases: NWBContainer

Optogenetic stimulus site.

Parameters:

  • name (str) – The name of this stimulus site.

  • device (Device) – The device that was used.

  • description (str) – Description of site.

  • excitation_lambda (float) – Excitation wavelength in nm.

  • location (str) – Location of stimulation site.

property description

Description of site.

property device

The device that was used.

property excitation_lambda

Excitation wavelength in nm.

property location

Location of stimulation site.

namespace = 'core'
neurodata_type = 'OptogeneticStimulusSite'
class pynwb.ogen.OptogeneticSeries(name, data, site, resolution=-1.0, conversion=1.0, timestamps=None, starting_time=None, rate=None, comments='no comments', description='no description', control=None, control_description=None, offset=0.0)[source]

Bases: TimeSeries

Optogenetic stimulus. The data field is in unit of watts.

Parameters:

  • name (str) – The name of this TimeSeries dataset

  • data (ndarray or list or tuple or Dataset or StrDataset or HDMFDataset or AbstractDataChunkIterator or DataIO or TimeSeries) – The data values over time. Must be 1D.

  • site (OptogeneticStimulusSite) – The site to which this stimulus was applied.

  • resolution (float) – The smallest meaningful difference (in specified unit) between values in data

  • conversion (float) – Scalar to multiply each element in data to convert it to the specified unit

  • timestamps (ndarray or list or tuple or Dataset or StrDataset or HDMFDataset or AbstractDataChunkIterator or DataIO 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

  • offset (float) – Scalar to add to each element in the data scaled by ‘conversion’ to finish converting it to the specified unit.

property site

The site to which this stimulus was applied.

namespace = 'core'
neurodata_type = 'OptogeneticSeries'