.. _net.sf.openfx.HueCorrect:

HueCorrect node
===============

.. raw:: html

   <!-- Do not edit this file! It is generated automatically by Natron itself. -->

|pluginIcon| 

*This documentation is for version 2.0 of HueCorrect (net.sf.openfx.HueCorrect).*

Description
-----------

Apply hue-dependent color adjustments using lookup curves.

Hue and saturation are computed from the the source RGB values. Depending on the hue value, the various adjustment values are computed, and then applied:

hue: hue shift.

sat: saturation gain. This modification is applied last.

lum: luminance gain

red: red gain

green: green gain

blue: blue gain

r_sup: red suppression. If r > min(g,b), r = min(g,b) + r_sup \* (r-min(g,b))

g_sup: green suppression

b_sup: blue suppression

sat_thrsh: if source saturation is below this value, do not apply the lum, red, green, blue gains. Above this value, apply gain progressively.

The ‘Luminance Mix’ parameter may be used to restore partially or fully the original luminance (luminance is computed using the ‘Luminance Math’ parameter).

See also: http://opticalenquiry.com/nuke/index.php?title=HueCorrect

Inputs
------

+--------+-------------+----------+
| Input  | Description | Optional |
+========+=============+==========+
| Source |             | No       |
+--------+-------------+----------+
| Mask   |             | Yes      |
+--------+-------------+----------+

Controls
--------

.. tabularcolumns:: |>{\raggedright}p{0.2\columnwidth}|>{\raggedright}p{0.06\columnwidth}|>{\raggedright}p{0.07\columnwidth}|p{0.63\columnwidth}|

.. cssclass:: longtable

+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter / script name                | Type       | Default                                                                              | Function                                                                                                                                         |
+========================================+============+======================================================================================+==================================================================================================================================================+
| Hue Curves / ``hue``                   | Parametric | hue:   sat:   lum:   red:   green:   blue:   r_sup:   g_sup:   b_sup:   sat_thrsh:   | | Hue-dependent adjustment lookup curves:                                                                                                        |
|                                        |            |                                                                                      | | hue: hue shift.                                                                                                                                |
|                                        |            |                                                                                      | | sat: saturation gain. This modification is applied last.                                                                                       |
|                                        |            |                                                                                      | | lum: luminance gain                                                                                                                            |
|                                        |            |                                                                                      | | red: red gain                                                                                                                                  |
|                                        |            |                                                                                      | | green: green gain                                                                                                                              |
|                                        |            |                                                                                      | | blue: blue gain                                                                                                                                |
|                                        |            |                                                                                      | | r_sup: red suppression. If r > min(g,b), r = min(g,b) + r_sup \* (r-min(g,b))                                                                  |
|                                        |            |                                                                                      | | g_sup: green suppression                                                                                                                       |
|                                        |            |                                                                                      | | b_sup: blue suppression                                                                                                                        |
|                                        |            |                                                                                      | | sat_thrsh: if source saturation is below this value, do not apply the lum, red, green, blue gains. Above this value, apply gain progressively. |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Hue Vs Hue Guide / ``huevshue``        | Boolean    | Off                                                                                  | Display a curve background guide designed for hue vs. hue tuning.                                                                                |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Luminance Math / ``luminanceMath``     | Choice     | Rec. 709                                                                             | | Formula used to compute luminance from RGB values (only used by ‘Set Master’).                                                                 |
|                                        |            |                                                                                      | | **Rec. 709 (rec709)**: Use Rec. 709 (0.2126r + 0.7152g + 0.0722b).                                                                             |
|                                        |            |                                                                                      | | **Rec. 2020 (rec2020)**: Use Rec. 2020 (0.2627r + 0.6780g + 0.0593b).                                                                          |
|                                        |            |                                                                                      | | **ACES AP0 (acesap0)**: Use ACES AP0 (0.3439664498r + 0.7281660966g + -0.0721325464b).                                                         |
|                                        |            |                                                                                      | | **ACES AP1 (acesap1)**: Use ACES AP1 (0.2722287168r + 0.6740817658g + 0.0536895174b).                                                          |
|                                        |            |                                                                                      | | **CCIR 601 (ccir601)**: Use CCIR 601 (0.2989r + 0.5866g + 0.1145b).                                                                            |
|                                        |            |                                                                                      | | **Average (average)**: Use average of r, g, b.                                                                                                 |
|                                        |            |                                                                                      | | **Max (max)**: Use max or r, g, b.                                                                                                             |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Clamp Black / ``clampBlack``           | Boolean    | Off                                                                                  | All colors below 0 on output are set to 0.                                                                                                       |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Clamp White / ``clampWhite``           | Boolean    | Off                                                                                  | All colors above 1 on output are set to 1.                                                                                                       |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| (Un)premult / ``premult``              | Boolean    | Off                                                                                  | Divide the image by the alpha channel before processing, and re-multiply it afterwards. Use if the input images are premultiplied.               |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Mix Luminance / ``mixLuminanceEnable`` | Boolean    | On                                                                                   | Mix luminance                                                                                                                                    |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|   / ``mixLuminance``                   | Double     | 0                                                                                    | Mix luminance                                                                                                                                    |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Invert Mask / ``maskInvert``           | Boolean    | Off                                                                                  | When checked, the effect is fully applied where the mask is 0.                                                                                   |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Mix / ``mix``                          | Double     | 1                                                                                    | Mix factor between the original and the transformed image.                                                                                       |
+----------------------------------------+------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

.. |pluginIcon| image:: net.sf.openfx.HueCorrect.png
   :width: 10.0%
