allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.field_of_view_shape module

class allensdk.brain_observatory.behavior.data_objects.metadata.ophys_experiment_metadata.field_of_view_shape.FieldOfViewShape(height: int, width: int)[source]

Bases: DataObject, LimsReadableInterface, NwbReadableInterface, JsonReadableInterface

classmethod from_json(dict_repr: dict) FieldOfViewShape[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_lims(ophys_experiment_id: int, lims_db: PostgresQueryMixin) FieldOfViewShape[source]

Populate a DataObject from an internal database (likely LIMS)

Returns:
DataObject:

An instantiated DataObject which has name and value properties

classmethod from_nwb(nwbfile: NWBFile) FieldOfViewShape[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

property height
property width