.. _eu.gmic.Morphologicalfilter:

G’MIC Morphological filter node
===============================

*This documentation is for version 1.0 of G’MIC Morphological filter.*

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

Wrapper for the G’MIC framework (http://gmic.eu) written by Tobias Fleischer (http://www.reduxfx.com) and Frederic Devernay.

Inputs
------

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

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                               |
+=================================================+=========+=====================+========================================+
| Action / ``Action``                             | Choice  | Erosion             | |                                      |
|                                                 |         |                     | | **Erosion**                          |
|                                                 |         |                     | | **Dilation**                         |
|                                                 |         |                     | | **Opening**                          |
|                                                 |         |                     | | **Closing**                          |
|                                                 |         |                     | | **Original - Erosion**               |
|                                                 |         |                     | | **Dilation - Original**              |
|                                                 |         |                     | | **Original - Opening**               |
|                                                 |         |                     | | **Closing - Original**               |
|                                                 |         |                     | | **Original - (Opening + Closing)/2** |
|                                                 |         |                     | | **Closing - Opening**                |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Kernel / ``Kernel``                             | Choice  | Square              | |                                      |
|                                                 |         |                     | | **Square**                           |
|                                                 |         |                     | | **Octagonal**                        |
|                                                 |         |                     | | **Circular**                         |
|                                                 |         |                     | | **Custom**                           |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Size / ``Size``                                 | Integer | 5                   |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Custom kernel / ``Custom_kernel``               | String  | 1,0,1; 0,1,0; 1,0,1 |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Negative / ``Negative``                         | Boolean | Off                 |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Process transparency / ``Process_transparency`` | Boolean | Off                 |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Channel(s) / ``Channels``                       | Choice  | All                 | |                                      |
|                                                 |         |                     | | **All**                              |
|                                                 |         |                     | | **RGBA [all]**                       |
|                                                 |         |                     | | **RGB [all]**                        |
|                                                 |         |                     | | **RGB [red]**                        |
|                                                 |         |                     | | **RGB [green]**                      |
|                                                 |         |                     | | **RGB [blue]**                       |
|                                                 |         |                     | | **RGBA [alpha]**                     |
|                                                 |         |                     | | **Linear RGB [all]**                 |
|                                                 |         |                     | | **Linear RGB [red]**                 |
|                                                 |         |                     | | **Linear RGB [green]**               |
|                                                 |         |                     | | **Linear RGB [blue]**                |
|                                                 |         |                     | | **YCbCr [luminance]**                |
|                                                 |         |                     | | **YCbCr [blue-red chrominances]**    |
|                                                 |         |                     | | **YCbCr [blue chrominance]**         |
|                                                 |         |                     | | **YCbCr [red chrominance]**          |
|                                                 |         |                     | | **YCbCr [green chrominance]**        |
|                                                 |         |                     | | **Lab [lightness]**                  |
|                                                 |         |                     | | **Lab [ab-chrominances]**            |
|                                                 |         |                     | | **Lab [a-chrominance]**              |
|                                                 |         |                     | | **Lab [b-chrominance]**              |
|                                                 |         |                     | | **Lch [ch-chrominances]**            |
|                                                 |         |                     | | **Lch [c-chrominance]**              |
|                                                 |         |                     | | **Lch [h-chrominance]**              |
|                                                 |         |                     | | **HSV [hue]**                        |
|                                                 |         |                     | | **HSV [saturation]**                 |
|                                                 |         |                     | | **HSV [value]**                      |
|                                                 |         |                     | | **HSI [intensity]**                  |
|                                                 |         |                     | | **HSL [lightness]**                  |
|                                                 |         |                     | | **CMYK [cyan]**                      |
|                                                 |         |                     | | **CMYK [magenta]**                   |
|                                                 |         |                     | | **CMYK [yellow]**                    |
|                                                 |         |                     | | **CMYK [key]**                       |
|                                                 |         |                     | | **YIQ [luma]**                       |
|                                                 |         |                     | | **YIQ [chromas]**                    |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Value action / ``Value_action``                 | Choice  | None                | |                                      |
|                                                 |         |                     | | **None**                             |
|                                                 |         |                     | | **Cut**                              |
|                                                 |         |                     | | **Stretch**                          |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Preview type / ``Preview_type``                 | Choice  | Full                | |                                      |
|                                                 |         |                     | | **Full**                             |
|                                                 |         |                     | | **Forward horizontal**               |
|                                                 |         |                     | | **Forward vertical**                 |
|                                                 |         |                     | | **Backward horizontal**              |
|                                                 |         |                     | | **Backward vertical**                |
|                                                 |         |                     | | **Duplicate top**                    |
|                                                 |         |                     | | **Duplicate left**                   |
|                                                 |         |                     | | **Duplicate bottom**                 |
|                                                 |         |                     | | **Duplicate right**                  |
|                                                 |         |                     | | **Duplicate horizontal**             |
|                                                 |         |                     | | **Duplicate vertical**               |
|                                                 |         |                     | | **Checkered**                        |
|                                                 |         |                     | | **Checkered inverse**                |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Preview split / ``Preview_split``               | Double  | x: 0.5 y: 0.5       |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Output Layer / ``Output_Layer``                 | Choice  | Layer 0             | |                                      |
|                                                 |         |                     | | **Merged**                           |
|                                                 |         |                     | | **Layer 0**                          |
|                                                 |         |                     | | **Layer -1**                         |
|                                                 |         |                     | | **Layer -2**                         |
|                                                 |         |                     | | **Layer -3**                         |
|                                                 |         |                     | | **Layer -4**                         |
|                                                 |         |                     | | **Layer -5**                         |
|                                                 |         |                     | | **Layer -6**                         |
|                                                 |         |                     | | **Layer -7**                         |
|                                                 |         |                     | | **Layer -8**                         |
|                                                 |         |                     | | **Layer -9**                         |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Resize Mode / ``Resize_Mode``                   | Choice  | Dynamic             | |                                      |
|                                                 |         |                     | | **Fixed (Inplace)**                  |
|                                                 |         |                     | | **Dynamic**                          |
|                                                 |         |                     | | **Downsample 1/2**                   |
|                                                 |         |                     | | **Downsample 1/4**                   |
|                                                 |         |                     | | **Downsample 1/8**                   |
|                                                 |         |                     | | **Downsample 1/16**                  |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Ignore Alpha / ``Ignore_Alpha``                 | Boolean | Off                 |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Preview/Draft Mode / ``PreviewDraft_Mode``      | Boolean | Off                 |                                        |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
| Log Verbosity / ``Log_Verbosity``               | Choice  | Off                 | |                                      |
|                                                 |         |                     | | **Off**                              |
|                                                 |         |                     | | **Level 1**                          |
|                                                 |         |                     | | **Level 2**                          |
|                                                 |         |                     | | **Level 3**                          |
+-------------------------------------------------+---------+---------------------+----------------------------------------+
