allensdk.brain_observatory.behavior.data_objects.motion_correction module

class allensdk.brain_observatory.behavior.data_objects.motion_correction.MotionCorrection(motion_correction: DataFrame)[source]

Bases: DataObject, DataFileReadableInterface, NwbReadableInterface, NwbWritableInterface

motion correction output

classmethod from_data_file(rigid_motion_transform_file: RigidMotionTransformFile) → MotionCorrection[source]

Populate a DataObject from the data file

Returns:
DataObject:

An instantiated DataObject which has name and value properties

classmethod from_nwb(nwbfile: NWBFile) → MotionCorrection[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(nwbfile: NWBFile) → NWBFile[source]

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.