Skip to content

common_region.py

BrainRegion

Bases: SpyglassMixin, Lookup

Source code in src/spyglass/common/common_region.py 
 8
 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
@schema
class BrainRegion(SpyglassMixin, dj.Lookup):
    definition = """
    region_id: smallint auto_increment
    ---
    region_name: varchar(200)             # the name of the brain region
    subregion_name=NULL: varchar(200)     # subregion name
    subsubregion_name=NULL: varchar(200)  # subregion within subregion
    """

    # TODO consider making (region_name, subregion_name, subsubregion_name) a
    # primary key subregion_name='' and subsubregion_name='' will be necessary
    # but that seems OK

    @classmethod
    def fetch_add(
        cls,
        region_name: str,
        subregion_name: str = None,
        subsubregion_name: str = None,
    ):
        """Return the region ID for names. If no match, add to the BrainRegion.

        The combination of (region_name, subregion_name, subsubregion_name) is
        effectively unique, then.

        Parameters
        ----------
        region_name : str
            The name of the brain region.
        subregion_name : str, optional
            The name of the subregion within the brain region.
        subsubregion_name : str, optional
            The name of the subregion within the subregion.

        Returns
        -------
        region_id : int
            The index of the region in the BrainRegion table.
        """
        key = dict(
            region_name=region_name,
            subregion_name=subregion_name,
            subsubregion_name=subsubregion_name,
        )
        query = BrainRegion & key
        if not query:
            cls.insert1(key)
            query = BrainRegion & key
        return query.fetch1("region_id")

fetch_add(region_name, subregion_name=None, subsubregion_name=None) classmethod

Return the region ID for names. If no match, add to the BrainRegion.

The combination of (region_name, subregion_name, subsubregion_name) is effectively unique, then.

Parameters:

Name Type Description Default
region_name str

The name of the brain region.

 required
subregion_name str

The name of the subregion within the brain region.

 None
subsubregion_name str

The name of the subregion within the subregion.

 None

Returns:

Name Type Description
region_id int

The index of the region in the BrainRegion table.
Source code in src/spyglass/common/common_region.py 
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
@classmethod
def fetch_add(
    cls,
    region_name: str,
    subregion_name: str = None,
    subsubregion_name: str = None,
):
    """Return the region ID for names. If no match, add to the BrainRegion.

    The combination of (region_name, subregion_name, subsubregion_name) is
    effectively unique, then.

    Parameters
    ----------
    region_name : str
        The name of the brain region.
    subregion_name : str, optional
        The name of the subregion within the brain region.
    subsubregion_name : str, optional
        The name of the subregion within the subregion.

    Returns
    -------
    region_id : int
        The index of the region in the BrainRegion table.
    """
    key = dict(
        region_name=region_name,
        subregion_name=subregion_name,
        subsubregion_name=subsubregion_name,
    )
    query = BrainRegion & key
    if not query:
        cls.insert1(key)
        query = BrainRegion & key
    return query.fetch1("region_id")