Skip to content

position_merge.py

PositionOutput

Bases: _Merge, SpyglassMixin

Table to identify source of Position Information from upstream options (e.g. DLC, Trodes, etc...) To add another upstream option, a new Part table should be added in the same syntax as DLCPos and TrodesPos.

Source code in src/spyglass/position/position_merge.py 
 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
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
@schema
class PositionOutput(_Merge, SpyglassMixin):
    """
    Table to identify source of Position Information from upstream options
    (e.g. DLC, Trodes, etc...) To add another upstream option, a new Part table
    should be added in the same syntax as DLCPos and TrodesPos.
    """

    definition = """
    merge_id: uuid
    ---
    source: varchar(32)
    """

    class DLCPosV1(SpyglassMixin, dj.Part):
        """
        Table to pass-through upstream DLC Pose Estimation information
        """

        definition = """
        -> PositionOutput
        ---
        -> DLCPosV1
        """

    class TrodesPosV1(SpyglassMixin, dj.Part):
        """
        Table to pass-through upstream Trodes Position Tracking information
        """

        definition = """
        -> PositionOutput
        ---
        -> TrodesPosV1
        """

    class CommonPos(SpyglassMixin, dj.Part):
        """
        Table to pass-through upstream Trodes Position Tracking information
        """

        definition = """
        -> PositionOutput
        ---
        -> CommonPos
        """

    class ImportedPose(SpyglassMixin, dj.Part):
        """
        Table to pass-through upstream Pose information from NWB file
        """

        definition = """
        -> PositionOutput
        ---
        -> ImportedPose
        """

    def fetch1_dataframe(self) -> DataFrame:
        """Fetch a single dataframe from the merged table."""
        # proj replaces operator restriction to enable
        # (TableName & restriction).fetch1_dataframe()
        key = self.merge_restrict(self.proj()).proj()
        query = (
            source_class_dict[
                to_camel_case(self.merge_get_parent(self.proj()).table_name)
            ]
            & key
        )
        return query.fetch1_dataframe()

    def fetch_pose_dataframe(self):
        """Fetch a single dataframe of pose bodypart coordinates.

        This will work only for sources that have pose information.
        """
        key = self.merge_restrict(self.fetch("KEY", as_dict=True)).fetch(
            "KEY", as_dict=True
        )  # fetch the key from the merged table
        query = (
            source_class_dict[
                to_camel_case(self.merge_get_parent(self.proj()).table_name)
            ]
            & key
        )
        return query.fetch_pose_dataframe()

    def fetch_video_path(self, key=dict()):
        """Fetch the video path associated with the position information."""
        key = self.merge_restrict((self & key).proj()).proj()
        query = (
            source_class_dict[
                to_camel_case(self.merge_get_parent(self.proj()).table_name)
            ]
            & key
        )
        return query.fetch_video_path()

DLCPosV1

Bases: SpyglassMixin, Part

Table to pass-through upstream DLC Pose Estimation information

Source code in src/spyglass/position/position_merge.py 
37
38
39
40
41
42
43
44
45
46
class DLCPosV1(SpyglassMixin, dj.Part):
    """
    Table to pass-through upstream DLC Pose Estimation information
    """

    definition = """
    -> PositionOutput
    ---
    -> DLCPosV1
    """

TrodesPosV1

Bases: SpyglassMixin, Part

Table to pass-through upstream Trodes Position Tracking information

Source code in src/spyglass/position/position_merge.py 
48
49
50
51
52
53
54
55
56
57
class TrodesPosV1(SpyglassMixin, dj.Part):
    """
    Table to pass-through upstream Trodes Position Tracking information
    """

    definition = """
    -> PositionOutput
    ---
    -> TrodesPosV1
    """

CommonPos

Bases: SpyglassMixin, Part

Table to pass-through upstream Trodes Position Tracking information

Source code in src/spyglass/position/position_merge.py 
59
60
61
62
63
64
65
66
67
68
class CommonPos(SpyglassMixin, dj.Part):
    """
    Table to pass-through upstream Trodes Position Tracking information
    """

    definition = """
    -> PositionOutput
    ---
    -> CommonPos
    """

ImportedPose

Bases: SpyglassMixin, Part

Table to pass-through upstream Pose information from NWB file

Source code in src/spyglass/position/position_merge.py 
70
71
72
73
74
75
76
77
78
79
class ImportedPose(SpyglassMixin, dj.Part):
    """
    Table to pass-through upstream Pose information from NWB file
    """

    definition = """
    -> PositionOutput
    ---
    -> ImportedPose
    """

fetch1_dataframe()

Fetch a single dataframe from the merged table.

Source code in src/spyglass/position/position_merge.py 
81
82
83
84
85
86
87
88
89
90
91
92
def fetch1_dataframe(self) -> DataFrame:
    """Fetch a single dataframe from the merged table."""
    # proj replaces operator restriction to enable
    # (TableName & restriction).fetch1_dataframe()
    key = self.merge_restrict(self.proj()).proj()
    query = (
        source_class_dict[
            to_camel_case(self.merge_get_parent(self.proj()).table_name)
        ]
        & key
    )
    return query.fetch1_dataframe()

fetch_pose_dataframe()

Fetch a single dataframe of pose bodypart coordinates.

This will work only for sources that have pose information.

Source code in src/spyglass/position/position_merge.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def fetch_pose_dataframe(self):
    """Fetch a single dataframe of pose bodypart coordinates.

    This will work only for sources that have pose information.
    """
    key = self.merge_restrict(self.fetch("KEY", as_dict=True)).fetch(
        "KEY", as_dict=True
    )  # fetch the key from the merged table
    query = (
        source_class_dict[
            to_camel_case(self.merge_get_parent(self.proj()).table_name)
        ]
        & key
    )
    return query.fetch_pose_dataframe()

fetch_video_path(key=dict())

Fetch the video path associated with the position information.

Source code in src/spyglass/position/position_merge.py 
110
111
112
113
114
115
116
117
118
119
def fetch_video_path(self, key=dict()):
    """Fetch the video path associated with the position information."""
    key = self.merge_restrict((self & key).proj()).proj()
    query = (
        source_class_dict[
            to_camel_case(self.merge_get_parent(self.proj()).table_name)
        ]
        & key
    )
    return query.fetch_video_path()