conversions.rgb_hsv_conversion
==============================

.. py:module:: conversions.rgb_hsv_conversion

.. autoapi-nested-parse::

   The RGB color model is an additive color model in which red, green, and blue light
   are added together in various ways to reproduce a broad array of colors. The name
   of the model comes from the initials of the three additive primary colors, red,
   green, and blue. Meanwhile, the HSV representation models how colors appear under
   light. In it, colors are represented using three components: hue, saturation and
   (brightness-)value. This file provides functions for converting colors from one
   representation to the other.

   (description adapted from https://en.wikipedia.org/wiki/RGB_color_model and
   https://en.wikipedia.org/wiki/HSL_and_HSV).



Functions
---------

.. autoapisummary::

   conversions.rgb_hsv_conversion.approximately_equal_hsv
   conversions.rgb_hsv_conversion.hsv_to_rgb
   conversions.rgb_hsv_conversion.rgb_to_hsv


Module Contents
---------------

.. py:function:: approximately_equal_hsv(hsv_1: list[float], hsv_2: list[float]) -> bool

   Utility-function to check that two hsv-colors are approximately equal

   >>> approximately_equal_hsv([0, 0, 0], [0, 0, 0])
   True
   >>> approximately_equal_hsv([180, 0.5, 0.3], [179.9999, 0.500001, 0.30001])
   True
   >>> approximately_equal_hsv([0, 0, 0], [1, 0, 0])
   False
   >>> approximately_equal_hsv([180, 0.5, 0.3], [179.9999, 0.6, 0.30001])
   False


.. py:function:: hsv_to_rgb(hue: float, saturation: float, value: float) -> list[int]

   Conversion from the HSV-representation to the RGB-representation.
   Expected RGB-values taken from
   https://www.rapidtables.com/convert/color/hsv-to-rgb.html

   >>> hsv_to_rgb(0, 0, 0)
   [0, 0, 0]
   >>> hsv_to_rgb(0, 0, 1)
   [255, 255, 255]
   >>> hsv_to_rgb(0, 1, 1)
   [255, 0, 0]
   >>> hsv_to_rgb(60, 1, 1)
   [255, 255, 0]
   >>> hsv_to_rgb(120, 1, 1)
   [0, 255, 0]
   >>> hsv_to_rgb(240, 1, 1)
   [0, 0, 255]
   >>> hsv_to_rgb(300, 1, 1)
   [255, 0, 255]
   >>> hsv_to_rgb(180, 0.5, 0.5)
   [64, 128, 128]
   >>> hsv_to_rgb(234, 0.14, 0.88)
   [193, 196, 224]
   >>> hsv_to_rgb(330, 0.75, 0.5)
   [128, 32, 80]


.. py:function:: rgb_to_hsv(red: int, green: int, blue: int) -> list[float]

   Conversion from the RGB-representation to the HSV-representation.
   The tested values are the reverse values from the hsv_to_rgb-doctests.
   Function "approximately_equal_hsv" is needed because of small deviations due to
   rounding for the RGB-values.

   >>> approximately_equal_hsv(rgb_to_hsv(0, 0, 0), [0, 0, 0])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(255, 255, 255), [0, 0, 1])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(255, 0, 0), [0, 1, 1])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(255, 255, 0), [60, 1, 1])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(0, 255, 0), [120, 1, 1])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(0, 0, 255), [240, 1, 1])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(255, 0, 255), [300, 1, 1])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(64, 128, 128), [180, 0.5, 0.5])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(193, 196, 224), [234, 0.14, 0.88])
   True
   >>> approximately_equal_hsv(rgb_to_hsv(128, 32, 80), [330, 0.75, 0.5])
   True