allensdk.brain_observatory.behavior.data_objects.metadata.subject_metadata.sex module

class allensdk.brain_observatory.behavior.data_objects.metadata.subject_metadata.sex.Sex(sex: str)[source]

Bases: DataObject, LimsReadableInterface, JsonReadableInterface, NwbReadableInterface

sex of the animal (M/F)

classmethod from_json(dict_repr: dict) → Sex[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(behavior_session_id: int, lims_db: PostgresQueryMixin) → Sex[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) → Sex[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