Skip to content

common_subject.py

Subject

Bases: SpyglassMixin, Manual

Source code in src/spyglass/common/common_subject.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
@schema
class Subject(SpyglassMixin, dj.Manual):
    definition = """
    subject_id: varchar(80)
    ---
    age = NULL: varchar(200)
    description = NULL: varchar(2000)
    genotype = NULL: varchar(2000)
    sex = "U": enum("M", "F", "U")
    species = NULL: varchar(200)
    """

    @classmethod
    def insert_from_nwbfile(cls, nwbf: NWBFile, config: dict = None):
        """Get the subject info from the NWBFile, insert into the Subject.

        Parameters
        ----------
        nwbf: pynwb.NWBFile
            The NWB file with subject information.
        config : dict, optional
            Dictionary read from a user-defined YAML file containing values to
            replace in the NWB file.

        Returns
        -------
        subject_id : string
            The id of the subject found in the NWB or config file, or None.
        """
        config = config or dict()
        if "Subject" not in config and nwbf.subject is None:
            logger.warn("No subject metadata found.\n")
            return None

        conf = config["Subject"][0] if "Subject" in config else dict()
        sub = (
            nwbf.subject
            if nwbf.subject is not None
            else type("DefaultObject", (), {})()
        )
        subject_dict = {
            field: conf.get(field, getattr(sub, field, None))
            for field in [
                "subject_id",
                "age",
                "description",
                "genotype",
                "species",
                "sex",
            ]
        }
        if (sex := subject_dict["sex"][0].upper()) in ("M", "F"):
            subject_dict["sex"] = sex
        else:
            subject_dict["sex"] = "U"

        cls.insert1(subject_dict, skip_duplicates=True)
        return subject_dict["subject_id"]

insert_from_nwbfile(nwbf, config=None) classmethod

Get the subject info from the NWBFile, insert into the Subject.

Parameters:

Name Type Description Default
nwbf NWBFile

The NWB file with subject information.

 required
config dict

Dictionary read from a user-defined YAML file containing values to replace in the NWB file.

 None

Returns:

Name Type Description
subject_id string

The id of the subject found in the NWB or config file, or None.
Source code in src/spyglass/common/common_subject.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
@classmethod
def insert_from_nwbfile(cls, nwbf: NWBFile, config: dict = None):
    """Get the subject info from the NWBFile, insert into the Subject.

    Parameters
    ----------
    nwbf: pynwb.NWBFile
        The NWB file with subject information.
    config : dict, optional
        Dictionary read from a user-defined YAML file containing values to
        replace in the NWB file.

    Returns
    -------
    subject_id : string
        The id of the subject found in the NWB or config file, or None.
    """
    config = config or dict()
    if "Subject" not in config and nwbf.subject is None:
        logger.warn("No subject metadata found.\n")
        return None

    conf = config["Subject"][0] if "Subject" in config else dict()
    sub = (
        nwbf.subject
        if nwbf.subject is not None
        else type("DefaultObject", (), {})()
    )
    subject_dict = {
        field: conf.get(field, getattr(sub, field, None))
        for field in [
            "subject_id",
            "age",
            "description",
            "genotype",
            "species",
            "sex",
        ]
    }
    if (sex := subject_dict["sex"][0].upper()) in ("M", "F"):
        subject_dict["sex"] = sex
    else:
        subject_dict["sex"] = "U"

    cls.insert1(subject_dict, skip_duplicates=True)
    return subject_dict["subject_id"]