allensdk.internal.api.ophys_lims_api module

class allensdk.internal.api.ophys_lims_api.OphysLimsApi(ophys_experiment_id: int, lims_credentials: Optional[allensdk.core.authentication.DbCredentials] = None)

Bases: allensdk.core.cache_method_utilities.CachedInstanceMethodMixin

get_age(self)

get_average_intensity_projection_image_file(self)

get_behavior_session_id(self) → Union[int, NoneType]

Returns the behavior_session_id associated with this experiment, if applicable.

get_cell_roi_ids(self)

get_cell_specimen_table(self)

get_demix_file(self)

get_dff_file(self)

get_driver_line(self)

get_equipment_id(self)

get_experiment_date(self)

get_external_specimen_name(self, ophys_experiment_id=None)

get_field_of_view_shape(self)

get_foraging_id(self)

get_full_genotype(self)

get_imaging_depth(self)

get_imaging_plane_group(self) → Union[int, NoneType]

Get the imaging plane group number. This is a numeric index that indicates the order that the frames were acquired when there is more than one frame acquired concurrently. Relevant for mesoscope data timestamps, as the laser jumps between plane groups during the scan. Will be None for non-mesoscope data.

get_max_projection(self, image_api=None)

get_max_projection_file(self)

get_metadata(self)

get_motion_corrected_image_stack_file(self)

get_nwb_filepath(self)

get_objectlist_file(self)

get_ophys_cell_segmentation_run_id(self)

get_ophys_experiment_dir(self)

get_ophys_experiment_id(self)

get_plane_group_count(self) → int

Gets the total number of plane groups in the session. This is required for resampling ophys timestamps for mesoscope data. Will be 0 if the scope did not capture multiple concurrent frames. See get_imaging_plane_group for more info.

get_raw_cell_specimen_table_dict(self)

get_raw_dff_data(self)

get_reporter_line(self)

get_rig_name(self)

get_rigid_motion_transform_file(self)

get_sex(self)

get_stimulus_name(self)

get_surface_2p_pixel_size_um(self)

get_sync_file(self, ophys_experiment_id=None)

get_targeted_structure(self)

get_workflow_state(self)