diff --git a/README.rst b/README.rst index 79e08a4..76ebf8e 100644 --- a/README.rst +++ b/README.rst @@ -194,7 +194,7 @@ API Usage .. |build_travis| image:: https://img.shields.io/travis/com/hahnec/color-matcher?style=square :target: https://travis-ci.com/github/hahnec/color-matcher -.. |build_github| image:: https://img.shields.io/github/workflow/status/hahnec/color-matcher/ColorMatcher's%20CI%20Pipeline/master?style=square +.. |build_github| image:: https://img.shields.io/github/actions/workflow/status/hahnec/color-matcher/gh_actions.yml?branch=master&style=square :target: https://github.com/hahnec/color-matcher/actions :alt: GitHub Workflow Status diff --git a/docs/build/html/apidoc.html b/docs/build/html/apidoc.html index 7483b93..5f69693 100644 --- a/docs/build/html/apidoc.html +++ b/docs/build/html/apidoc.html @@ -61,7 +61,7 @@
The main function is the high-level entry point performing the mapping based on instantiation arguments.
Transfer function to map colors based on provided transfer method.
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
method (str
) – (‘default’, ‘hm’, ‘reinhard’, ‘mvgd’, ‘mkl’, ‘hm-mvgd-hm’, ‘hm-mkl-hm’) determining color mapping
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
method (str
) – (‘default’, ‘hm’, ‘reinhard’, ‘mvgd’, ‘mkl’, ‘hm-mvgd-hm’, ‘hm-mkl-hm’) determining color mapping
This function conducts channel-wise histogram matching which is invariant of image resolutions, but requires the same number of color channels in both images.
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
res (ndarray
) – Resulting image after the mapping
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
res (ndarray
) – Resulting image after the mapping
An analytical solution to the linear equation system of Multi-Variate Gaussian Distributions (MVGDs).
Transfer function to map colors based on for Multi-Variate Gaussian Distributions (MVGDs).
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
fun – Optional argument to pass a transfer function to solve for covariance matrices
res (ndarray
) – Resulting image after the mapping
res (ndarray
) – Resulting image after the mapping
Wasserstein-2 distance metric is a similarity measure for Gaussian distributions
mu_a (ndarray
) – Gaussian mean of distribution a
mu_b (ndarray
) – Gaussian mean of distribution b
cov_a (ndarray
) – Covariance matrix of distribution a
cov_b (ndarray
) – Covariance matrix of distribution b
mu_a (ndarray
) – Gaussian mean of distribution a
mu_b (ndarray
) – Gaussian mean of distribution b
cov_a (ndarray
) – Covariance matrix of distribution a
cov_b (ndarray
) – Covariance matrix of distribution b
scalar: Wasserstein-2 metric as a scalar
Wasserstein-2 image distance metric is a similarity measure for Gaussian distributions
This function conducts color matching based on the principles proposed by Reinhard et al. The paper of the original work can be found at https://www.cs.tau.ac.il/~turkel/imagepapers/ColorTransfer.pdf
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
res (ndarray
) – Resulting image after the mapping
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
res (ndarray
) – Resulting image after the mapping
Convert RGB color space to monochromatic color space
Bases: object
Bases: object
Convert RGB color space to monochromatic color space
This function conducts channel-wise histogram matching which is invariant of image resolutions, but requires the same number of color channels in both images.
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
res (ndarray
) – Resulting image after the mapping
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
res (ndarray
) – Resulting image after the mapping
An analytical solution to the linear equation system of Multi-Variate Gaussian Distributions (MVGDs).
Transfer function to map colors based on for Multi-Variate Gaussian Distributions (MVGDs).
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
fun – Optional argument to pass a transfer function to solve for covariance matrices
res (ndarray
) – Resulting image after the mapping
res (ndarray
) – Resulting image after the mapping
Wasserstein-2 distance metric is a similarity measure for Gaussian distributions
mu_a (ndarray
) – Gaussian mean of distribution a
mu_b (ndarray
) – Gaussian mean of distribution b
cov_a (ndarray
) – Covariance matrix of distribution a
cov_b (ndarray
) – Covariance matrix of distribution b
mu_a (ndarray
) – Gaussian mean of distribution a
mu_b (ndarray
) – Gaussian mean of distribution b
cov_a (ndarray
) – Covariance matrix of distribution a
cov_b (ndarray
) – Covariance matrix of distribution b
scalar: Wasserstein-2 metric as a scalar
Wasserstein-2 image distance metric is a similarity measure for Gaussian distributions
Bases: object
Bases: object
The main function is the high-level entry point performing the mapping based on instantiation arguments.
Transfer function to map colors based on provided transfer method.
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
method (str
) – (‘default’, ‘hm’, ‘reinhard’, ‘mvgd’, ‘mkl’, ‘hm-mvgd-hm’, ‘hm-mkl-hm’) determining color mapping
src (ndarray
) – Source image that requires transfer
ref (ndarray
) – Palette image which serves as reference
method (str
) – (‘default’, ‘hm’, ‘reinhard’, ‘mvgd’, ‘mkl’, ‘hm-mvgd-hm’, ‘hm-mkl-hm’) determining color mapping
color_matcher
color_matcher
Photograph
Film sequence
Light-field correction
Paintings