Improve accessibility & review of videos & local zstacks in mouse-seeks

[DowntonCrabby]

Feature Request Motivation Currently to review the relevant videos or zstacks for an experiment or session qcers have to navigate away from the mouse-seeks qc report and look up the network location to the relevant files elsewhere, then load them in the appropriate viewing software, then review them. This process is clunky, prone to errors, and discourages qcers from reviewing said data.

Requested Feature/Solution Minimum viable product: add links in the qc report to the relevant file locations.

Next level improvement: MVP + add a way to flag or fail these as appropriate with controlled language tags for why they are flagged/failed

Ideal option: in-app/ in-report video viewing that adds the relevant plots to the video to better view how plots and datastreams are related, and add flag/fail tags with controlled language.

Here are the sections of the qc report that it would be helpful to add this feature to and which video or zstack it would be helpful to add:

• Physio Signal Report: motion corrected physio movie
• Epilepsy Report: motion corrected physio movie, behavior monitoring movie
• Stress Report: eye tracking movie, behavior monitoring movie
• Mouse wheel report: behavior monitoring movie
• visual behavior session summary: behavior monitoring movie
• motion correction report: motion corrected physio movie- the downsampled motion preview &/or the full thing
• stability report Z-Drift: local zstack

Screenshots or example plots Minimum viable product mockup:

Ideal product mockup: (please ignore the poor quality photoshopping)

Scope This has a broad scope as it could impact many projects.

[seanmcculloch]

@samiamseid Could you provide example motion corrected physio movie and local zstack files for a session? I am not sure where these are stored.

[DowntonCrabby]

@seanmcculloch the motion corrected physio movie is a well known file so it should be a standard retrieval from lims. I believe there is a function in visual_behavior_analysis.loading.from_lims that will return the filepath.

def get_motion_corrected_movie_filepath(ophys_experiment_id):
    conditions.validate_id_type(ophys_experiment_id, "ophys_experiment_id")
    filepath = get_well_known_file_path("'MotionCorrectedImageStack'", ophys_experiment_id)
    return filepath 

I do not believe the local zstacks are well known files however so they might be harder to retrieve reliably. They should be in the experiment folder and are usually called experimentId_zstack_local.h5 or experimentId_zstack_local_dewarping.h5

[seanmcculloch]

The filepaths to relevant data files have been added to QC reports.