Skip to content

Commit

Permalink
change again
Browse files Browse the repository at this point in the history
  • Loading branch information
aTrotier committed Dec 9, 2024
1 parent a75e4ee commit 2363488
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 31 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,6 @@ jobs:
shell: julia --project=docs --color=yes {0}
run: |
using Documenter: DocMeta, doctest
using QuantitativeMRIColors
DocMeta.setdocmeta!(QuantitativeMRIColors, :DocTestSetup, :(using QuantitativeMRIColors); recursive=true)
doctest(QuantitativeMRIColors)
using QMRIColors
DocMeta.setdocmeta!(QMRIColors, :DocTestSetup, :(using QMRIColors); recursive=true)
doctest(QMRIColors)
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name = "QuantitativeMRIColors"
name = "QMRIColors"
uuid = "2bec176e-9e8c-4764-a62f-295118d1ec05"
authors = ["aTrotier <[email protected]> and contributors"]
version = "1.0.0"
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# QuantitativeMRIColors
# QMRIColors

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://magneticresonanceimaging.github.io/QuantitativeMRIColors.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://magneticresonanceimaging.github.io/QuantitativeMRIColors.jl/dev/)
[![Build Status](https://github.com/magneticresonanceimaging/QuantitativeMRIColors.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/magneticresonanceimaging/QuantitativeMRIColors.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/magneticresonanceimaging/QuantitativeMRIColors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/magneticresonanceimaging/QuantitativeMRIColors.jl)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://magneticresonanceimaging.github.io/QMRIColors.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://magneticresonanceimaging.github.io/QMRIColors.jl/dev/)
[![Build Status](https://github.com/magneticresonanceimaging/QMRIColors.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/magneticresonanceimaging/QMRIColors.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/magneticresonanceimaging/QMRIColors.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/magneticresonanceimaging/QMRIColors.jl)


Julia package of https://github.com/mfuderer/colorResources
Expand All @@ -20,19 +20,19 @@ Julia package of https://github.com/mfuderer/colorResources
```@example 1
# x is the image to be displayed, (loLev,upLev) is the relevant range of the values
# we take T1 as an example
using QuantitativeMRIColors
using QMRIColors
cmap,imClip = relaxationColorMap("T1",x,loLev,upLev)
VIEW(imClip,c=cmap,clim=(loLev,upLev))
```
> [!IMPORTANT]
> <p>In the above, "VIEW" refers to your favorite viewing software (CairoMakie, Plots, PyPlot, ...) : [see example](https://magneticresonanceimaging.github.io/QuantitativeMRIColors.jl/dev/example/)</p>
> <p>In the above, "VIEW" refers to your favorite viewing software (CairoMakie, Plots, PyPlot, ...) : [see example](https://magneticresonanceimaging.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>

```@example 2
using QuantitativeMRIColors
using QMRIColors
cmap = relaxationColorMap("T1")
VIEW(x,c=cmap) # Do not use range limits here!
```
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
JLD = "4138dd39-2aa7-5051-a626-17a0bb65d9c8"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
PythonPlot = "274fc56d-3b97-40fa-a1cd-1b4a50311bf9"
QuantitativeMRIColors = "2bec176e-9e8c-4764-a62f-295118d1ec05"
QMRIColors = "2bec176e-9e8c-4764-a62f-295118d1ec05"
12 changes: 6 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
using QuantitativeMRIColors
using QMRIColors
using Documenter

DocMeta.setdocmeta!(QuantitativeMRIColors, :DocTestSetup, :(using QuantitativeMRIColors); recursive=true)
DocMeta.setdocmeta!(QMRIColors, :DocTestSetup, :(using QMRIColors); recursive=true)

makedocs(;
modules=[QuantitativeMRIColors],
modules=[QMRIColors],
authors="aTrotier <[email protected]> and contributors",
sitename="QuantitativeMRIColors.jl",
sitename="QMRIColors.jl",
format=Documenter.HTML(;
canonical="https://magneticresonanceimaging.github.io/QuantitativeMRIColors.jl",
canonical="https://magneticresonanceimaging.github.io/QMRIColors.jl",
edit_link="main",
assets=String[],
),
Expand All @@ -22,6 +22,6 @@ makedocs(;
)

deploydocs(;
repo="github.com/MagneticResonanceImaging/QuantitativeMRIColors.jl",
repo="github.com/MagneticResonanceImaging/QMRIColors.jl",
devbranch="main",
)
2 changes: 1 addition & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
```

```@autodocs
Modules = [QuantitativeMRIColors]
Modules = [QMRIColors]
```
4 changes: 2 additions & 2 deletions docs/src/clip.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The "imclip" image should retain the distinction between the "invalid" value of
A simplified processing can be done by

```julia
using QuantitativeMRIColors
using QMRIColors
cmap = relaxationColorMap("T1")
VIEW(x,c=cmap) # Do not use range limits here!
```
Expand All @@ -23,7 +23,7 @@ Let's build an example to see the effect.
## Create a Synthetic phantom

```@example clip
using QuantitativeMRIColors
using QMRIColors
using CairoMakie
# ----- Make test object: gradually increasing T1, but invalid outside a circle
Expand Down
2 changes: 1 addition & 1 deletion docs/src/colormaps.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# qMRI colormaps

```@example 1
using QuantitativeMRIColors
using QMRIColors
using CairoMakie
```

Expand Down
8 changes: 4 additions & 4 deletions docs/src/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Download sample used in the following example
```@example 3
using FileIO
using Downloads
using QuantitativeMRIColors
using QMRIColors
using CairoMakie
url = "https://github.com/mfuderer/colorResources/raw/refs/heads/main/sampleT1map.jld"
Expand All @@ -25,7 +25,7 @@ nothing # hide
For `Makie.jl` the colormap can be directly used like `heatmap(x,colormap=cmap,colorrange=(loLev,upLev))`

```@example 3
using QuantitativeMRIColors
using QMRIColors
using CairoMakie
# ----- Make test object: gradually increasing T1, but invalid outside a circle
Expand Down Expand Up @@ -69,7 +69,7 @@ end
Using GR backend

```@example 3
using QuantitativeMRIColors
using QMRIColors
using Plots #GR backend
loLev = 700
Expand All @@ -90,7 +90,7 @@ The colormap needs to be converted to a usable format with the following command

```@example 4
using FileIO
using QuantitativeMRIColors
using QMRIColors
x = FileIO.load("sampleT1map.jld")["sampleT1map"]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```@meta
CurrentModule = QuantitativeMRIColors
CurrentModule = QMRIColors
```

Documentation for [QuantitativeMRIColors](https://github.com/magneticresonanceimaging/QuantitativeMRIColors.jl).
Documentation for [QMRIColors](https://github.com/magneticresonanceimaging/QMRIColors.jl).

# Introduction

Expand Down
4 changes: 2 additions & 2 deletions test/runtests.jl
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
using QuantitativeMRIColors
using QMRIColors
using Colors
using Test

@testset "QuantitativeMRIColors.jl" begin
@testset "QMRIColors.jl" begin

@testset "colormap" begin
# T1 test
Expand Down

0 comments on commit 2363488

Please sign in to comment.