-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve tutorials #102
Improve tutorials #102
Conversation
Hi @bruno-pannunzio : although I labelled this work in progress, I would appreciate your review. Specifically, is this level of detail appropriate for an introductory tutorial? Also, I think it is about time to replace the TIFF dataset from FLUTe with our own data before the first release of the library. Preferably in form of PTU files to demonstrate the |
Hi @cgohlke! I really like the suggested changes to the tutorials! It makes it much more clear and more direct to select one depending on the needs. Also the addition of the "Applications" sections is great, this can be useful to show the full functionalities of the library without crowding the API tutorials. I think we can work after in useful tutorials for the Applications section. Regarding the introduction tutorial, I think all are excellent additions.
I believe that in general it's okay the level of detail. I would suggest just moving the apparent lifetime section to another tutorial (maybe to an application tutorial?). I think the introduction tutorial is enough if we show the most basic workflow which I think is reached when plotting. I think further analyses can be discussed in more detail in other tutorials. Also, the introduction tutorial is missing hyperspectral images, which would be good to show since it's also an important aspect of the library, and at the moment the introduction tutorial is biased towards FLIM. Maybe we can use the paramecium example used in the cursors tutorial and show the basic workflow until plotting, which shouldn't extend too much the tutorial.
Definitely! This is long due. The problem we have with this is that our instruments only generate FBD files. We should consider reaching someone open to provide us some nice PTU files. Maybe @lmalacrida can help with this. |
Thanks for the review!
I'd like to add (not in this PR) a tutorial demonstrating out-of-core processing with dask on one of the tiled datasets that @schutyb recently shared. Let's discuss in the next meeting.
I agree, that section stands out. On the other hand, I wanted the introduction tutorial to demonstrate all aspects of the library, which includes converting phasor coordinates, and (currently still missing) cursors and components.
True. On the other hand, of the almost 60 functions and classes in the library so far, more than half are specific to FLIM, while only two (?) functions are specific to spectral imaging. Let's dedicate one section at the end of the introduction tutorial to "Spectral phasors", basically a shortened version of the cursors tutorial. OK?
FDB is certainly more appropriate than TIFF for the tutorial, but FBD is such a mess of a format that I prefer to not cover it in the main tutorial. |
Great!
Agree. PTU is more adequate for the tutorial. Let's discuss next meeting candidates to let us use some of their files. |
I added the section about spectral phasors and removed apparent lifetimes. In principle, this is ready for review and could be merged. Switching to PTU files and adding a tutorial about apparent lifetimes (which would require a helper function for plotting images) is better done in separate PRs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @cgohlke, I think now the introduction tutorial is great. I can work in a separate PR in the sections that were left to do (cursors and components) if you want, so that this can be merged and available.
Description
This PR proposes the following improvements to the tutorials:
Add conversion to apparent single lifetimes.TODO:
Add helper function for plotting images to reduce matplotlib code in tutorials.Replace FLUTe dataset with PTU files.Release note
Summarize the changes in the code block below to be included in the
release notes:
Checklist