The dufy Reference Manual

Table of Contents

The dufy Reference Manual

This is the dufy Reference Manual, version 0.4.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 11:42:51 2020 GMT+0.

1 Introduction

Dufy - Color Library for Common Lisp

Dufy is a library for exact color manipulation and conversion in various color spaces, which supports the following color models:

• RGB
• XYZ and xyY
• CIELAB and LChab
• CIELUV and LChuv
• HSV and HSL
• HSLuv and HPLuv
• Munsell Color System
• LMS
• spectrum (as spectral power distribution function)

Dufy can deal with the following concepts:

• Illuminant: A, B, C, D series, F series, etc. A new illuminant can be defined by white point or SPD.
• RGB space: sRGB, Adobe RGB, scRGB, etc. A new RGB space can be defined by primary coordinates, illuminant, method of gamma correction, bit per channel and other encoding characteristics.
• Observer (Color Matching Functions): CIE 1931 2° Standard Observer, CIE 1964 10°. Other observer model can be defined by color matching data.
• Color difference: ΔE*ab, CIE94, CIEDE2000, CMC l:c.
• Chromatic adaptaion transform: Bradford, Von Kries, etc. User-defined CAT is also available.

Documentation

Besides this README file, most of the documentation is written as docstrings in the source code. Quickdocs will be helpful to overview them. Some other information (e.g. changes between versions) is in github wiki.

Dependencies

• alexandria
• cl-ppcre

You can install all of the dependent libraries via quicklisp.

Install

The easiest way to install dufy is to use quicklisp:

* (ql:quickload :dufy)

The latest version in this repository can also be loaded with quicklisp:

$ cd ~/quicklisp/local-projects   # the path is held in ql:*local-project-directories*
$ git clone git@github.com:privet-kitty/dufy.git
$ sbcl   # , ccl, etc.

* (ql:register-local-projects)
* (ql:quickload :dufy)

If you want to load the ASDF system directly without quicklisp, you should put the directory of dufy to an appropriate location (e.g. ~/common-lisp/dufy/) and do (asdf:load-system :dufy).

Note that the master branch always coincides with the latest stable release. The develop branch is usually where development happens.

Basic Usage

rgba -- qrgba
qrgba -- rgbapack

xyz -- lab
lab -- lchab
xyz -- luv
luv -- lchuv
lchuv -- hsluv
lchuv -- hpluv
rgb -- hsv
rgb -- hsl

lchab -- mhvc  [ label = "(illuminant C)" ]
mhvc -- munsell

{ rank=same; rgb rgba }

} converter_tree

The fundamental color space of dufy is CIE XYZ (Illuminant D65): There are xyz-to- and -to-xyz converters for all other (connected) color spaces. Every converter function just receives numbers and returns multiple numbers:

(dufy:lab-to-xyz 87.07 -78.15 -20.51)  ; L*=87.07, a*=-78.15, b*=-20.51
;; => 0.3731544163010862d0 ; X
;;    0.701492216468595d0  ; Y
;;    1.0600774614243746d0 ; Z
   
(multiple-value-call #'dufy:xyz-to-qrgb
  (dufy:lab-to-xyz 87.07 -78.15 -20.51)
  :clamp nil)
;; => -169 ; R
;;    255  ; G
;;    255  ; B

(multiple-value-call #'dufy:xyz-to-qrgb
  (dufy:lab-to-xyz 87.07 -78.15 -20.51))
;; => 0    ; R
;;    255  ; G
;;    255  ; B

In the second example, a conversion from CIELAB to quantized RGB, xyz-to-qrgb returns a negative R value, which means the color is out of gamut; it is clamped in the third example.

Out of which gamut, however? By default, xyz-to-qrgb (and all other RGB converters) regard it as sRGB (D65). You can specify the RGB space explicitly:

(dufy:xyz-to-qrgb 0.37314 0.70144 1.0601 :rgbspace dufy:+srgb+ :clamp nil)  ; sRGB
;; => -169
;;    255
;;    255

(dufy:xyz-to-qrgb 0.37314 0.70144 1.0601 :rgbspace dufy:+adobe+ :clamp nil) ; Adobe RGB
;; => 2
;;    255
;;    255
   
(dufy:xyz-to-qrgb 0.37314 0.70144 1.0601 :rgbspace dufy:+bg-srgb-10+ :clamp nil) ; bg-sRGB (10 bit)
;; => 47
;;    893
;;    893
;; In the Adobe RGB space and bg-sRGB space the color is within gamut.

Likewise most converters regard the implicit illuminant as D65. You can also specify it explicitly:

(dufy:luv-to-xyz 100 0 0)                              ; Illuminant D65 
(dufy:luv-to-xyz 100 0 0 :illuminant dufy:+illum-d65+) ; Illuminant D65
;; => 0.9504692366968726d0
;;    1.0d0
;;    1.0889440678362423d0
;; the white point of standard illuminant D65

(dufy:luv-to-xyz 100 0 0 :illuminant dufy:+illum-e+)   ; Illuminant E
;; => 1.0d0
;;    1.0d0
;;    1.0000000000000004d0

Modules

Dufy consists of several independent modules:

• dufy
  • dufy/core
  • dufy/hsluv (HSLuv and HPLuv color spaces)
  • dufy/munsell (Munsell Color System)
• dufy/extra-data
• dufy/examples

Since the main package dufy contains slightly large colorimetric data, you may want to load dufy/core instead of dufy in some cases.

As of dufy 0.3.0, both the system names and the package names use the separator / instead of -, though the old package prefixes like dufy-core are left as nicknames.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 dufy

Author

Hugo I.

License

MIT

Description

Color library for Common Lisp

Version

0.4.1

Dependencies

• dufy/core (system)
• dufy/munsell (system)
• dufy/hsluv (system)

Source

dufy.asd (file)

Components

• dat (module)
• src (module)

2.2 dufy/munsell

Author

Hugo I.

License

MIT

Description

Munsell Color System

Dependencies

• dufy/core (system)
• cl-ppcre

Source

dufy.asd (file)

Component

munsell (module)

2.3 dufy/hsluv

Author

Hugo I.

License

MIT

Description

HSLuv and HPLuv color spaces

Dependency

dufy/core (system)

Source

dufy.asd (file)

Component

hsluv (module)

2.4 dufy/core

Author

Hugo I.

License

MIT

Dependencies

• alexandria
• dufy/internal (system)

Source

dufy.asd (file)

Component

core (module)

2.5 dufy/internal

Author

Hugo I.

License

MIT

Description

Common definitions not exported in the main package

Dependency

alexandria

Source

dufy.asd (file)

Component

