R: Convert between colour spaces

convert_colour {farver} | R Documentation

## Convert between colour spaces

### Description

This function lets you convert between different representations of colours. The API is reminiscent of `grDevices::convertColor()`, but the performance is much better. It is not assured that `grDevices::convertColor()` and `convert_colour()` provide numerically equivalent conversion at 16bit level as the formula used are potentially slightly different. For all intend and purpose, the resulting colours will be equivalent though.

### Usage

    convert_colour(colour, from, to, white_from = "D65",
      white_to = white_from)

### Arguments

`colour` | A numeric matrix (or an object coercible to one) with colours encoded in the rows and the different colour space values in the columns. For all colourspaces except `'cmyk'` this will mean a matrix with three columns - for `'cmyk'` it means four columns.
`from, to` | The input and output colour space. Allowed values are: `"cmy"`, `"cmyk"`, `"hsl"`, `"hsb"`, `"hsv"`, `"lab"` (CIE L*ab), `"hunterlab"` (Hunter Lab), `"lch"` (CIE Lch(ab) / polarLAB), `"luv"`, `"rgb"` (sRGB), `"xyz"`, `"yxy"` (CIE xyY), or `"hcl"` (CIE Lch(uv) / polarLuv)
`white_from, white_to` | The white reference of the from and to colour space. Will only have an effect for relative colour spaces such as Lab and luv. Any value accepted by `as_white_ref()` allowed.

### Value

A numeric matrix with the same number of rows as `colour` and either 3 or 4 columns depending on the value of `to`. If `colour` is given as a `data.frame` the output will be a data.frame as well

### Handling of non-finite and out of bounds values

`NA`, `NaN`, `-Inf`, and `Inf` are treated as invalid input and will result in `NA` values for the colour. If a given colourspace has finite bounds in some of their channels, the input will be capped before conversion, and the output will be capped before returning, so that both input and output colours are valid colours in their respective space. This means that converting back and forth between two colourspaces may result in a change in the colour if the gamut of one of the spaces is less than the other.

### Note

This function and `convertColor()` are not numerically equivalent due to rounding errors, but for all intend and purpose they give the same results.

### See Also

`grDevices::convertColor()`, `grDevices::col2rgb()`

### Examples

    spectrum <- decode_colour(rainbow(10))
    spec_lab <- convert_colour(spectrum, 'rgb', 'lab')
    spec_lab

    # Convert between different white references
    convert_colour(spec_lab, 'lab', 'lab', white_from = 'D65', white_to = 'F10')

[Package farver version 2.0.2 Index]