Merge pull request #2201 from AllenInstitute/ticket/2194/reorder/stimulus/table

Ticket/2194/reorder/stimulus/table

Author: danielsf

allensdk/brain_observatory/behavior/behavior_session.py

@@ -35,15 +35,39 @@ def __init__(self, api: Optional[BehaviorDataApi] = None):
                                            settable=True, lowpass=True)
         self._raw_running_speed = LazyProperty(self.api.get_running_speed,
                                                settable=True, lowpass=False)
+
+        def stimulus_getter():
+            _df = self.api.get_stimulus_presentations()
+            _df.drop(['index'], axis=1, errors='ignore')
+            _df = _df[['start_time', 'stop_time',
+                       'duration',
+                       'image_name', 'image_index',
+                       'is_change', 'omitted',
+                       'start_frame', 'end_frame',
+                       'image_set']]
+            return _df
         self._stimulus_presentations = LazyProperty(
-            self.api.get_stimulus_presentations, settable=True)
+            stimulus_getter, settable=True)
+
         self._stimulus_templates = LazyProperty(
             self.api.get_stimulus_templates, settable=True)
         self._stimulus_timestamps = LazyProperty(
             self.api.get_stimulus_timestamps, settable=True)
         self._task_parameters = LazyProperty(self.api.get_task_parameters,
                                              settable=True)
-        self._trials = LazyProperty(self.api.get_trials, settable=True)
+
+        def trials_getter():
+            _df = self.api.get_trials()
+            _df = _df[['initial_image_name', 'change_image_name',
+                       'stimulus_change', 'change_time',
+                       'go', 'catch', 'lick_times', 'response_time',
+                       'response_latency', 'reward_time', 'reward_volume',
+                       'hit', 'false_alarm', 'miss', 'correct_reject',
+                       'aborted', 'auto_rewarded', 'change_frame',
+                       'start_time', 'stop_time', 'trial_length']]
+            return _df
+        self._trials = LazyProperty(trials_getter, settable=True)
+
         self._metadata = LazyProperty(self.api.get_metadata, settable=True)
 
     # ==================== class and utility methods ======================
@@ -441,27 +465,29 @@ def stimulus_presentations(self) -> pd.DataFrame:
                 stimulus_presentations_id [index]: (int)
                     identifier for a stimulus presentation
                     (presentation of an image)
+                start_time: (float)
+                    image presentation start time in seconds
+                stop_time: (float)
+                    image presentation end time in seconds
                 duration: (float)
                     duration of an image presentation (flash)
                     in seconds (stop_time - start_time). NaN if omitted
-                end_frame: (float)
-                    image presentation end frame
+                image_name: (str)
                 image_index: (int)
                     image index (0-7) for a given session,
                     corresponding to each image name
-                image_set: (string)
-                    image set for this behavior session
-                index: (int)
-                    an index assigned to each stimulus presentation
+                is_change: (bool)
+                    True if the presentation represents a change
+                    in image
                 omitted: (bool)
                     True if no image was shown for this stimulus
                     presentation
                 start_frame: (int)
                     image presentation start frame
-                start_time: (float)
-                    image presentation start time in seconds
-                stop_time: (float)
-                    image presentation end time in seconds
+                end_frame: (float)
+                    image presentation end frame
+                image_set: (string)
+                    image set for this behavior session
         """
         return self._stimulus_presentations
 
@@ -583,9 +609,29 @@ def trials(self) -> pd.DataFrame:
             dataframe columns:
                 trials_id: (int)
                     trial identifier
+                initial_image_name: (string)
+                    name of image presented at start of trial
+                change_image_name: (string)
+                    name of image that is changed to at the change time,
+                    on go trials
+                stimulus_change: (bool)
+                    True if an image change occurs during the trial
+                    (if the trial was both a 'go' trial and the trial
+                    was not aborted)
+                change_time: (float)
+                go: (bool)
+                    Trial type. True if there was a change in stimulus
+                    image identity on this trial
+                catch: (bool)
+                    Trial type. True if there was not a change in stimulus
+                    identity on this trial
                 lick_times: (array of float)
                     array of lick times in seconds during that trial.
                     Empty array if no licks occured during the trial.
+                response_time: (float)
+                    time of first lick in trial in seconds and NaN if
+                    trial aborted
+                response_latency: (float)
                 reward_time: (NaN or float)
                     Time the reward is delivered following a correct
                     response or on auto rewarded trials.
@@ -601,41 +647,24 @@ def trials(self) -> pd.DataFrame:
                 miss: (bool)
                     Behavior response type. On a go trial, mouse either
                     does not lick at all, or licks after reward window
-                stimulus_change: (bool)
-                    True if an image change occurs during the trial
-                    (if the trial was both a 'go' trial and the trial
-                    was not aborted)
+                correct_reject: (bool)
+                    Behavior response type. On a catch trial, mouse
+                    either does not lick at all or licks after reward
+                    window
                 aborted: (bool)
                     Behavior response type. True if the mouse licks
                     before the scheduled change time.
-                go: (bool)
-                    Trial type. True if there was a change in stimulus
-                    image identity on this trial
-                catch: (bool)
-                    Trial type. True if there was not a change in stimulus
-                    identity on this trial
                 auto_rewarded: (bool)
                     True if free reward was delivered for that trial.
                     Occurs during the first 5 trials of a session and
                     throughout as needed.
-                correct_reject: (bool)
-                    Behavior response type. On a catch trial, mouse
-                    either does not lick at all or licks after reward
-                    window
+                change_frame: (float)
                 start_time: (float)
                     start time of the trial in seconds
                 stop_time: (float)
                     end time of the trial in seconds
                 trial_length: (float)
                     duration of trial in seconds (stop_time -start_time)
-                response_time: (float)
-                    time of first lick in trial in seconds and NaN if
-                    trial aborted
-                initial_image_name: (string)
-                    name of image presented at start of trial
-                change_image_name: (string)
-                    name of image that is changed to at the change time,
-                    on go trials
         """
         return self._trials