allensdk.brain_observatory.ecephys.optotagging module

class allensdk.brain_observatory.ecephys.optotagging.OptotaggingTable(table: pandas.core.frame.DataFrame)[source]

Bases: allensdk.core._data_object_base.data_object.DataObject, allensdk.core._data_object_base.readable_interfaces.JsonReadableInterface, allensdk.core._data_object_base.writable_interfaces.NwbWritableInterface, allensdk.core._data_object_base.readable_interfaces.NwbReadableInterface

Optotagging table - optotagging stimulation

classmethod from_json(dict_repr: dict) → 'OptotaggingTable'[source]

Populates a DataFile from a JSON compatible dict (likely parsed by argschema)

Returns:
DataObject:

An instantiated DataObject which has name and value properties
classmethod from_nwb(nwbfile: pynwb.file.NWBFile) → 'OptotaggingTable'[source]

Populate a DataObject from a pyNWB file object.

Parameters:
nwbfile:

The file object (NWBFile) of a pynwb dataset file.
Returns:
DataObject:

An instantiated DataObject which has name and value properties
to_nwb(self, nwbfile: pynwb.file.NWBFile) → pynwb.file.NWBFile[source]

Given an already populated DataObject, return an pyNWB file object that had had DataObject data added.

Parameters:
nwbfile : NWBFile

An NWB file object
Returns:
NWBFile

An NWB file object that has had data from the DataObject added to it.
value
Returns:
A dataframe with columns:
  • start_time: onset of stimulation
  • condition: optical stimulation pattern
  • level: intensity (in volts output to the LED) of stimulation
  • stop_time: stop time of stimulation
  • stimulus_name: stimulus name
  • duration: duration of stimulation