allensdk.brain_observatory.behavior.data_objects.cell_specimens.traces.corrected_fluorescence_traces module

class allensdk.brain_observatory.behavior.data_objects.cell_specimens.traces.corrected_fluorescence_traces.CorrectedFluorescenceTraces(traces: DataFrame)

Bases: DataObject, RoisMixin, DataFileReadableInterface, NwbReadableInterface, NwbWritableInterface

A data container to load, access, and store the corrected_fluorescence_traces dataframe. Corrected fluorescence traces are neuropil corrected and demixed.

classmethod from_data_file(neuropil_corrected_file: NeuropilCorrectedFile) → CorrectedFluorescenceTraces

Populate a DataObject from the data file

Returns:

DataObject:

An instantiated DataObject which has name and value properties

classmethod from_nwb(nwbfile: NWBFile) → CorrectedFluorescenceTraces

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(nwbfile: NWBFile) → NWBFile

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

Parameters:

nwbfileNWBFile

An NWB file object

Returns:

NWBFile

An NWB file object that has had data from the DataObject added to it.