Expand fancylog's scope

[adamltyson]

Eventually we want fancylog to not just log basic information, but additional info like data, plots etc that can be used to create reports/dashboards following a data analysis run. The exact form of this is TBC, but we should explore standardised ways to save data of interest that could work across many tools. One approach could be to implement some kind of decorator that saves data to file in a specific file structure (cf NeuroBlueprint).

[IgorTatarnikov]

I think the automated target selection, developed by @saarah815, in brainglobe-registration is a good candidate to pilot logging more than text during execution.

Ideally we'd want to save an image at arbitrary points during execution. Should this first step be a simple fancylog.log_image function that writes an image to the logging directory and a path to the saved image in the text log?

[adamltyson]

Yeah I think that's a nice approach. Perhaps in a new subdirectory? We may have a reason to log hundreds of images.

[adamltyson]

I've created an issue (#65) to track the idea of logging images. Any other ideas of things we'd like to log?

[IgorTatarnikov]

Off the top of my head:

1. Array like data of arbitrary dimensionality - to a compressed npy format perhaps?
2. Plots, not sure where the responsibility for generating the plot would lie, but perhaps fancylog could accept a matplotlib figure and save it to the logging directory.