allensdk.brain_observatory.behavior.behavior_project_cache.tables.util.prior_exposure_processing module

allensdk.brain_observatory.behavior.behavior_project_cache.tables.util.prior_exposure_processing.add_experience_level_ophys(input_df: DataFrame) → DataFrame

adds a column to ophys tables that contains a string indicating whether a session had exposure level of Familiar, Novel 1, or Novel >1, based on session number and prior_exposure_to_image_set

Parameters:

input_df: pd.DataFrame

Returns:

experiments_table: pd.DataFrame

Notes

Does not change the input DataFrame in-place

allensdk.brain_observatory.behavior.behavior_project_cache.tables.util.prior_exposure_processing.add_experience_level_simple(input_df: DataFrame) → DataFrame

Add the column ‘experience_level’ to a dataframe. This column will be ‘Novel’ for any rows with ‘prior_exposures_to_image_set’ == 0 (or NULL) and ‘Familiar’ otherwise.

This experience level is mainly for VBN as the logic of Novel/Familiar differs between VBO and VBN.

Parameters:

input_dfpandas.DataFrame

Input sessions dataframe

Returns:

output_dfpandas.DataFrame

DataFrame with added “experience_level” column.

allensdk.brain_observatory.behavior.behavior_project_cache.tables.util.prior_exposure_processing.get_prior_exposures_to_image_set(df: DataFrame) → Series

Get prior exposures to image set

The image set here is the letter part of the session type ie for session type OPHYS_1_images_B, it would be “B”

Some session types don’t have an image set name, such as gratings, which will be set to null

Parameters:

df

The session df

Returns:

Series with index same as df and values prior exposure counts to image set

allensdk.brain_observatory.behavior.behavior_project_cache.tables.util.prior_exposure_processing.get_prior_exposures_to_omissions(df: DataFrame, fetch_api: BehaviorProjectLimsApi) → Series

Get prior exposures to omissions

Parameters:

df

The session df

fetch_api

API needed to query mtrain

Returns:

Series with index same as df and values prior exposure counts to omissions

allensdk.brain_observatory.behavior.behavior_project_cache.tables.util.prior_exposure_processing.get_prior_exposures_to_session_type(df: DataFrame) → Series

Get prior exposures to session type

Parameters:

df

The sessions df

Returns:

Series with index same as df and values prior exposure counts to

session type