Skip to content

Commit

Permalink
Merge pull request #2 from aTrotier/aTrotier-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
aTrotier authored Nov 29, 2024
2 parents 5619ecc + 15289d7 commit 9a9c44c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@

Julia package of https://github.com/mfuderer/colorResources

<p>This package goes with the guideline paper published in Magnetic Resonance in Medicine, https://doi.org/10.1002/mrm.30290, <em> Color-map recommendation for MR relaxomtry maps </em>.</p>
> [!NOTE]
> <p>This package goes with the guideline paper published in Magnetic Resonance in Medicine, https://doi.org/10.1002/mrm.30290, <em> Color-map recommendation for MR relaxomtry maps </em>.</p>
<p>It is to be used to display quantitative maps of T1, R1, T2, R2, T2*, R2*, T1rho and R1rho.</p>
<p>The package contains the Lipari color map, the Navia color map as well as the logarithm-processing as referred to by the publication.</p>


<p>In essence, following commands are needed: </p>

```@example 1
Expand All @@ -21,7 +24,9 @@ using qMRIColors
cmap,imClip = relaxationColorMap("T1",x,loLev,upLev)
VIEW(imClip,c=cmap,clim=(loLev,upLev))
```
<p>In the above, "VIEW" refers to your favorite viewing software (CairoMakie, Plots, PyPlot, ...)</p>
> [!IMPORTANT]
> <p>In the above, "VIEW" refers to your favorite viewing software (CairoMakie, Plots, PyPlot, ...) : [see example](https://atrotier.github.io/qMRIColors.jl/dev/example/)</p>
<p>The relaxationColorMap() function selects the appropriate color-map (in this case, Lipari for T1) and applies logarithm-processing on that color map. The resulting colormap is returned.</p>
<p>The "imclip" image should retain the distinction between the "invalid" value of 0 (which is to be displayed as black) and "valid" values that are below loLev (these should be shown in a dark shade of blue). Depending on the calibration of your screen, you may or may not see that distinction.</p>
<p><br>A simplified processing can be done by</p>
Expand Down

0 comments on commit 9a9c44c

Please sign in to comment.