3d-pli / SLIX

Scattered Light Imaging ToolboX (SLIX) – an open-source Python package that allows a fully automated evaluation of SLI measurements and the generation of different parameter maps

MIT License

6 stars 3 forks source link

[DOC] SLIXLineplotParameterGenerator example #10

Closed matteomancini closed 3 years ago

matteomancini commented 3 years ago

Is it possible to add an example for SLIXLineplotParameterGenerator (even a very brief one) based on one of the two datasets used for SLIXParameterGenerator and providing a text file with intensity values? This would make easier to try out that specific functionality.

https://github.com/openjournals/joss-reviews/issues/2675

Thyre commented 3 years ago

I absolutely agree that we should include one or two examples for SLIXLineplotParameterGenerator in the README.md. I've added two example files in 10-SLIXLineplotParameterGenerator-example. The README.md is still in progress but will contain both instructions on how to use SLIXLineplotParameterGenerator and what results are being generated when running the program for the given examples (see update-readme).

miriammenzel commented 3 years ago

I have updated the README.md with a more detailed explanation and an example of how to use SLIXLineplotParameterGenerator in the Section Evaluation of Line Profiles. @matteomancini: Please let us know if we should add anything else.

miriammenzel commented 3 years ago

@matteomancini: Please let us know if we can close this issue.

matteomancini commented 3 years ago

I think it looks great, it is clear and immediate to reproduce!