From fce08bd489fc1e0a5398c0f8791dcd939f5a7947 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Fri, 29 Nov 2024 12:36:42 +0000 Subject: [PATCH] build based on 9a9c44c --- dev/.documenter-siteinfo.json | 2 +- dev/api/index.html | 2 +- dev/example/{5d571616.svg => 7b1c85aa.svg} | 72 +++++++++---------- dev/example/index.html | 4 +- ...{index-83c21cb7.svg => index-0ef751ff.svg} | 4 +- ...{index-61c6b957.svg => index-2e360e4b.svg} | 4 +- ...{index-8577490c.svg => index-9461aae4.svg} | 4 +- ...{index-4262d00c.svg => index-c6105247.svg} | 4 +- dev/index.html | 8 +-- 9 files changed, 52 insertions(+), 52 deletions(-) rename dev/example/{5d571616.svg => 7b1c85aa.svg} (96%) rename dev/{index-83c21cb7.svg => index-0ef751ff.svg} (99%) rename dev/{index-61c6b957.svg => index-2e360e4b.svg} (99%) rename dev/{index-8577490c.svg => index-9461aae4.svg} (99%) rename dev/{index-4262d00c.svg => index-c6105247.svg} (99%) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 31993a5..06577f1 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-25T19:00:44","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-29T12:36:39","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index b006181..617c87e 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,2 +1,2 @@ -API · qMRIColors.jl
GitHub
qMRIColors.colorLogRemap — Function
colorLogRemap(oriCmap, loLev=0.0, upLev=size(cmap)[1])

Applies logarithmic scaling to oriCmap based on loLev and upLev.

Arguments

  • oriCmap: Original colormap array.
  • loLev: Lower bound of the color range.
  • upLev: Upper bound of the color range.

Returns

  • logCmap: Colormap with logarithmic scaling applied.
source
qMRIColors.relaxationColorMap — Function
relaxationColorMap(maptype::AbstractString, x::AbstractArray, loLev=minimum(x), upLev=maximum(x))

Applies a color mapping to a numerical array x based on a specified relaxation map type. Reads color data from a CSV file and adjusts values in x to provide a color-coded visualization.

This function is commonly used in data visualization, especially for MRI relaxation maps, to display data in a color-coded format for easier interpretation.

Arguments

  • maptype::AbstractString: The relaxation map type to use for color mapping. Common values include "T1", "T2", "R1", "R2", (see documentation).
  • x::AbstractArray: An array of numerical values to be color-mapped.
  • loLev: Lower bound for color mapping. Defaults to the minimum of x.
  • upLev: Upper bound for color mapping. Defaults to the maximum of x.

Returns

  • rgb_vec: A vector of RGB colors representing the mapped values.
  • xClip: A modified version of x with values adjusted based on loLev and upLev.

Description

  1. Calls read_map_csv(maptype) to load the colormap.
  2. Adjusts x based on loLev and upLev to produce xClip.
  3. Maps values to colors using colorLogRemap and converts to RGB.
source
qMRIColors.relaxationColorMap — Function
relaxationColorMap(maptype::AbstractString, loLev=0, upLev=256)

Simplified variant of the above function. Only generates the RGB vector of colors without modifying an array x.

source
+API · qMRIColors.jl
GitHub
qMRIColors.colorLogRemap — Function
colorLogRemap(oriCmap, loLev=0.0, upLev=size(cmap)[1])

Applies logarithmic scaling to oriCmap based on loLev and upLev.

Arguments

  • oriCmap: Original colormap array.
  • loLev: Lower bound of the color range.
  • upLev: Upper bound of the color range.

Returns

  • logCmap: Colormap with logarithmic scaling applied.
source
qMRIColors.relaxationColorMap — Function
relaxationColorMap(maptype::AbstractString, x::AbstractArray, loLev=minimum(x), upLev=maximum(x))

Applies a color mapping to a numerical array x based on a specified relaxation map type. Reads color data from a CSV file and adjusts values in x to provide a color-coded visualization.

This function is commonly used in data visualization, especially for MRI relaxation maps, to display data in a color-coded format for easier interpretation.

Arguments

  • maptype::AbstractString: The relaxation map type to use for color mapping. Common values include "T1", "T2", "R1", "R2", (see documentation).
  • x::AbstractArray: An array of numerical values to be color-mapped.
  • loLev: Lower bound for color mapping. Defaults to the minimum of x.
  • upLev: Upper bound for color mapping. Defaults to the maximum of x.

Returns

  • rgb_vec: A vector of RGB colors representing the mapped values.
  • xClip: A modified version of x with values adjusted based on loLev and upLev.

Description

  1. Calls read_map_csv(maptype) to load the colormap.
  2. Adjusts x based on loLev and upLev to produce xClip.
  3. Maps values to colors using colorLogRemap and converts to RGB.
source
qMRIColors.relaxationColorMap — Function
relaxationColorMap(maptype::AbstractString, loLev=0, upLev=256)

Simplified variant of the above function. Only generates the RGB vector of colors without modifying an array x.

