Merge pull request #1734 from AllenInstitute/GH-1491/behavior-session-id-in-BehaviorOphysSession

GH #1491: Add behavior_session_id to BehaviorOphysSession

Author: kschelonka

allensdk/brain_observatory/behavior/behavior_ophys_session.py

@@ -1,7 +1,7 @@
 import numpy as np
 import pandas as pd
 import xarray as xr
-from typing import Any
+from typing import Any, Optional
 import logging
 
 
@@ -98,6 +98,13 @@ def ophys_experiment_id(self) -> int:
         """
         return self.api.get_ophys_experiment_id()
 
+    @property
+    def behavior_session_id(self) -> Optional[int]:
+        """Returns the unique identifier for the behavior session
+        associated with this experiment, if applicable.
+        """
+        return self.api.get_behavior_session_id()
+
     @property
     def max_projection(self) -> Image:
         """2D max projection image.

allensdk/brain_observatory/behavior/internal/behavior_base.py

@@ -14,6 +14,13 @@ class BehaviorBase(abc.ABC):
     Child classes should be instantiated with a fetch API that implements these
     methods.
     """
+    @abc.abstractmethod
+    def get_behavior_session_id(self) -> int:
+        """Returns the behavior_session_id associated with this experiment,
+        if applicable.
+        """
+        raise NotImplementedError()
+
     @abc.abstractmethod
     def get_licks(self) -> pd.DataFrame:
         """Get lick data from pkl file.

allensdk/brain_observatory/behavior/internal/behavior_ophys_base.py

@@ -1,4 +1,5 @@
 import abc
+from typing import Optional
 
 import numpy as np
 import pandas as pd
@@ -12,8 +13,16 @@ class BehaviorOphysBase(BehaviorBase):
     behavior+ophys session data.
 
     Child classes should be instantiated with a fetch API that implements these
-    methods. Both fetch API and session object should inherit from this base.
+    methods.
     """
+
+    @abc.abstractmethod
+    def get_ophys_session_id(self) -> Optional[int]:
+        """Returns the ophys_session_id associated with this experiment,
+        if applicable.
+        """
+        raise NotImplementedError()
+
     @abc.abstractmethod
     def get_average_projection(self) -> Image:
         """Get an image whose values are the average obtained values at

allensdk/internal/api/ophys_lims_api.py

@@ -83,6 +83,26 @@ def get_imaging_plane_group(self) -> Optional[int]:
         else:
             return None
 
+    @memoize
+    def get_behavior_session_id(self) -> Optional[int]:
+        """Returns the behavior_session_id associated with this experiment,
+        if applicable.
+        """
+        query = f"""
+            SELECT bs.id
+            FROM ophys_experiments oe
+            -- every ophys_experiment should have an ophys_session
+            JOIN ophys_sessions os ON oe.ophys_session_id = os.id
+            -- but not every ophys_session has a behavior_session
+            LEFT JOIN behavior_sessions bs ON os.id = bs.ophys_session_id
+            WHERE oe.id = {self.get_ophys_experiment_id()}
+        """
+        response = self.lims_db.fetchall(query)     # Can be null
+        if not len(response):
+            return None
+        else:
+            return response[0]
+
     @memoize
     def get_ophys_experiment_dir(self):
         query = '''