internal (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 dufy/dat

Parent

dufy (system)

Location

dat/

Components

• ciede2000-test-data.csv (file)
• fl3.x.tsv (file)

3.2 dufy/src

Parent

dufy (system)

Location

src/

Component

package.lisp (file)

3.3 dufy/munsell/munsell

Parent

dufy/munsell (system)

Location

src/munsell/

Components

• package.lisp (file)
• y-to-value-data.lisp (file)
• renotation-data.lisp (file)
• inversed-renotation-data.lisp (file)
• fundamental.lisp (file)
• convert.lisp (file)
• invert.lisp (file)

3.4 dufy/hsluv/hsluv

Parent

dufy/hsluv (system)

Location

src/hsluv/

Components

• package.lisp (file)
• hsluv.lisp (file)

3.5 dufy/core/core

Parent

dufy/core (system)

Location

src/core/

Components

• package.lisp (file)
• cmf-data.lisp (file)
• spectrum.lisp (file)
• illuminants-data.lisp (file)
• xyz.lisp (file)
• rgb.lisp (file)
• lab-and-luv.lisp (file)
• cat.lisp (file)
• builtin-rgbspaces.lisp (file)
• deltae.lisp (file)

3.6 dufy/internal/internal

Parent

dufy/internal (system)

Location

src/internal/

Components

• package.lisp (file)
• utilities.lisp (file)
• arithmetic.lisp (file)
• matrix.lisp (file)
• colorspace.lisp (file)
• mb-line.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 dufy.asd

Location

dufy.asd

Systems

• dufy (system)
• dufy/munsell (system)
• dufy/hsluv (system)
• dufy/core (system)
• dufy/internal (system)

4.1.2 dufy/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

dufy

4.1.3 dufy/munsell/munsell/package.lisp

Parent

munsell (module)

Location

src/munsell/package.lisp

Packages

dufy/munsell

4.1.4 dufy/munsell/munsell/y-to-value-data.lisp

Parent

munsell (module)

Location

src/munsell/y-to-value-data.lisp

Internal Definitions

+y-to-munsell-value-table+ (special variable)

4.1.5 dufy/munsell/munsell/renotation-data.lisp

Parent

munsell (module)

Location

src/munsell/renotation-data.lisp

Internal Definitions

• +max-chroma-table+ (special variable)
• +max-chroma-table-dark+ (special variable)
• +mrd-table-ch+ (special variable)
• +mrd-table-ch-dark+ (special variable)
• +mrd-table-l+ (special variable)
• +mrd-table-l-dark+ (special variable)

4.1.6 dufy/munsell/munsell/inversed-renotation-data.lisp

Parent

munsell (module)

Location

src/munsell/inversed-renotation-data.lisp

Internal Definitions

• +inversed-mrd-table-hc+ (special variable)
• +inversed-mrd-table-v+ (special variable)

4.1.7 dufy/munsell/munsell/fundamental.lisp

Parent

munsell (module)

Location

src/munsell/fundamental.lisp

Exported Definitions

• *most-positive-non-large-double-float* (special variable)
• invalid-mhvc-error (condition)
• lstar-to-munsell-value (function)
• max-chroma-in-mrd (function)
• mhvc-out-of-mrd-p (function)
• mhvc-to-munsell (function)
• munsell-out-of-mrd-p (function)
• munsell-to-mhvc (function)
• munsell-value-to-lstar (function)
• munsell-value-to-y (function)
• munsellspec-parse-error (condition)
• non-negative-non-large-double-float (type)
• y-to-munsell-value (function)

Internal Definitions

• *bit-length-of-most-positive-fixnum* (special variable)
• cond-chroma (method)
• (setf cond-chroma) (method)
• cond-spec (method)
• (setf cond-spec) (method)
• cond-value (method)
• (setf cond-value) (method)
• evaluate-error-of-y-to-munsell-value (function)
• mhvc-invalid-p (function)
• qrgb-to-munsell-value (function)

4.1.8 dufy/munsell/munsell/convert.lisp

Parent

munsell (module)

Location

src/munsell/convert.lisp

Exported Definitions

• mhvc-to-lchab-illum-c (function)
• mhvc-to-xyz (function)
• mhvc-to-xyz-illum-c (function)
• munsell-to-lchab-illum-c (function)
• munsell-to-xyz (function)
• munsell-to-xyz-illum-c (function)

Internal Definitions

• c-to-d65 (function)
• calc-isochroma-ovoid (function)
• calc-isochroma-ovoid-integer-case (function)
• max-chroma-lchab (function)
• mhvc-to-lchab-all-integer-case (function)
• mhvc-to-lchab-general-case (function)
• mhvc-to-lchab-value-chroma-integer-case (function)
• mhvc-to-lchab-value-integer-case (function)
• mhvc-to-xyy (function)
• munsell-to-xyy (function)

4.1.9 dufy/munsell/munsell/invert.lisp

Parent

munsell (module)

Location

src/munsell/invert.lisp

Exported Definitions

• large-approximation-error (condition)
• lchab-to-mhvc-illum-c (function)
• lchab-to-munsell-illum-c (function)
• xyz-to-mhvc (function)
• xyz-to-mhvc-illum-c (function)
• xyz-to-munsell (function)
• xyz-to-munsell-illum-c (function)

Internal Definitions

• cartesian-to-mhvc (function)
• circular-delta (function)
• cond-message (method)
• (setf cond-message) (method)
• d65-to-c (function)
• invert-mhvc-to-lchab (function)
• lchab-to-mhvc-all-integer-case (function)
• lchab-to-mhvc-general-case (function)
• lchab-to-mhvc-l-c-integer-case (function)
• lchab-to-mhvc-l-integer-case (function)
• mhvc-to-cartesian (function)
• predict-lchab-to-mhvc (function)

4.1.10 dufy/hsluv/hsluv/package.lisp

Parent

hsluv (module)

Location

src/hsluv/package.lisp

Packages

dufy/hsluv

4.1.11 dufy/hsluv/hsluv/hsluv.lisp

Parent

hsluv (module)

Location

src/hsluv/hsluv.lisp

Exported Definitions

• hpluv-to-lchuv (function)
• hpluv-to-lrgb (function)
• hpluv-to-qrgb (function)
• hpluv-to-rgb (function)
• hpluv-to-rgbpack (function)
• hpluv-to-xyz (function)
• hsluv-to-lchuv (function)
• hsluv-to-lrgb (function)
• hsluv-to-qrgb (function)
• hsluv-to-rgb (function)
• hsluv-to-rgbpack (function)
• hsluv-to-xyz (function)
• lchuv-to-hpluv (function)
• lchuv-to-hsluv (function)
• lrgb-to-hpluv (function)
• lrgb-to-hsluv (function)
• qrgb-to-hpluv (function)
• qrgb-to-hsluv (function)
• rgb-to-hpluv (function)
• rgb-to-hsluv (function)
• rgbpack-to-hpluv (function)
• rgbpack-to-hsluv (function)
• xyz-to-hpluv (function)
• xyz-to-hsluv (function)

Internal Definitions

• +cieluv-epsilon+ (constant)
• +cieluv-kappa+ (constant)
• +m-bounds+ (constant)
• get-cieluv-bounds (function)
• max-chroma-for-lh (function)
• max-safe-chroma-for-l (function)

4.1.12 dufy/core/core/package.lisp

Parent

core (module)

Location

src/core/package.lisp

Packages

dufy/core

4.1.13 dufy/core/core/cmf-data.lisp

Parent

core (module)

Location

src/core/cmf-data.lisp

Internal Definitions

• +cmf-table-cie1931+ (special variable)
• +cmf-table-cie1964+ (special variable)

4.1.14 dufy/core/core/spectrum.lisp

Parent

core (module)

Location

src/core/spectrum.lisp

Exported Definitions

• +obs-cie1931+ (special variable)
• +obs-cie1964+ (special variable)
• approximate-spectrum (function)
• bb-spectrum (function)
• flat-spectrum (function)
• gen-illum-d-spectrum (function)
• gen-spectrum (function)
• illuminant (structure)
• illuminant-no-spd-p (function)
• illuminant-observer (function)
• (setf illuminant-observer) (function)
• illuminant-spectrum (function)
• (setf illuminant-spectrum) (function)
• illuminant-x (function)
• (setf illuminant-x) (function)
• illuminant-xy (function)
• illuminant-z (function)
• (setf illuminant-z) (function)
• make-illuminant (compiler macro)
• make-illuminant (function)
• make-observer (function)
• no-spd-error (condition)
• observer (structure)
• observer-begin-wl (function)
• (setf observer-begin-wl) (function)
• observer-cmf (function)
• (setf observer-cmf) (function)
• observer-cmf-x (function)
• (setf observer-cmf-x) (function)
• observer-cmf-y (function)
• (setf observer-cmf-y) (function)
• observer-cmf-z (function)
• (setf observer-cmf-z) (function)
• observer-end-wl (function)
• (setf observer-end-wl) (function)
• optimal-spectrum-peak (function)
• optimal-spectrum-trough (function)

Internal Definitions

• %make-illuminant (function)
• %make-observer (function)
• %spectrum-to-xyz (function)
• +s0-table+ (special variable)
• +s1-table+ (special variable)
• +s2-table+ (special variable)
• calc-to-spectrum-matrix (function)
• cond-illuminant (method)
• (setf cond-illuminant) (method)
• copy-observer (function)
• empty-spectrum (function)
• illuminant-p (function)
• illuminant-to-spectrum-matrix (function)
• (setf illuminant-to-spectrum-matrix) (function)
• make-illum-d-spectrum-array (function)
• observer-cmf-table (function)
• (setf observer-cmf-table) (function)
• observer-p (function)
• spectrum-function (type)

4.1.15 dufy/core/core/illuminants-data.lisp

Parent

core (module)

Location

src/core/illuminants-data.lisp

Exported Definitions

• +illum-a+ (special variable)
• +illum-c+ (special variable)
• +illum-d50+ (special variable)
• +illum-d65+ (special variable)
• +illum-e+ (special variable)

Internal Definitions

+illum-c-table+ (special variable)

4.1.16 dufy/core/core/xyz.lisp

Parent

core (module)

Location

src/core/xyz.lisp

Exported Definitions

• spectrum-to-xyz (function)
• xyy-to-xyz (function)
• xyz-to-spectrum (function)
• xyz-to-xyy (function)

4.1.17 dufy/core/core/rgb.lisp

Parent

core (module)

Location

src/core/rgb.lisp

Exported Definitions

• +srgb+ (special variable)
• delinearize (function)
• dequantize (function)
• gen-delinearizer (function)
• gen-linearizer (function)
• hsl-to-lrgb (function)
• hsl-to-qrgb (function)
• hsl-to-rgb (function)
• hsl-to-rgbpack (function)
• hsl-to-xyz (function)
• hsv-to-lrgb (function)
• hsv-to-qrgb (function)
• hsv-to-rgb (function)
• hsv-to-rgbpack (function)
• hsv-to-xyz (function)
• linearize (function)
• lrgb-out-of-gamut-p (function)
• lrgb-to-hsl (function)
• lrgb-to-hsv (function)
• lrgb-to-qrgb (function)
• lrgb-to-rgb (function)
• lrgb-to-rgbpack (function)
• lrgb-to-xyz (function)
• make-rgbspace (function)
• qrgb-out-of-gamut-p (function)
• qrgb-to-hsl (function)
• qrgb-to-hsv (function)
• qrgb-to-lrgb (function)
• qrgb-to-rgb (function)
• qrgb-to-rgbpack (function)
• qrgb-to-xyz (function)
• quantize (function)
• rgb-out-of-gamut-p (function)
• rgb-to-hsl (function)
• rgb-to-hsv (function)
• rgb-to-lrgb (function)
• rgb-to-qrgb (function)
• rgb-to-rgbpack (function)
• rgb-to-xyz (function)
• rgbpack-to-hsl (function)
• rgbpack-to-hsv (function)
• rgbpack-to-lrgb (function)
• rgbpack-to-qrgb (function)
• rgbpack-to-rgb (function)
• rgbpack-to-xyz (function)
• rgbspace (structure)
• rgbspace-bit-per-channel (function)
• (setf rgbspace-bit-per-channel) (function)
• rgbspace-delinearizer (function)
• (setf rgbspace-delinearizer) (function)
• rgbspace-from-xyz-matrix (function)
• (setf rgbspace-from-xyz-matrix) (function)
• rgbspace-illuminant (function)
• (setf rgbspace-illuminant) (function)
• rgbspace-linearizer (function)
• (setf rgbspace-linearizer) (function)
• rgbspace-lmax (function)
• (setf rgbspace-lmax) (function)
• rgbspace-lmin (function)
• (setf rgbspace-lmin) (function)
• rgbspace-max (function)
• (setf rgbspace-max) (function)
• rgbspace-min (function)
• (setf rgbspace-min) (function)
• rgbspace-normal (function)
• (setf rgbspace-normal) (function)
• rgbspace-qmax (function)
• (setf rgbspace-qmax) (function)
• rgbspace-to-xyz-matrix (function)
• (setf rgbspace-to-xyz-matrix) (function)
• rgbspace-xb (function)
• (setf rgbspace-xb) (function)
• rgbspace-xg (function)
• (setf rgbspace-xg) (function)
• rgbspace-xr (function)
• (setf rgbspace-xr) (function)
• rgbspace-yb (function)
• (setf rgbspace-yb) (function)
• rgbspace-yg (function)
• (setf rgbspace-yg) (function)
• rgbspace-yr (function)
• (setf rgbspace-yr) (function)
• xyz-to-hsl (function)
• xyz-to-hsv (function)
• xyz-to-lrgb (function)
• xyz-to-qrgb (function)
• xyz-to-rgb (function)
• xyz-to-rgbpack (function)

Internal Definitions

• %make-rgbspace (function)
• delinearize-srgb (function)
• linearize-srgb (function)
• qrgba-to-rgba (function)
• qrgba-to-rgbapack (function)
• rgba-to-qrgba (function)
• rgba-to-rgbapack (function)
• rgbapack-to-qrgba (function)
• rgbapack-to-rgba (function)
• rgbspace-/length (function)
• (setf rgbspace-/length) (function)
• rgbspace-length (function)
• (setf rgbspace-length) (function)
• rgbspace-length/qmax-float (function)
• (setf rgbspace-length/qmax-float) (function)
• rgbspace-p (function)
• rgbspace-qmax-float (function)
• (setf rgbspace-qmax-float) (function)
• rgbspace-qmax-float/length (function)
• (setf rgbspace-qmax-float/length) (function)

4.1.18 dufy/core/core/lab-and-luv.lisp

Parent

core (module)

Location

src/core/lab-and-luv.lisp

Exported Definitions

• lab-to-lchab (function)
• lab-to-xyz (function)
• lchab-to-lab (function)
• lchab-to-xyz (function)
• lchuv-to-luv (function)
• lchuv-to-xyz (function)
• lstar-to-y (function)
• luv-to-lchuv (function)
• luv-to-xyz (function)
• xyz-to-lab (function)
• xyz-to-lchab (function)
• xyz-to-lchuv (function)
• xyz-to-luv (function)

Internal Definitions

• calc-uvprime (function)
• calc-uvprime-from-xyz (function)
• function-f (function)
• lab-to-xyy (function)
• lchab-to-xyy (function)
• xyy-to-lab (function)
• xyy-to-lchab (function)
• y-to-lstar (function)

4.1.19 dufy/core/core/cat.lisp

Parent

core (module)

Location

src/core/cat.lisp

Exported Definitions

• +bradford+ (special variable)
• +cat02+ (special variable)
• +cat97s-revised+ (special variable)
• +cmccat2000+ (special variable)
• +cmccat97+ (special variable)
• +von-kries+ (special variable)
• +xyz-scaling+ (special variable)
• cat (structure)
• cat-inv-matrix (function)
• (setf cat-inv-matrix) (function)
• cat-matrix (function)
• (setf cat-matrix) (function)
• copy-rgbspace (function)
• define-cat-function (macro)
• gen-cat-function (function)
• gen-rgbspace-changer (function)
• lms-to-xyz (function)
• make-cat (function)
• xyz-to-lms (function)

Internal Definitions

• %make-cat (function)
• calc-cat-matrix (function)
• calc-cat-matrix-for-lrgb (function)
• cat-p (function)
• copy-cat (function)

4.1.20 dufy/core/core/builtin-rgbspaces.lisp

Parent

core (module)

Location

src/core/builtin-rgbspaces.lisp

Exported Definitions

• +adobe+ (special variable)
• +adobe-16+ (special variable)
• +bg-srgb-10+ (special variable)
• +bg-srgb-12+ (special variable)
• +bg-srgb-16+ (special variable)
• +cie-rgb+ (special variable)
• +ntsc1953+ (special variable)
• +pal/secam+ (special variable)
• +prophoto+ (special variable)
• +prophoto-12+ (special variable)
• +prophoto-16+ (special variable)
• +scrgb-16+ (special variable)
• +scrgb-nl+ (special variable)
• +wide-gamut+ (special variable)

Internal Definitions

• delinearize-prophoto (function)
• delinearize-scrgb-nl (function)
• linearize-prophoto (function)
• linearize-scrgb-nl (function)

4.1.21 dufy/core/core/deltae.lisp

Parent

core (module)

Location

src/core/deltae.lisp

Exported Definitions

• lab-deltae00 (function)
• lab-deltae94 (function)
• lab-deltaeab (function)
• lab-deltaecmc (function)
• qrgb-deltae00 (function)
• qrgb-deltae94 (function)
• qrgb-deltaeab (function)
• qrgb-deltaecmc (function)
• xyz-deltae00 (function)
• xyz-deltae94 (function)
• xyz-deltaeab (function)
• xyz-deltaecmc (function)

4.1.22 dufy/internal/internal/package.lisp

Parent

internal (module)

Location

src/internal/package.lisp

Packages

dufy/internal

4.1.23 dufy/internal/internal/utilities.lisp

Parent

internal (module)

Location

src/internal/utilities.lisp

Exported Definitions

• *dat-dir-path* (special variable)
• call-with-profiling (function)
• dotimes-unroll (macro)
• internal-real-time-after-gc (macro)
• nlet (macro)
• print-make-array (function)
• time-after-gc (macro)
• time-median (macro)
• tuple (type)
• with-ensuring-type (macro)
• with-profiling (macro)

Internal Definitions

• array-to-list (function)
• internal-real-time (macro)

4.1.24 dufy/internal/internal/arithmetic.lisp

Parent

internal (module)

Location

src/internal/arithmetic.lisp

Exported Definitions

• +360/two-pi+ (constant)
• +two-pi/360+ (constant)
• circular-clamp (function)
• circular-lerp (function)
• circular-lerp-loose (function)
• circular-member (function)
• circular-nearer (function)
• degree-to-radian (function)
• nearly-equal (function)
• nearly-equal-values (macro)
• nearly<= (function)
• nearly= (function)
• pow (macro)
• radian-to-degree (function)
• square (function)
• two-pi (constant)

4.1.25 dufy/internal/internal/matrix.lisp

Parent

internal (module)

Location

src/internal/matrix.lisp

Exported Definitions

• +empty-matrix+ (special variable)
• +identity-matrix+ (special variable)
• invert-matrix (function)
• matrix33 (type)
• multiply-mat-mat (function)
• multiply-mat-vec (function)
• multiply-matrices (function)

Internal Definitions

determinant (function)

4.1.26 dufy/internal/internal/colorspace.lisp

Parent

internal (module)

Location

src/internal/colorspace.lisp

Exported Definitions

• colorspace (structure)
• defconverter (macro)
• defconverters (macro)
• define-colorspace (macro)
• define-functional (macro)
• define-primary-converter (macro)
• extend-functional (macro)
• functional (structure)
• primary-converter (structure)

Internal Definitions

• %make-functional (function)
• %make-primary-converter (function)
• *colorspace-table* (special variable)
• *functional-table* (special variable)
• *primary-converter-table* (special variable)
• add-functional (function)
• add-primary-converter (function)
• circularize (function)
• collect-aux-arg-names (function)
• collect-aux-args (function)
• collect-key-arg-key-names (function)
• collect-key-arg-names (function)
• collect-key-args (function)
• colorspace-arg-types (function)
• (setf colorspace-arg-types) (function)
• colorspace-args (function)
• (setf colorspace-args) (function)
• colorspace-documentation (function)
• (setf colorspace-documentation) (function)
• colorspace-name (function)
• (setf colorspace-name) (function)
• colorspace-neighbors (function)
• (setf colorspace-neighbors) (function)
• colorspace-p (function)
• colorspace-return-types (function)
• (setf colorspace-return-types) (function)
• colorspace= (function)
• contains-allow-other-keys-p (function)
• copy-colorspace (function)
• copy-functional (function)
• copy-primary-converter (function)
• copy-queue (function)
• dequeue (function)
• duplicate-aux-and-key-p (function)
• enqueue (function)
• ensure-colorspace-name (function)
• expand-conversion-form (function)
• find-colorspace (function)
• find-converter-path (function)
• find-duplicates (function)
• functional-allow-other-keys (function)
• (setf functional-allow-other-keys) (function)
• functional-aux-args (function)
• (setf functional-aux-args) (function)
• functional-colorspace (function)
• (setf functional-colorspace) (function)
• functional-dimension (function)
• (setf functional-dimension) (function)
• functional-fname (function)
• (setf functional-fname) (function)
• functional-key-args (function)
• (setf functional-key-args) (function)
• functional-p (function)
• functional-term (function)
• (setf functional-term) (function)
• gen-args (function)
• gen-aux-args (function)
• gen-converter-name (function)
• gen-key-args (function)
• gen-local-key-args (function)
• gen-passed-args (function)
• get-allow-other-keys (function)
• get-arg-types (function)
• get-args (function)
• get-aux-args (function)
• get-aux-names (function)
• get-functional (function)
• get-key-arg-key-names (function)
• get-key-arg-names (function)
• get-key-args (function)
• get-neighbors (function)
• (setf get-neighbors) (function)
• get-primary-converter (function)
• get-primary-converter-name (function)
• get-return-types (function)
• key-arg= (function)
• lambda-list= (function)
• let-converter (macro)
• make-colorspace (function)
• make-functional (function)
• make-primary-converter (function)
• make-queue (function)
• primary-converter-allow-other-keys (function)
• (setf primary-converter-allow-other-keys) (function)
• primary-converter-aux-args (function)
• (setf primary-converter-aux-args) (function)
• primary-converter-from-colorspace (function)
• (setf primary-converter-from-colorspace) (function)
• primary-converter-key-args (function)
• (setf primary-converter-key-args) (function)
• primary-converter-name (function)
• (setf primary-converter-name) (function)
• primary-converter-p (function)
• primary-converter-to-colorspace (function)
• (setf primary-converter-to-colorspace) (function)
• print-hash-table (function)
• queue (structure)
• queue-list (function)
• (setf queue-list) (function)
• queue-p (function)
• queue-tail (function)
• (setf queue-tail) (function)

4.1.27 dufy/internal/internal/mb-line.lisp

Parent

internal (module)

Location

src/internal/mb-line.lisp

Exported Definitions

• make-mb-line (function)
• mb-line-distance-from-origin (function)
• mb-line-ray-intersect-distance (function)

Internal Definitions

• copy-mb-line (function)
• mb-line (structure)
• mb-line-intercept (function)
• (setf mb-line-intercept) (function)
• mb-line-p (function)
• mb-line-slope (function)
• (setf mb-line-slope) (function)

4.2 Static

4.2.1 dufy/dat/ciede2000-test-data.csv

Parent

dat (module)

Location

dat/ciede2000-test-data.csv

4.2.2 dufy/dat/FL3.x.tsv

Parent

dat (module)

Location

dat/FL3.x.tsv

5 Packages

Packages are listed by definition order.

5.1 dufy

Source

package.lisp (file)

Use List

• dufy/hsluv
• dufy/munsell
• dufy/core

5.2 dufy/munsell

Source

package.lisp (file)

Nickname

dufy-munsell

Use List

• dufy/core
• dufy/internal
• cl-ppcre
• alexandria
• common-lisp

Used By List

dufy

Exported Definitions

• *most-positive-non-large-double-float* (special variable)
• invalid-mhvc-error (condition)
• large-approximation-error (condition)
• lchab-to-mhvc-illum-c (function)
• lchab-to-munsell-illum-c (function)
• lstar-to-munsell-value (function)
• max-chroma-in-mrd (function)
• mhvc-out-of-mrd-p (function)
• mhvc-to-lchab-illum-c (function)
• mhvc-to-munsell (function)
• mhvc-to-xyz (function)
• mhvc-to-xyz-illum-c (function)
• munsell-out-of-mrd-p (function)
• munsell-to-lchab-illum-c (function)
• munsell-to-mhvc (function)
• munsell-to-xyz (function)
• munsell-to-xyz-illum-c (function)
• munsell-value-to-lstar (function)
• munsell-value-to-y (function)
• munsellspec-parse-error (condition)
• non-negative-non-large-double-float (type)
• xyz-to-mhvc (function)
• xyz-to-mhvc-illum-c (function)
• xyz-to-munsell (function)
• xyz-to-munsell-illum-c (function)
• y-to-munsell-value (function)

Internal Definitions

• *bit-length-of-most-positive-fixnum* (special variable)
• +inversed-mrd-table-hc+ (special variable)
• +inversed-mrd-table-v+ (special variable)
• +max-chroma-table+ (special variable)
• +max-chroma-table-dark+ (special variable)
• +mrd-table-ch+ (special variable)
• +mrd-table-ch-dark+ (special variable)
• +mrd-table-l+ (special variable)
• +mrd-table-l-dark+ (special variable)
• +y-to-munsell-value-table+ (special variable)
• c-to-d65 (function)
• calc-isochroma-ovoid (function)
• calc-isochroma-ovoid-integer-case (function)
• cartesian-to-mhvc (function)
• circular-delta (function)
• cond-chroma (generic function)
• cond-chroma (method)
• (setf cond-chroma) (method)
• (setf cond-chroma) (generic function)
• cond-message (generic function)
• cond-message (method)
• (setf cond-message) (method)
• (setf cond-message) (generic function)
• cond-spec (generic function)
• cond-spec (method)
• (setf cond-spec) (method)
• (setf cond-spec) (generic function)
• cond-value (generic function)
• cond-value (method)
• (setf cond-value) (method)
• (setf cond-value) (generic function)
• d65-to-c (function)
• evaluate-error-of-y-to-munsell-value (function)
• invert-mhvc-to-lchab (function)
• lchab-to-mhvc-all-integer-case (function)
• lchab-to-mhvc-general-case (function)
• lchab-to-mhvc-l-c-integer-case (function)
• lchab-to-mhvc-l-integer-case (function)
• max-chroma-lchab (function)
• mhvc-invalid-p (function)
• mhvc-to-cartesian (function)
• mhvc-to-lchab-all-integer-case (function)
• mhvc-to-lchab-general-case (function)
• mhvc-to-lchab-value-chroma-integer-case (function)
• mhvc-to-lchab-value-integer-case (function)
• mhvc-to-xyy (function)
• munsell-to-xyy (function)
• predict-lchab-to-mhvc (function)
• qrgb-to-munsell-value (function)

5.3 dufy/hsluv

Source

package.lisp (file)

Use List

• dufy/core
• dufy/internal
• alexandria
• common-lisp

Used By List

dufy

Exported Definitions

• hpluv-to-lchuv (function)
• hpluv-to-lrgb (function)
• hpluv-to-qrgb (function)
• hpluv-to-rgb (function)
• hpluv-to-rgbpack (function)
• hpluv-to-xyz (function)
• hsluv-to-lchuv (function)
• hsluv-to-lrgb (function)
• hsluv-to-qrgb (function)
• hsluv-to-rgb (function)
• hsluv-to-rgbpack (function)
• hsluv-to-xyz (function)
• lchuv-to-hpluv (function)
• lchuv-to-hsluv (function)
• lrgb-to-hpluv (function)
• lrgb-to-hsluv (function)
• qrgb-to-hpluv (function)
• qrgb-to-hsluv (function)
• rgb-to-hpluv (function)
• rgb-to-hsluv (function)
• rgbpack-to-hpluv (function)
• rgbpack-to-hsluv (function)
• xyz-to-hpluv (function)
• xyz-to-hsluv (function)

Internal Definitions

• +cieluv-epsilon+ (constant)
• +cieluv-kappa+ (constant)
• +m-bounds+ (constant)
• get-cieluv-bounds (function)
• max-chroma-for-lh (function)
• max-safe-chroma-for-l (function)

5.4 dufy/core

Source

package.lisp (file)

Nickname

dufy-core

Use List

• dufy/internal
• alexandria
• common-lisp

Used By List

• dufy
• dufy/hsluv
• dufy/munsell

Exported Definitions

• +adobe+ (special variable)
• +adobe-16+ (special variable)
• +bg-srgb-10+ (special variable)
• +bg-srgb-12+ (special variable)
• +bg-srgb-16+ (special variable)
• +bradford+ (special variable)
• +cat02+ (special variable)
• +cat97s-revised+ (special variable)
• +cie-rgb+ (special variable)
• +cmccat2000+ (special variable)
• +cmccat97+ (special variable)
• +illum-a+ (special variable)
• +illum-c+ (special variable)
• +illum-d50+ (special variable)
• +illum-d65+ (special variable)
• +illum-e+ (special variable)
• +ntsc1953+ (special variable)
• +obs-cie1931+ (special variable)
• +obs-cie1964+ (special variable)
• +pal/secam+ (special variable)
• +prophoto+ (special variable)
• +prophoto-12+ (special variable)
• +prophoto-16+ (special variable)
• +scrgb-16+ (special variable)
• +scrgb-nl+ (special variable)
• +srgb+ (special variable)
• +von-kries+ (special variable)
• +wide-gamut+ (special variable)
• +xyz-scaling+ (special variable)
• approximate-spectrum (function)
• bb-spectrum (function)
• cat (structure)
• cat-inv-matrix (function)
• (setf cat-inv-matrix) (function)
• cat-matrix (function)
• (setf cat-matrix) (function)
• copy-rgbspace (function)
• define-cat-function (macro)
• delinearize (function)
• dequantize (function)
• flat-spectrum (function)
• gen-cat-function (function)
• gen-delinearizer (function)
• gen-illum-d-spectrum (function)
• gen-linearizer (function)
• gen-rgbspace-changer (function)
• gen-spectrum (function)
• hsl-to-lrgb (function)
• hsl-to-qrgb (function)
• hsl-to-rgb (function)
• hsl-to-rgbpack (function)
• hsl-to-xyz (function)
• hsv-to-lrgb (function)
• hsv-to-qrgb (function)
• hsv-to-rgb (function)
• hsv-to-rgbpack (function)
• hsv-to-xyz (function)
• illuminant (structure)
• illuminant-no-spd-p (function)
• illuminant-observer (function)
• (setf illuminant-observer) (function)
• illuminant-spectrum (function)
• (setf illuminant-spectrum) (function)
• illuminant-x (function)
• (setf illuminant-x) (function)
• illuminant-xy (function)
• illuminant-z (function)
• (setf illuminant-z) (function)
• lab-deltae00 (function)
• lab-deltae94 (function)
• lab-deltaeab (function)
• lab-deltaecmc (function)
• lab-to-lchab (function)
• lab-to-xyz (function)
• lchab-to-lab (function)
• lchab-to-xyz (function)
• lchuv-to-luv (function)
• lchuv-to-xyz (function)
• linearize (function)
• lms-to-xyz (function)
• lrgb-out-of-gamut-p (function)
• lrgb-to-hsl (function)
• lrgb-to-hsv (function)
• lrgb-to-qrgb (function)
• lrgb-to-rgb (function)
• lrgb-to-rgbpack (function)
• lrgb-to-xyz (function)
• lstar-to-y (function)
• luv-to-lchuv (function)
• luv-to-xyz (function)
• make-cat (function)
• make-illuminant (compiler macro)
• make-illuminant (function)
• make-observer (function)
• make-rgbspace (function)
• no-spd-error (condition)
• observer (structure)
• observer-begin-wl (function)
• (setf observer-begin-wl) (function)
• observer-cmf (function)
• (setf observer-cmf) (function)
• observer-cmf-x (function)
• (setf observer-cmf-x) (function)
• observer-cmf-y (function)
• (setf observer-cmf-y) (function)
• observer-cmf-z (function)
• (setf observer-cmf-z) (function)
• observer-end-wl (function)
• (setf observer-end-wl) (function)
• optimal-spectrum-peak (function)
• optimal-spectrum-trough (function)
• qrgb-deltae00 (function)
• qrgb-deltae94 (function)
• qrgb-deltaeab (function)
• qrgb-deltaecmc (function)
• qrgb-out-of-gamut-p (function)
• qrgb-to-hsl (function)
• qrgb-to-hsv (function)
• qrgb-to-lrgb (function)
• qrgb-to-rgb (function)
• qrgb-to-rgbpack (function)
• qrgb-to-xyz (function)
• quantize (function)
• rgb-out-of-gamut-p (function)
• rgb-to-hsl (function)
• rgb-to-hsv (function)
• rgb-to-lrgb (function)
• rgb-to-qrgb (function)
• rgb-to-rgbpack (function)
• rgb-to-xyz (function)
• rgbpack-to-hsl (function)
• rgbpack-to-hsv (function)
• rgbpack-to-lrgb (function)
• rgbpack-to-qrgb (function)
• rgbpack-to-rgb (function)
• rgbpack-to-xyz (function)
• rgbspace (structure)
• rgbspace-bit-per-channel (function)
• (setf rgbspace-bit-per-channel) (function)
• rgbspace-delinearizer (function)
• (setf rgbspace-delinearizer) (function)
• rgbspace-from-xyz-matrix (function)
• (setf rgbspace-from-xyz-matrix) (function)
• rgbspace-illuminant (function)
• (setf rgbspace-illuminant) (function)
• rgbspace-linearizer (function)
• (setf rgbspace-linearizer) (function)
• rgbspace-lmax (function)
• (setf rgbspace-lmax) (function)
• rgbspace-lmin (function)
• (setf rgbspace-lmin) (function)
• rgbspace-max (function)
• (setf rgbspace-max) (function)
• rgbspace-min (function)
• (setf rgbspace-min) (function)
• rgbspace-normal (function)
• (setf rgbspace-normal) (function)
• rgbspace-qmax (function)
• (setf rgbspace-qmax) (function)
• rgbspace-to-xyz-matrix (function)
• (setf rgbspace-to-xyz-matrix) (function)
• rgbspace-xb (function)
• (setf rgbspace-xb) (function)
• rgbspace-xg (function)
• (setf rgbspace-xg) (function)
• rgbspace-xr (function)
• (setf rgbspace-xr) (function)
• rgbspace-yb (function)
• (setf rgbspace-yb) (function)
• rgbspace-yg (function)
• (setf rgbspace-yg) (function)
• rgbspace-yr (function)
• (setf rgbspace-yr) (function)
• spectrum-to-xyz (function)
• xyy-to-xyz (function)
• xyz-deltae00 (function)
• xyz-deltae94 (function)
• xyz-deltaeab (function)
• xyz-deltaecmc (function)
• xyz-to-hsl (function)
• xyz-to-hsv (function)
• xyz-to-lab (function)
• xyz-to-lchab (function)
• xyz-to-lchuv (function)
• xyz-to-lms (function)
• xyz-to-lrgb (function)
• xyz-to-luv (function)
• xyz-to-qrgb (function)
• xyz-to-rgb (function)
• xyz-to-rgbpack (function)
• xyz-to-spectrum (function)
• xyz-to-xyy (function)

Internal Definitions

• %make-cat (function)
• %make-illuminant (function)
• %make-observer (function)
• %make-rgbspace (function)
• %spectrum-to-xyz (function)
• +cmf-table-cie1931+ (special variable)
• +cmf-table-cie1964+ (special variable)
• +illum-c-table+ (special variable)
• +s0-table+ (special variable)
• +s1-table+ (special variable)
• +s2-table+ (special variable)
• calc-cat-matrix (function)
• calc-cat-matrix-for-lrgb (function)
• calc-to-spectrum-matrix (function)
• calc-uvprime (function)
• calc-uvprime-from-xyz (function)
• cat-p (function)
• cond-illuminant (generic function)
• cond-illuminant (method)
• (setf cond-illuminant) (method)
• (setf cond-illuminant) (generic function)
• copy-cat (function)
• copy-observer (function)
• delinearize-prophoto (function)
• delinearize-scrgb-nl (function)
• delinearize-srgb (function)
• empty-spectrum (function)
• function-f (function)
• illuminant-p (function)
• illuminant-to-spectrum-matrix (function)
• (setf illuminant-to-spectrum-matrix) (function)
• lab-to-xyy (function)
• lchab-to-xyy (function)
• linearize-prophoto (function)
• linearize-scrgb-nl (function)
• linearize-srgb (function)
• make-illum-d-spectrum-array (function)
• observer-cmf-table (function)
• (setf observer-cmf-table) (function)
• observer-p (function)
• qrgba-to-rgba (function)
• qrgba-to-rgbapack (function)
• rgba-to-qrgba (function)
• rgba-to-rgbapack (function)
• rgbapack-to-qrgba (function)
• rgbapack-to-rgba (function)
• rgbspace-/length (function)
• (setf rgbspace-/length) (function)
• rgbspace-length (function)
• (setf rgbspace-length) (function)
• rgbspace-length/qmax-float (function)
• (setf rgbspace-length/qmax-float) (function)
• rgbspace-p (function)
• rgbspace-qmax-float (function)
• (setf rgbspace-qmax-float) (function)
• rgbspace-qmax-float/length (function)
• (setf rgbspace-qmax-float/length) (function)
• spectrum-function (type)
• xyy-to-lab (function)
• xyy-to-lchab (function)
• y-to-lstar (function)

5.5 dufy/internal

Source

package.lisp (file)

Use List

• alexandria
• common-lisp

Used By List

• dufy/hsluv
• dufy/munsell
• dufy/core

Exported Definitions

• *dat-dir-path* (special variable)
• +360/two-pi+ (constant)
• +empty-matrix+ (special variable)
• +identity-matrix+ (special variable)
• +two-pi/360+ (constant)
• call-with-profiling (function)
• circular-clamp (function)
• circular-lerp (function)
• circular-lerp-loose (function)
• circular-member (function)
• circular-nearer (function)
• colorspace (structure)
• defconverter (macro)
• defconverters (macro)
• define-colorspace (macro)
• define-functional (macro)
• define-primary-converter (macro)
• degree-to-radian (function)
• dotimes-unroll (macro)
• extend-functional (macro)
• functional (structure)
• internal-real-time-after-gc (macro)
• invert-matrix (function)
• make-mb-line (function)
• matrix33 (type)
• mb-line-distance-from-origin (function)
• mb-line-ray-intersect-distance (function)
• multiply-mat-mat (function)
• multiply-mat-vec (function)
• multiply-matrices (function)
• nearly-equal (function)
• nearly-equal-values (macro)
• nearly<= (function)
• nearly= (function)
• nlet (macro)
• pow (macro)
• primary-converter (structure)
• print-make-array (function)
• radian-to-degree (function)
• square (function)
• time-after-gc (macro)
• time-median (macro)
• tuple (type)
• two-pi (constant)
• with-ensuring-type (macro)
• with-profiling (macro)

Internal Definitions

• %make-functional (function)
• %make-primary-converter (function)
• *colorspace-table* (special variable)
• *functional-table* (special variable)
• *primary-converter-table* (special variable)
• add-functional (function)
• add-primary-converter (function)
• array-to-list (function)
• circularize (function)
• collect-aux-arg-names (function)
• collect-aux-args (function)
• collect-key-arg-key-names (function)
• collect-key-arg-names (function)
• collect-key-args (function)
• colorspace-arg-types (function)
• (setf colorspace-arg-types) (function)
• colorspace-args (function)
• (setf colorspace-args) (function)
• colorspace-documentation (function)
• (setf colorspace-documentation) (function)
• colorspace-name (function)
• (setf colorspace-name) (function)
• colorspace-neighbors (function)
• (setf colorspace-neighbors) (function)
• colorspace-p (function)
• colorspace-return-types (function)
• (setf colorspace-return-types) (function)
• colorspace= (function)
• contains-allow-other-keys-p (function)
• copy-colorspace (function)
• copy-functional (function)
• copy-mb-line (function)
• copy-primary-converter (function)
• copy-queue (function)
• dequeue (function)
• determinant (function)
• duplicate-aux-and-key-p (function)
• enqueue (function)
• ensure-colorspace-name (function)
• expand-conversion-form (function)
• find-colorspace (function)
• find-converter-path (function)
• find-duplicates (function)
• functional-allow-other-keys (function)
• (setf functional-allow-other-keys) (function)
• functional-aux-args (function)
• (setf functional-aux-args) (function)
• functional-colorspace (function)
• (setf functional-colorspace) (function)
• functional-dimension (function)
• (setf functional-dimension) (function)
• functional-fname (function)
• (setf functional-fname) (function)
• functional-key-args (function)
• (setf functional-key-args) (function)
• functional-p (function)
• functional-term (function)
• (setf functional-term) (function)
• gen-args (function)
• gen-aux-args (function)
• gen-converter-name (function)
• gen-key-args (function)
• gen-local-key-args (function)
• gen-passed-args (function)
• get-allow-other-keys (function)
• get-arg-types (function)
• get-args (function)
• get-aux-args (function)
• get-aux-names (function)
• get-functional (function)
• get-key-arg-key-names (function)
• get-key-arg-names (function)
• get-key-args (function)
• get-neighbors (function)
• (setf get-neighbors) (function)
• get-primary-converter (function)
• get-primary-converter-name (function)
• get-return-types (function)
• internal-real-time (macro)
• key-arg= (function)
• lambda-list= (function)
• let-converter (macro)
• make-colorspace (function)
• make-functional (function)
• make-primary-converter (function)
• make-queue (function)
• mb-line (structure)
• mb-line-intercept (function)
• (setf mb-line-intercept) (function)
• mb-line-p (function)
• mb-line-slope (function)
• (setf mb-line-slope) (function)
• primary-converter-allow-other-keys (function)
• (setf primary-converter-allow-other-keys) (function)
• primary-converter-aux-args (function)
• (setf primary-converter-aux-args) (function)
• primary-converter-from-colorspace (function)
• (setf primary-converter-from-colorspace) (function)
• primary-converter-key-args (function)
• (setf primary-converter-key-args) (function)
• primary-converter-name (function)
• (setf primary-converter-name) (function)
• primary-converter-p (function)
• primary-converter-to-colorspace (function)
• (setf primary-converter-to-colorspace) (function)
• print-hash-table (function)
• queue (structure)
• queue-list (function)
• (setf queue-list) (function)
• queue-p (function)
• queue-tail (function)
• (setf queue-tail) (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Constants

Constant: +360/two-pi+

Package

dufy/internal

Source

arithmetic.lisp (file)

Constant: +two-pi/360+

Package

dufy/internal

Source

arithmetic.lisp (file)

Constant: two-pi

Package

dufy/internal

Source

arithmetic.lisp (file)

6.1.2 Special variables

Special Variable: *dat-dir-path*

Package

dufy/internal

Source

utilities.lisp (file)

Special Variable: *most-positive-non-large-double-float*

Package

dufy/munsell

Source

fundamental.lisp (file)

Special Variable: +adobe+

Adobe RGB (1998), 8-bit per channel

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +adobe-16+

Adobe RGB (1998), 16-bit per channel.

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +bg-srgb-10+

bg-sRGB, 10-bit per channel http://www.color.org/chardata/rgb/bgsrgb.xalter

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +bg-srgb-12+

bg-sRGB, 12-bit per channel, http://www.color.org/chardata/rgb/bgsrgb.xalter

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +bg-srgb-16+

bg-sRGB, 16-bit per channel, http://www.color.org/chardata/rgb/bgsrgb.xalter

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +bradford+

Package

dufy/core

Source

cat.lisp (file)

Special Variable: +cat02+

Note that the CAT function returned by (gen-cat-function ... :cat +cat02+) is different from the one in CIECAM02 since the latter is non-linear.

Package

dufy/core

Source

cat.lisp (file)

Special Variable: +cat97s-revised+

Fairchild, Mark D. (2001)."A Revision of CIECAM97s for Practical Applications" http://rit-mcsl.org/fairchild//PDFs/PAP10.pdf

Package

dufy/core

Source

cat.lisp (file)

Special Variable: +cie-rgb+

CIE RGB (1931), no gamma-correction, 8-bit per channel.

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +cmccat2000+

Package

dufy/core

Source

cat.lisp (file)

Special Variable: +cmccat97+

Package

dufy/core

Source

cat.lisp (file)

Special Variable: +empty-matrix+

Used instead of NIL

Package

dufy/internal

Source

matrix.lisp (file)

Special Variable: +identity-matrix+

Package

dufy/internal

Source

matrix.lisp (file)

Special Variable: +illum-a+

Package

dufy/core

Source

illuminants-data.lisp (file)

Special Variable: +illum-c+

Package

dufy/core

Source

illuminants-data.lisp (file)

Special Variable: +illum-d50+

Package

dufy/core

Source

illuminants-data.lisp (file)

Special Variable: +illum-d65+

Package

dufy/core

Source

illuminants-data.lisp (file)

Special Variable: +illum-e+

Package

dufy/core

Source

illuminants-data.lisp (file)

Special Variable: +ntsc1953+

NTSC RGB, Rec. ITU-R BT.470-6, System M, 8-bit per channel. http://www.itu.int/dms_pubrec/itu-r/rec/bt/R-REC-BT.470-6-199811-S!!PDF-E.pdf

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +obs-cie1931+

CIE 1931 Standard Colorimetric Observer (2-degree).

Package

dufy/core

Source

spectrum.lisp (file)

Special Variable: +obs-cie1964+

CIE 1964 Standard Colorimetric Observer (10-degree).

Package

dufy/core

Source

spectrum.lisp (file)

Special Variable: +pal/secam+

PAL/SECAM RGB, Rec. ITU-R BT.470-6, 8-bit per channel. http://www.itu.int/dms_pubrec/itu-r/rec/bt/R-REC-BT.470-6-199811-S!!PDF-E.pdf

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +prophoto+

Prophoto RGB (also known as ROMM RGB), 8-bit per channel, http://www.color.org/ROMMRGB.pdf

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +prophoto-12+

Prophoto RGB (also known as ROMM RGB), 12-bit per channel, http://www.color.org/ROMMRGB.pdf

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +prophoto-16+

Prophoto RGB (also known as ROMM RGB), 16-bit per channel, http://www.color.org/ROMMRGB.pdf

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +scrgb-16+

scRGB(16), IEC 61966-2-2:2003 http://www.color.org/chardata/rgb/scrgb.xalter

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +scrgb-nl+

scRGB-nl, IEC 61966-2-2:2003 http://www.color.org/chardata/rgb/scrgb-nl.xalter

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +srgb+

sRGB, 8-bit per channel

Package

dufy/core

Source

rgb.lisp (file)

Special Variable: +von-kries+

Package

dufy/core

Source

cat.lisp (file)

Special Variable: +wide-gamut+

Wide-gamut RGB, 8-bit per channel.

Package

dufy/core

Source

builtin-rgbspaces.lisp (file)

Special Variable: +xyz-scaling+

Package

dufy/core

Source

cat.lisp (file)

6.1.3 Macros

Macro: defconverter FROM-COLORSPACE TO-COLORSPACE &key NAME EXCLUDE-ARGS DOCUMENTATION

Generates and defines a converter function from FROM-COLORSPACE to TO-COLORSPACE automatically with linking primary converters.

These secondary converters are not inlined by default, different from primary converters. You can manually declare (inline <name>) to inline them. (Declared as sb-ext:maybe-inline on SBCL.)

Package

dufy/internal

Source

colorspace.lisp (file)

Macro: defconverters FROM-COLORSPACES TO-COLORSPACES &key EXCLUDE-ARGS

Generates and defines converter functions from each color space in FROM-COLORSPACES into each color space in TO-COLORSPACES.

Package

dufy/internal

Source

colorspace.lisp (file)

Macro: define-cat-function NAME FROM-ILLUMINANT TO-ILLUMINANT &key CAT

DEFINE-macro of GEN-CAT-FUNCTION. (define-cat-function d65-to-e +illum-d65+ +illum-e+) (d65-to-e 0.9504d0 1.0d0 1.0889d0)
;; => 0.9999700272441295d0
;; 0.999998887365445d0
;; 0.9999997282885571d0

Package

dufy/core

Source

cat.lisp (file)

Macro: define-colorspace NAME ARGS &key ARG-TYPES RETURN-TYPES DOCUMENTATION

Package

dufy/internal

Source

colorspace.lisp (file)

Macro: define-functional (FNAME COLORSPACE &key TERM) LAMBDA-LIST &body BODY

Package

dufy/internal

Source

colorspace.lisp (file)

Macro: define-primary-converter (FROM-COLORSPACE TO-COLORSPACE &key NAME) LAMBDA-LIST &body BODY

Defines FOO-TO-BAR function as a primary converter. Only &key arguments (without supplied-p-parameter) and &aux arguments are allowed.

Package

dufy/internal

Source

colorspace.lisp (file)

Macro: dotimes-unroll (VAR COUNT &optional RESULT) &body BODY

Package

dufy/internal

Source

utilities.lisp (file)

Macro: extend-functional TERM COLORSPACE &key FNAME EXCLUDE-ARGS DOCUMENTATION

Generates and defines a functional on another color space. The name of the function is [COLORSPACE]-[TERM] if FNAME is not given.

Package

dufy/internal

Source

colorspace.lisp (file)

Macro: internal-real-time-after-gc &body BODY

INTERNAL-REAL-TIME macro after GC

Package

dufy/internal

Source

utilities.lisp (file)

Macro: nearly-equal-values THRESHOLD &rest FORMS

Package

dufy/internal

Source

arithmetic.lisp (file)

Macro: nlet NAME ARGS &body BODY

Package

dufy/internal

Source

utilities.lisp (file)

Macro: pow BASE POWER

Does fast exponentiation by squaring. POWER must be a literal of type (integer 1).

Package

dufy/internal

Source

arithmetic.lisp (file)

Macro: time-after-gc &body BODY

TIME macro after GC

Package

dufy/internal

Source

utilities.lisp (file)

Macro: time-median NUM &body BODY

Repeats BODY NUM times and returns the median of elapsed (internal real) times.

Package

dufy/internal

Source

utilities.lisp (file)

Macro: with-ensuring-type TYPE VARS &body BODY

Ensures and declares that the type of variables are TYPE.

Package

dufy/internal

Source

utilities.lisp (file)

Macro: with-profiling NAMES &body BODY

Works only on SBCL.

Package

dufy/internal

Source

utilities.lisp (file)

6.1.4 Compiler macros

Compiler Macro: make-illuminant &key X Z SPECTRUM OBSERVER BEGIN-WL END-WL BAND COMPILE-TIME

Package

dufy/core

Source

spectrum.lisp (file)

6.1.5 Functions

Function: approximate-spectrum SPECTRUM &key BEGIN-WL END-WL BAND

Generates an approximate spectrum of SPECTRUM by pieacewise linearization. It is used to lighten a "heavy" spectrum function.

Package

dufy/core

Source

spectrum.lisp (file)

Function: bb-spectrum WAVELENGTH-NM &optional TEMPERATURE

Spectrum function of a blackbody. Note that it is not normalized.

Package

dufy/core

Source

spectrum.lisp (file)

Function: call-with-profiling NAMES FUNC

Works only on SBCL.

Package

dufy/internal

Source

utilities.lisp (file)

Function: cat-inv-matrix INSTANCE

Function: (setf cat-inv-matrix) VALUE INSTANCE

Package

dufy/core

Source

cat.lisp (file)

Function: cat-matrix INSTANCE

Function: (setf cat-matrix) VALUE INSTANCE

Package

dufy/core

Source

cat.lisp (file)

Function: circular-clamp NUMBER MIN MAX &optional PERIMETER

A clamp function in a circle group. If NUMBER is not in
the (counterclockwise) closed interval [MIN, MAX], CIRCULAR-CLAMP returns MIN or MAX whichever is nearer to NUMBER.

Package

dufy/internal

Source

arithmetic.lisp (file)

Function: circular-lerp COEF THETA1 THETA2 &optional PERIMETER

Counterclockwise linear interpolation from THETA1 to THETA2 in a circle group. It is guaranteed that the returned value doesn’t exceed the given interval from THETA1 to THETA2 if COEF is in [0, 1]. It is, however, slower than CIRCULAR-LERP-LOOSE.

Package

dufy/internal

Source

arithmetic.lisp (file)

Function: circular-lerp-loose COEF THETA1 THETA2 &optional PERIMETER

Counterclockwise linear interpolation from THETA1 to THETA2 in a circle group. There is a possibility that the returned value slightly exceeds the interval [THETA1, THETA2] due to floating-point error. If that is incovenient, you should use CIRCULAR-LERP instead.

Package

dufy/internal

Source

arithmetic.lisp (file)

Function: circular-member NUMBER THETA1 THETA2 &optional PERIMETER

Returns true if NUMBER is within the counterclockwise closed interval [THETA1, THETA2] in a circle group.

Package

dufy/internal

Source

arithmetic.lisp (file)

Function: circular-nearer THETA1 X THETA2 &optional PERIMETER

Compares the counterclockwise distances between THETA1 and X and between X and THETA2, and returns THETA1 or THETA2 whichever is nearer.

Package

dufy/internal

Source

arithmetic.lisp (file)

Function: copy-rgbspace RGBSPACE &key ILLUMINANT BIT-PER-CHANNEL CAT

Returns a new RGBSPACE with different standard illuminant and/or bit-per-channel. All the parameters are properly recalculated. If both are nil, it is just a copier.

Package

dufy/core

Source

cat.lisp (file)

Function: degree-to-radian DEGREE

Package

dufy/internal

Source

arithmetic.lisp (file)

Function: delinearize X &key RGBSPACE

Package

dufy/core

Source

rgb.lisp (file)

Function: dequantize N &key RGBSPACE

Dequantizes a QRGB value to an RGB value

Package

dufy/core

Source

rgb.lisp (file)

Function: flat-spectrum WAVELENGTH-NM

(constantly 1d0)

Package

dufy/core

Source

spectrum.lisp (file)

Function: gen-cat-function FROM-ILLUMINANT TO-ILLUMINANT &key CAT

Returns a chromatic adaptation function.
(funcall (gen-cat-function +illum-a+ +illum-e+) 0.9504d0 1.0d0 1.0889d0) => 0.9999700272441295d0
0.999998887365445d0
0.9999997282885571d0 ; transformed white point

Package

dufy/core

Source

cat.lisp (file)

Function: gen-delinearizer GAMMA

Returns a gamma-correction function for a given gamma value. You shouldn’t call the returned function directly as it is not safe. Use DELINEARIZE instead.

Package

dufy/core

Source

rgb.lisp (file)

Function: gen-illum-d-spectrum TEMPERATURE &key RECTIFY

Generates the spectrum of the illuminant series D for a given
temperature (from 300 nm to 830 nm with band-width 1 nm). If RECTIFY is true, the temperature multiplied by 1.4388/1.438 is used instead. (roughly 6504K for 6500K, etc.)

Package

dufy/core

Source

spectrum.lisp (file)

Function: gen-linearizer GAMMA

Returns a linearization function for a given gamma value. You shouldn’t call the returned function directly as it is not safe. Use LINEARIZE instead.

Package

dufy/core

Source

rgb.lisp (file)

Function: gen-rgbspace-changer FROM-RGBSPACE TO-RGBSPACE &key TARGET CAT

Returns a function for changing RGB working space.

(funcall (gen-rgbspace-changer +srgb+ +adobe+ :target :rgb) 0 1 0) ;; => 0.5649506908657044d0
;; 1.0d0
;; 0.2344342037422755d0
;; change from sRGB to Adobe RGB.

TARGET ::= :LRGB | :RGB | :QRGB | :RGBPACK

Note about clamping:
LRGB case: no clamping;
RGB case: no clamping;
QRGB case: with clamping;
RGBPACK case: with clamping.

Package

dufy/core

Source

cat.lisp (file)

Function: gen-spectrum SPECTRUM-SEQ &optional BEGIN-WL END-WL

GEN-SPECTRUM returns a spectral power distribution
function, #’(lambda (wavelength-nm) ...), which interpolates SPECTRUM-SEQ linearly.

Note: SPECTRUM-SEQ must be a sequence of double-float. If the type of SPECTRUM-SEQ is (simple-array double-float (*)), it is not copied but referenced, otherwise it is copied by (coerce spectrum-seq ’(simple-array double-float (*))).

Package

dufy/core

Source

spectrum.lisp (file)

Function: hpluv-to-lchuv HUV PSAT LSTAR

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hpluv-to-lrgb HUV PSAT LSTAR &key RGBSPACE &aux ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hpluv-to-qrgb HUV PSAT LSTAR &key RGBSPACE CLAMP &aux ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hpluv-to-rgb HUV PSAT LSTAR &key RGBSPACE &aux ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hpluv-to-rgbpack HUV PSAT LSTAR &key RGBSPACE &aux ILLUMINANT CLAMP

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hpluv-to-xyz HUV PSAT LSTAR &key ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsl-to-lrgb HUE SAT LUM &key RGBSPACE

Package

dufy/core

Source

rgb.lisp (file)

Function: hsl-to-qrgb HUE SAT LUM &key RGBSPACE CLAMP

Package

dufy/core

Source

rgb.lisp (file)

Function: hsl-to-rgb HUE SAT LUM

Non-normal RGB space is also accepted, though it depends on the situation whether the returned values are meaningful.

Package

dufy/core

Source

rgb.lisp (file)

Function: hsl-to-rgbpack HUE SAT LUM &key RGBSPACE &aux CLAMP

Package

dufy/core

Source

rgb.lisp (file)

Function: hsl-to-xyz HUE SAT LUM &key RGBSPACE &aux ILLUMINANT

Package

dufy/core

Source

rgb.lisp (file)

Function: hsluv-to-lchuv HUV SAT LSTAR

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsluv-to-lrgb HUV SAT LSTAR &key RGBSPACE &aux ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsluv-to-qrgb HUV SAT LSTAR &key RGBSPACE CLAMP &aux ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsluv-to-rgb HUV SAT LSTAR &key RGBSPACE &aux ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsluv-to-rgbpack HUV SAT LSTAR &key RGBSPACE &aux ILLUMINANT CLAMP

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsluv-to-xyz HUV SAT LSTAR &key ILLUMINANT

Package

dufy/hsluv

Source

hsluv.lisp (file)

Function: hsv-to-lrgb HUE SAT VAL &key RGBSPACE

Package

dufy/core

Source

rgb.lisp (file)

Function: hsv-to-qrgb HUE SAT VAL &key RGBSPACE CLAMP

Package

dufy/core

Source

rgb.lisp (file)

Function: hsv-to-rgb HUE SAT VAL

Non-normal RGB space is also accepted, though it depends on the situation whether the returned values are meaningful.

Package

dufy/core

Source

rgb.lisp (file)

Function: hsv-to-rgbpack HUE SAT VAL &key RGBSPACE &aux CLAMP

Package

dufy/core

Source

rgb.lisp (file)

Function: hsv-to-xyz HUE SAT VAL &key RGBSPACE &aux ILLUMINANT

Package

dufy/core

Source

rgb.lisp (file)

Function: illuminant-no-spd-p ILLUMINANT

Package

dufy/core

Source

spectrum.lisp (file)

Function: illuminant-observer INSTANCE

Function: (setf illuminant-observer) VALUE INSTANCE

Package

dufy/core

Source

spectrum.lisp (file)

Function: illuminant-spectrum INSTANCE

Function: (setf illuminant-spectrum) VALUE INSTANCE

Package

dufy/core

Source

spectrum.lisp (file)

Function: illuminant-x INSTANCE

Function: (setf illuminant-x) VALUE INSTANCE

Package

dufy/core

Source

spectrum.lisp (file)

Function: illuminant-xy ILLUMINANT

Returns the xy chromacity coordinates of a given illuminant.

Package

dufy/core

Source

spectrum.lisp (file)

Function: illuminant-z INSTANCE

Function: (setf illuminant-z) VALUE INSTANCE

Package

dufy/core

Source

spectrum.lisp (file)

Function: invert-matrix MAT

Package

dufy/internal

Source

matrix.lisp (file)

Function: lab-deltae00 L1 A1 B1 L2 A2 B2

CIEDE2000.

Tested with the test set by Sharma-Wu-Dalal. See "The CIEDE2000 Color-Difference Formula: Implementation Notes, Supplementary Test Data, and Mathematical Observations", 2004.

Package

dufy/core

Source

deltae.lisp (file)

Function: lab-deltae94 L1 A1 B1 L2 A2 B2 &key APPLICATION

CIE 1994.
APPLICATION ::= :graphic-arts | :textiles

Package

dufy/core

Source

deltae.lisp (file)

Function: lab-deltaeab L1 A1 B1 L2 A2 B2

CIE 1976. Euclidean distance in L*a*b* space.

Package

dufy/core

Source

deltae.lisp (file)

Function: lab-deltaecmc L1 A1 B1 L2 A2 B2 &key L-FACTOR C-FACTOR

CMC l:c

Package

dufy/core

Source

deltae.lisp (file)

Function: lab-to-lchab LSTAR ASTAR BSTAR

Package

dufy/core

Source

lab-and-luv.lisp (file)

Function: lab-to-xyz LSTAR ASTAR BSTAR &key ILLUMINANT

Package

dufy/core

Source

lab-and-luv.lisp (file)

Function: lchab-to-lab LSTAR CSTARAB HAB

Package

dufy/core

Source

lab-and-luv.lisp (file)

Function: lchab-to-mhvc-illum-c LSTAR CSTARAB HAB &key MAX-ITERATION IF-REACH-MAX FACTOR THRESHOLD &aux ILLUMINANT

Is an inverter of MHVC-TO-LCHAB-ILLUM-C with a simple iteration algorithm, which is almost same as the one in "An Open-Source Inversion Algorithm for the Munsell Renotation" by Paul Centore, 2011:

V := LSTAR-TO-MUNSELL-VALUE(L*);
C_0 := C*_ab / 5.5;
H_0 := h_ab / 9;
C_(n+1) := C_n + FACTOR * ΔC_n;
H_(n+1) := H_n + FACTOR * ΔH_n;

Δ(H_n) and Δ(C_n) are internally calculated at every step. This function returns Munsell HVC values if C_0 <= THRESHOLD or if V <= THRESHOLD or when max(Δ(H_n), Δ(C_n)) falls below THRESHOLD.

IF-REACH-MAX specifies the action to be taken if the loop reaches the MAX-ITERATION as follows:

:error: Error of type DUFY:LARGE-APPROXIMATION-ERROR is signaled. :return40: Three 40d0s are returned.
:raw: Just returns HVC as it is.

Package

dufy/munsell

Source

invert.lisp (file)

Function: lchab-to-munsell-illum-c LSTAR CSTARAB HAB &key MAX-ITERATION IF-REACH-MAX FACTOR THRESHOLD DIGITS &aux ILLUMINANT

Illuminant C

Package

dufy/munsell

Source

invert.lisp (file)

Function: lchab-to-xyz LSTAR CSTARAB HAB &key ILLUMINANT

Package

dufy/core

Source

lab-and-luv.lisp (file)

Function: lchuv-to-hpluv LSTAR CSTARUV HUV

Package

dufy/hsluv

Source

hsluv.lisp (file)