allensdk.brain_observatory.behavior.internal.behavior_project_base module

class allensdk.brain_observatory.behavior.internal.behavior_project_base.BehaviorProjectBase

Bases: abc.ABC

get_behavior_only_session_data(self, behavior_session_id: int) → allensdk.brain_observatory.behavior.behavior_data_session.BehaviorDataSession

Returns a BehaviorDataSession object that contains methods to analyze a single behavior session. :param behavior_session_id: id that corresponds to a behavior session :type behavior_session_id: int :rtype: BehaviorDataSession

get_behavior_only_session_table(self) → pandas.core.frame.DataFrame

Returns a pd.DataFrame table with all behavior session_ids to the user with additional metadata. :rtype: pd.DataFrame

get_natural_movie_template(self, number: int) → Iterable[bytes]

Download a template for the natural scene stimulus. This is the actual image that was shown during the recording session. :param number: idenfifier for this movie (note that this is an int,

so to get the template for natural_movie_three should pass 3)

Returns:iterable yielding a tiff file as bytes

get_natural_scene_template(self, number: int) → Iterable[bytes]

Download a template for the natural movie stimulus. This is the actual movie that was shown during the recording session. :param number: identifier for this scene :type number: int :returns: An iterable yielding an npy file as bytes

get_session_data(self, ophys_session_id: int) → allensdk.brain_observatory.behavior.behavior_ophys_session.BehaviorOphysSession

Returns a BehaviorOphysSession object that contains methods to analyze a single behavior+ophys session. :param ophys_session_id: id that corresponds to a behavior session :type ophys_session_id: int :rtype: BehaviorOphysSession

get_session_table(self) → pandas.core.frame.DataFrame

Return a pd.Dataframe table with all ophys_session_ids and relevant metadata.