Handle fixed-point Q0f colors by converting them to float (#29)

* Handle fixed-point colors by always converting them to float

* Fix only 'Q0f' colors

Author: eliascarv

Project.toml

@@ -7,6 +7,7 @@ version = "1.0.1"
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
 
 [weakdeps]
 CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
@@ -24,5 +25,6 @@ ColorSchemes = "3.24"
 Colors = "0.12, 0.13"
 Dates = "1.9"
 Distributions = "0.25"
+FixedPointNumbers = "0.8"
 Unitful = "1.19"
 julia = "1.9"

src/Colorfy.jl

@@ -6,6 +6,7 @@ module Colorfy
 
 using Colors
 using ColorSchemes
+using FixedPointNumbers
 using Dates
 
 export Colorfier, colorfy
@@ -32,12 +33,13 @@ struct Colorfier{V,A,S,R}
   colorrange::R
 end
 
-Colorfier(
-  values;
-  alphas=defaultalphas(values),
-  colorscheme=defaultcolorscheme(values),
-  colorrange=defaultcolorrange(values)
-) = Colorfier(values, asalphas(alphas, values), ascolorscheme(colorscheme), ascolorrange(colorrange))
+function Colorfier(values; alphas=nothing, colorscheme=nothing, colorrange=nothing)
+  values′ = asvalues(values)
+  alphas′ = isnothing(alphas) ? defaultalphas(values′) : alphas
+  colorscheme′ = isnothing(colorscheme) ? defaultcolorscheme(values′) : colorscheme
+  colorrange′ = isnothing(colorrange) ? defaultcolorrange(values′) : colorrange
+  Colorfier(values′, asalphas(alphas′, values′), ascolorscheme(colorscheme′), ascolorrange(colorrange′))
+end
 
 """
     colorfy(values; kwargs...)
@@ -131,6 +133,18 @@ Default color range for `values`.
 """
 defaultcolorrange(_) = :extrema
 
+"""
+    Colorfy.asvalues(values)
+
+Valid color values for a given `values`.
+"""
+asvalues(values) = values
+asvalues(values::Values{Colorant}) = values
+asvalues(values::Values{Colorant{Q0f7}}) = fixcolors(values)
+asvalues(values::Values{Colorant{Q0f15}}) = fixcolors(values)
+asvalues(values::Values{Colorant{Q0f31}}) = fixcolors(values)
+asvalues(values::Values{Colorant{Q0f63}}) = fixcolors(values)
+
 """
     Colorfy.asalphas(alphas, values)
 
@@ -228,6 +242,8 @@ end
 # HELPER FUNCTIONS
 # -----------------
 
+fixcolors(colors) = convert.(floattype(eltype(colors)), colors)
+
 nonmissingvec(x::AbstractVector{T}) where {T} = convert(AbstractVector{nonmissingtype(T)}, x)
 
 function genvec(vecinds, vec, valinds, val, len)

test/Project.toml

@@ -5,5 +5,6 @@ Colorfy = "03fe91ce-8ec6-4610-8e8d-e7491ccca690"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
+FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

test/runtests.jl

@@ -1,6 +1,7 @@
 using Colorfy
 using Colors
 using ColorSchemes
+using FixedPointNumbers
 using CategoricalArrays
 using Distributions
 using Unitful
@@ -16,6 +17,51 @@ using Test
     @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
     @test Colorfy.colorrange(colorfier) == :extrema
 
+    colors = [Gray(rand()) for _ in 1:10]
+    colorfier = Colorfier(colors)
+    @test eltype(Colorfy.values(colorfier)) <: Gray
+    @test eltype(eltype(Colorfy.values(colorfier))) <: AbstractFloat
+    @test Colorfy.values(colorfier) == colors
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == :extrema
+
+    colors = [Gray(rand(Q0f7)) for _ in 1:10]
+    colorfier = Colorfier(colors)
+    @test eltype(Colorfy.values(colorfier)) <: Gray
+    @test eltype(eltype(Colorfy.values(colorfier))) <: AbstractFloat
+    @test Colorfy.values(colorfier) == colors
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == :extrema
+
+    colors = [Gray(rand(Q0f15)) for _ in 1:10]
+    colorfier = Colorfier(colors)
+    @test eltype(Colorfy.values(colorfier)) <: Gray
+    @test eltype(eltype(Colorfy.values(colorfier))) <: AbstractFloat
+    @test Colorfy.values(colorfier) == colors
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == :extrema
+
+    colors = [Gray(rand(Q0f31)) for _ in 1:10]
+    colorfier = Colorfier(colors)
+    @test eltype(Colorfy.values(colorfier)) <: Gray
+    @test eltype(eltype(Colorfy.values(colorfier))) <: AbstractFloat
+    @test Colorfy.values(colorfier) == colors
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == :extrema
+
+    colors = [Gray(rand(Q0f63)) for _ in 1:10]
+    colorfier = Colorfier(colors)
+    @test eltype(Colorfy.values(colorfier)) <: Gray
+    @test eltype(eltype(Colorfy.values(colorfier))) <: AbstractFloat
+    @test Colorfy.values(colorfier) == colors
+    @test Colorfy.alphas(colorfier) == fill(1, 10)
+    @test Colorfy.colorscheme(colorfier) == colorschemes[:viridis]
+    @test Colorfy.colorrange(colorfier) == :extrema
+
     colorfier = Colorfier(values, alphas=0.5)
     @test Colorfy.values(colorfier) == values
     @test Colorfy.alphas(colorfier) == fill(0.5, 10)