TissueImageAnalytics / tiatoolbox

Computational Pathology Toolbox developed by TIA Centre, University of Warwick.
https://warwick.ac.uk/tia
Other
340 stars 71 forks source link

🆕 Add Reading Slide-level info & Simple Plugins for Visualization Tool #789

Open measty opened 4 months ago

measty commented 4 months ago

This PR adds in a feature from the most recent version of TIAViz to allow a .csv to be provided in the slides folder that can contain slide level predictions or ground truth labels/other slide level info.

When loading a slide in the UI, if the slide name (including suffix) appears in the "Image File" column of the .csv, any information in the corresponding row of the .csv will appear in the UI below the main window in a nicely formatted string.

Only the "Image File" column is required for this to work, the rest of the columns can be anything you need to have displayed.

Also adds entry in documentation describing feature.

In response to Mostafa's request for more flexibility in what sort of extra info you can add to the UI, i've also added some basic plugin functionality to this PR (and converted to draft for now as it has become much larger and needs tests/docs to be added over the coming weeks, and may be tweaked a bit).

Plugins are defined as a class following an ABC and can add a collection of bokeh UI elements and/or plots below the main view window (and can potentially also insert additional UI elements into the main controls section). This is pretty flexible and can add some quite complex extras in there as you have all the power of bokeh to work with.

I have added 3 pre-built plugins that will cover some use-cases, and provide examples which users can adapt or take inspiration from to make their own custom plugin.

The 3 provided are: ImageGrid: if each slide has a folder of images associated with it, this plugin will show the images in a grid-like layout below the slide view window. BarPLotGrid: makes a gridlike layout of bar charts from csv files associated with each slide StatsPlot: adds some UI elements to show a histogram showing the distribution of a property over the annotations in the selected box on the slide window

To add plugins when launching the tool, you can add one or more --plugin arguments each with a path pointing to the file where the plugin class is.

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 28.09917% with 174 lines in your changes missing coverage. Please review.

Project coverage is 97.92%. Comparing base (621a857) to head (7768414). Report is 1 commits behind head on develop.

Files Patch % Lines
...ox/visualization/bokeh_app/templates/stats_plot.py 0.00% 73 Missing :warning:
...visualization/bokeh_app/templates/bar_plot_grid.py 0.00% 45 Missing :warning:
...ox/visualization/bokeh_app/templates/image_grid.py 0.00% 30 Missing :warning:
tiatoolbox/visualization/bokeh_app/main.py 68.57% 19 Missing and 3 partials :warning:
tiatoolbox/visualization/ui_utils.py 81.81% 4 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #789 +/- ## =========================================== - Coverage 99.89% 97.92% -1.98% =========================================== Files 69 72 +3 Lines 8650 8864 +214 Branches 1653 1685 +32 =========================================== + Hits 8641 8680 +39 - Misses 1 173 +172 - Partials 8 11 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.