Reel.Deal: Hue: add documentation

2020-07-03T07:08:27Z

Hue: add documentation

New page

{{FilterCat4|External_filters|Plugins|Adjustment_filters|Levels_and_Chroma_filters}}
{{Filter3
|1={{author/Wilbert Dijkhof}}
|2=v1.0
|3=[http://www.wilbertdijkhof.com/Hue_v10.zip Hue_v10.zip]
|4=Color Adjustment filters
|5=[http://www.gnu.org/licenses/gpl-2.0.txt GPLv2]
|6=[http://forum.doom9.org/showthread.php?s=&threadid=87439&pagenumber=2 Doom9 Forum]}}

== Description ==
This plugin is a port of Donald Graft's VirtualDub [http://rationalqm.us/hue.html Hue] filter.
<br>
<br>
== Requirements ==
* [x86]: [[AviSynth+]] or [https://sourceforge.net/projects/avisynth2/ AviSynth 2.5.8 or greater]
* Supported color formats: [[RGB24]], [[RGB32]]
* Requires progressive video
<br>

== [[Script variables|Syntax and Parameters]] ==

:{{Template:FuncDef|Hue (clip, float "hue", float "sat", float "intensity", string "channels")}}
<br>
::{{Par2| |clip| }}
:::Input clip, must be RGB.
<br>
::{{Par2|hue|float|0.0}}
:::The hue is the color flavor (restricted here to the ones listed in the <code>"channels"</code> parameter).

:::Example:
<div style="margin-left: 6em; max-width: 67em">
<pre>
# should change pixels with red hue into yellows, but it doesn't
ColorBars(300,200).ConvertToRGB32()
Hue(hue=60, channels="R")

# should rotate all six hue 60 degrees (thus red into yellow, yellow into green, green into cyan,
# cyan into blue, blue into magenta and magenta into red), but it doesn't
ColorBars(300,200).ConvertToRGB32()
Hue(hue=60, channels="RYGCBM")
</pre>
</div>
:::A pixel is called red if the hue of a pizel is red. It is defined here as follows:
:::*'''Assuming blue is the minimum''': around the color wheel we get red, yellow, green. red + green makes yellow. So it is broken up as 1/3, 1/3, 1/3. '''If g < 2/3 r then the hue of the pixel is red.''' If r < 2/3 g then the pixel is green. Else it is both, so it is yellow.
:::*'''Assuming green is the minimum''': around the color wheel we get red, magenta, blue. red + blue makes magenta. So it is broken up as 1/3, 1/3, 1/3. '''If b < 2/3 r then the hue of the pixel is red.''' If r < 2/3 b then the pixel is blue. Else it is both, so it is magenta.
:::The same holds for the hue of the other colors.
<br>
::{{Par2|sat|float|1.0}}
:::The saturation (sat) is the dominance of the hue in the color. It should be noted that this is NOT the same as the saturation in the HSV color format. Setting the saturation to zero converts the clip to (R,G,B) = (Y,Y,Y) where Y is the luminance (ie Y = 0.3086*R + 0.6094*G + 0.0820*B) of the clip [*]. Setting it to one leaves the clip untouched. For values inside [0,1] it just performs linear interpolation, and for values outside [0,1] it performs linear extrapolation.

:::Example:
<div style="margin-left: 6em; max-width: 67em">
<pre>
# decreases the red pixels of the clip to match the luminance
ColorBars(300,200).ConvertToRGB32()
Hue(sat=0, channels="R")

# doesn't do anything
ColorBars(300,200).ConvertToRGB32()
Hue(sat=1, channels="R")

# increases the red pixels of the clip to 255
ColorBars(300,200).ConvertToRGB32()
Hue(sat=1.5, channels="R")
</pre>
</div>
<br>
::{{Par2|intensity|float|1.0}}
:::The intensity indicates how light or dark a color is. Setting it to zero will decrease the red pixels (if you asked for the red color flavor) to black, and setting it to one will leave the clip untouched. Setting it higher than one will increase the red pixels to white.

:::'''[*]''' Usually the luminance is defined as Y = 0.299*R + 0.587*G + 0.114*B (using Rec.601 coefficients), but according [https://web.archive.org/web/20040825061928/http://www.sgi.com/misc/grafica/matrix/index.html Haeberli] the used transformation is better for linear RGB colors.
<br>
::{{Par2|channels|string|"RYGCBM"}}
:::The selectable color flavors: red (R), yellow (Y), green (G), cyan (C), blue (B), magenta (M) and combinations (GCM, etc.).
<br>
== Examples ==
Hue with default settings:
AviSource("blah.avi")
Hue(hue=0.0, sat=1.0, intensity=1.0, channels="RYGCBM")
<br>

== Changelog ==
Version Date Changes<br>
v1.0 2005/01/02 - initial release
<br>
== Archived Downloads ==
{| class="wikitable" border="1"; width="600px"
|-
!!width="100px"| Version
!!width="150px"| Download
!!width="150px"| Mirror
|-
!v1.0
|[http://www.wilbertdijkhof.com/Hue_v10.zip Hue_v10.zip]
|[https://web.archive.org/web/20180828081235if_/http://www.wilbertdijkhof.com/Hue_v10.zip Hue_v10.zip]
|}
<br>

==External Links ==
*[https://web.archive.org/web/20040825061928/http://www.sgi.com/misc/grafica/matrix/index.html Matrix Operations for Image Processing (by Haeberli)]: I guess this is the references where the used transformations are coming from. Graft link: Original VirtualDub version of this plugin.
<br>
<br>
-----------------------------------------------
'''Back to [[External_filters#Levels_and_Chroma|External Filters]] ←'''

Hue - Revision history

Reel.Deal: Hue: add documentation