image_to_pallette: Develop a usable colour palette form an image.

In schemr: Convert Images to Usable Color Schemes

Develop a usable colour palette form an image.

Description

Develop a usable colour palette form an image.

Usage

image_to_pallette(
  image_path,
  resize_factor = NULL,
  colour_space = "sRGB",
  rgb_to_linear_func = NULL,
  rgb_to_nonlinear_func = NULL,
  method = "slic",
  superpixel = 200,
  compactness = 20,
  verbose = TRUE,
  s = negDistMat(r = 2),
  summary_method = mean,
  ...
)

Arguments

image_path	A character path to the image to cluster. Reads images of type .png, .jpeg, .jpg, .tiff.
resize_factor	A numeric scalar that reduces (or increases) the size of the image before any processing.
colour_space	The colour space of the original image. The clustering is undertaken in the Lab space. This is an an option in c("sRGB", "Adobe") for a built-in transformation or, alternatively, a custom 3x3 transformation matrix.
rgb_to_linear_func	The clustering is undertaken in the Lab space. This is a function to convert RGB colour space into linear RGB space. Used only if a custom transformation matrix is provided. Transformation skips if no function is provided under a user-defined transformation matrix. See: https://en.wikipedia.org/wiki/SRGB.
rgb_to_nonlinear_func	The clustering is undertaken in the Lab space. This is a function to convert linear RGB colour space into non-linear RGB space. Used only if a custom transformation matrix is provided. Transformation skips if no function is provided under a user-defined transformation matrix. See: https://en.wikipedia.org/wiki/SRGB.
method	From OpenImageR::superpixels. A character string specifying the method to use. Either "slic" or "slico".
superpixel	From OpenImageR::superpixels. A numeric value specifying the number of superpixels to use.
compactness	From OpenImageR::superpixels. A numeric value specifying the compactness parameter. The compactness parameter is needed only if method is "slic". The "slico" method adaptively chooses the compactness parameter for each superpixel differently.
verbose	From OpenImageR::superpixels. A boolean. If TRUE then information will be printed in the R session.
s	From apcluster::apcluster. An l x l similarity matrix or a similarity function either specified as the name of a package-provided similarity function as character string or a user provided function object. s may also be a sparse matrix according to the Matrix package. Internally, apcluster uses the dgTMatrix class; all other sparse matrices are cast to this class (if possible, otherwise the function quits with an error). If s is any other object of class Matrix, s is cast to a regular matrix internally (if possible, otherwise the function quits with an error).
summary_method	Function to summarise colours in clustered superpixels. Defaults to mean.
...	Other arguments to be passed to the apcluster algorithm. For the methods with signatures character,ANY and function,ANY, all other arguments are passed to the selected similarity function as they are; for the methods with signatures Matrix,missing and sparseMatrix,missing, further arguments are passed on to the apcluster methods with signatures Matrix,missing and dgTMatrix,missing, respectively.

Value

A schemr object containing colour scheme colours and image properties and clusters.

schemr documentation built on June 25, 2024, 9:07 a.m.