source
diff --git a/dev/example/5d571616.svg b/dev/example/7b1c85aa.svg similarity index 96% rename from dev/example/5d571616.svg rename to dev/example/7b1c85aa.svg index 741a52a..5856ae2 100644 --- a/dev/example/5d571616.svg +++ b/dev/example/7b1c85aa.svg @@ -1,41 +1,41 @@ - + - + - + - + - + - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - + - + - - - - - - - - - - + + + + + + + + + + diff --git a/dev/example/index.html b/dev/example/index.html index e27344e..657d986 100644 --- a/dev/example/index.html +++ b/dev/example/index.html @@ -44,7 +44,7 @@ c=cmap, clim=(loLev,upLev), yflip=true - )Example block output

PythonPlot.jl / PyPlot.jl

The colormap needs to be converted to a usable format with the following command : cmap_py = PythonPlot.ColorMap("relaxationColor", cmap, length(cmap), 1.0) 

using FileIO
+            )
Example block output

PythonPlot.jl / PyPlot.jl

The colormap needs to be converted to a usable format with the following command : cmap_py = PythonPlot.ColorMap("relaxationColor", cmap, length(cmap), 1.0) 

using FileIO
 using qMRIColors
 
 x = FileIO.load("sampleT1map.jld")["sampleT1map"]
@@ -59,4 +59,4 @@
 figure()
 imshow(imClip, vmin=loLev, vmax =upLev, interpolation="bicubic", cmap=cmap_py)
 colorbar()
-PythonPlot.savefig("plot.png")
Python: None

+PythonPlot.savefig("plot.png")
Python: None

diff --git a/dev/index-83c21cb7.svg b/dev/index-0ef751ff.svg similarity index 99% rename from dev/index-83c21cb7.svg rename to dev/index-0ef751ff.svg index f89c51c..207383e 100644 --- a/dev/index-83c21cb7.svg +++ b/dev/index-0ef751ff.svg @@ -5,12 +5,12 @@ width="180mm" height="25mm" viewBox="0 0 100 1" stroke="none" preserveAspectRatio="none" shape-rendering="crispEdges"> - - + diff --git a/dev/index-61c6b957.svg b/dev/index-2e360e4b.svg similarity index 99% rename from dev/index-61c6b957.svg rename to dev/index-2e360e4b.svg index ce77015..e1296be 100644 --- a/dev/index-61c6b957.svg +++ b/dev/index-2e360e4b.svg @@ -5,12 +5,12 @@ width="180mm" height="25mm" viewBox="0 0 100 1" stroke="none" preserveAspectRatio="none" shape-rendering="crispEdges"> - - + diff --git a/dev/index-8577490c.svg b/dev/index-9461aae4.svg similarity index 99% rename from dev/index-8577490c.svg rename to dev/index-9461aae4.svg index 9e96555..1bbce84 100644 --- a/dev/index-8577490c.svg +++ b/dev/index-9461aae4.svg @@ -5,12 +5,12 @@ width="180mm" height="25mm" viewBox="0 0 100 1" stroke="none" preserveAspectRatio="none" shape-rendering="crispEdges"> - - + diff --git a/dev/index-4262d00c.svg b/dev/index-c6105247.svg similarity index 99% rename from dev/index-4262d00c.svg rename to dev/index-c6105247.svg index 2b61801..026e571 100644 --- a/dev/index-4262d00c.svg +++ b/dev/index-c6105247.svg @@ -5,12 +5,12 @@ width="180mm" height="25mm" viewBox="0 0 100 1" stroke="none" preserveAspectRatio="none" shape-rendering="crispEdges"> - - + diff --git a/dev/index.html b/dev/index.html index 64f6ed3..6bef7f4 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,7 +1,7 @@ Home · qMRIColors.jl
GitHub

Documentation for qMRIColors.

Colormaps available

using qMRIColors
 using CairoMakie

Lipari

This colormap is used for :

  • T1
cmap = relaxationColorMap("T1")
-cgrad(cmap)
Example block output

This colormap is used for :

  • T2
  • T2*
  • T1rho
  • T1ρ
cmap = relaxationColorMap("T2")
-cgrad(cmap)
Example block output

Reverse lipari

This colormap is used for :

  • R1
cmap = relaxationColorMap("R1")
-cgrad(cmap)
Example block output

Reverse navia

This colormap is used for :

  • R2
  • R2*
  • R1rho
  • R1ρ
cmap = relaxationColorMap("R2")
-cgrad(cmap)
Example block output
+cgrad(cmap)Example block output

This colormap is used for :

  • T2
  • T2*
  • T1rho
  • T1ρ
cmap = relaxationColorMap("T2")
+cgrad(cmap)
Example block output

Reverse lipari

This colormap is used for :

  • R1
cmap = relaxationColorMap("R1")
+cgrad(cmap)
Example block output

Reverse navia

This colormap is used for :

  • R2
  • R2*
  • R1rho
  • R1ρ
cmap = relaxationColorMap("R2")
+cgrad(cmap)
Example block output