Tutorial for SimpleMotion creation and simulation

[pvillacorta]

https://juliahealth.org/KomaMRI.jl/previews/PR387/

[codecov]

Codecov Report

Attention: Patch coverage is 90.47619% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 89.47%. Comparing base (b3d6cd4) to head (f6074ec).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #387      +/-   ##
==========================================
- Coverage   89.89%   89.47%   -0.42%     
==========================================
  Files          43       43              
  Lines        2730     2728       -2     
==========================================
- Hits         2454     2441      -13     
- Misses        276      287      +11     

Flag	Coverage Δ
base	86.42% <100.00%> (ø)
core	86.93% <ø> (ø)
files	93.70% <ø> (ø)
komamri	93.96% <ø> (ø)
plots	89.64% <33.33%> (-3.30%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
KomaMRIBase/src/datatypes/Phantom.jl	84.86% <ø> (ø)
...se/src/datatypes/phantom/motion/ArbitraryMotion.jl	98.21% <100.00%> (ø)
...IBase/src/datatypes/phantom/motion/SimpleMotion.jl	66.66% <ø> (ø)
...datatypes/phantom/motion/simplemotion/HeartBeat.jl	92.85% <ø> (ø)
...s/phantom/motion/simplemotion/PeriodicHeartBeat.jl	0.00% <ø> (ø)
...es/phantom/motion/simplemotion/PeriodicRotation.jl	90.47% <100.00%> (ø)
.../datatypes/phantom/motion/simplemotion/Rotation.jl	90.47% <100.00%> (ø)
...tatypes/phantom/motion/simplemotion/Translation.jl	81.81% <ø> (ø)
KomaMRIPlots/src/ui/DisplayFunctions.jl	90.47% <33.33%> (-3.54%)	⬇️

[cncastillo]

Just a few changes, you can change the first example to the translation, and then you focus the second section on the "motion-corrected reconstruction" (not just corrected). Also when the simple motion types are explained, some references to the API definitions of Translation, Rotation, etc could be added.

[pvillacorta]

@cncastillo you mean removing the rotation section? So first section would be translation and second would be motion-corrected simulation?

[cncastillo]

@cncastillo you mean removing the rotation section? So first section would be translation and second would be motion-corrected simulation?

More like removing the new translation section, and modify the current one with the mentioned modifications:

• Use "motion-corrected reconstruction" (not just corrected)
• Change first section to use a Translation
• Also when the simple motion types are explained, some references to the API definitions of Translation, Rotation, etc could be added
• Limit max-height of images in docstring to max-height: 300px;

[cncastillo]

Very nice! when these are fixed we can merge.