pth_new_surface: Create luminance-hue surface

View source: R/surface.R

pth_new_surfaceR Documentation

Create luminance-hue surface

Description

Create luminance-hue surface

Usage

pth_new_surface(colors, route = c("short", "long"), n_step = 30, ...)

## Default S3 method:
pth_new_surface(colors, route = c("short", "long"), n_step = 30, ...)

## S3 method for class 'character'
pth_new_surface(
  colors,
  route = c("short", "long"),
  n_step = 30,
  transformer = pth_to_cieluv,
  ...
)

## S3 method for class 'pth_mat'
pth_new_surface(colors, route = c("short", "long"), n_step = 30, ...)

Arguments

colors

character hex-codes, or matrix with object with S3 class pth_mat. Must have one or two elements.

route

character, indicates which direction to take around the circle; must be either "short" (default), or "long".

n_step

(double coerced to) integer number of steps to take along luminance domain to calculate maximum chroma.

...

other args, not used

transformer

function used to transform to a color space. Used if colors are hex-codes.

Value

Onject with S3 class pth_new_surface.


ijlyttle/colorpath documentation built on Sept. 13, 2022, 7:44 p.m.