[gimp-help/gimp-help-2-10] Fix issue #74: Missing docs: new Waterpixels filter
- From: Jacob Boerema <jboerema src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp-help/gimp-help-2-10] Fix issue #74: Missing docs: new Waterpixels filter
- Date: Mon, 21 Mar 2022 22:42:11 +0000 (UTC)
commit d52f2cc2574166fba1e9bcee106cda7da44e61bc
Author: Jacob Boerema <jgboerema gmail com>
Date: Mon Mar 21 18:41:02 2022 -0400
Fix issue #74: Missing docs: new Waterpixels filter
(cherry picked from commit 6dc4d0b79d3d4e0780fb83c68fea06bbeef1b24f)
src/filters/artistic/waterpixels.xml | 37 ++++++++++++++++++++++++------------
1 file changed, 25 insertions(+), 12 deletions(-)
---
diff --git a/src/filters/artistic/waterpixels.xml b/src/filters/artistic/waterpixels.xml
index baebbbc17..120b9e4f8 100644
--- a/src/filters/artistic/waterpixels.xml
+++ b/src/filters/artistic/waterpixels.xml
@@ -2,7 +2,7 @@
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.docbook.org/xml/4.3/docbookx.dtd">
<!-- section history:
- 2019-01-24 j.h prepare skeleton. Fed up with options names and help popups
+ 2019-01-24 j.h prepare skeleton. Fed up with options names and help popups
referring directly to algorithm and not to wanted action.
-->
@@ -17,20 +17,26 @@ referring directly to algorithm and not to wanted action.
<indexterm>
<primary>Waterpixels</primary>
</indexterm>
-
+
<sect3>
<title>Overview</title>
<para>
- Superpixels based on the watershed transformation.
+ Waterpixels is a filter based on superpixels and the watershed
+ transformation. These algorithms are used to divide images in regions
+ with similar color values.
</para>
-
-
+ <note>
+ <para>
+ This filter can be slow to update on larger images.
+ </para>
+ </note>
+
</sect3>
-
+
<sect3>
<title>Activating the filter</title>
<para>
- This filter is found in the image window menu under
+ This filter can be found in the menu under
<menuchoice>
<guimenu>Filters</guimenu>
<guisubmenu>Artistic</guisubmenu>
@@ -38,7 +44,7 @@ referring directly to algorithm and not to wanted action.
</menuchoice>.
</para>
</sect3>
-
+
<sect3>
<title>Options</title>
<figure>
@@ -61,7 +67,8 @@ referring directly to algorithm and not to wanted action.
<term>Superpixels size</term>
<listitem>
<para>
- TODO
+ The size of the area used to pick a value from. Larger values means
+ you will get less color regions.
</para>
</listitem>
</varlistentry>
@@ -69,7 +76,8 @@ referring directly to algorithm and not to wanted action.
<term>Gradient smoothness</term>
<listitem>
<para>
- TODO
+ The smoothness of the gradient used in the computation. Higher
+ values have less irregular borders.
</para>
</listitem>
</varlistentry>
@@ -77,7 +85,9 @@ referring directly to algorithm and not to wanted action.
<term>Spatial regularization</term>
<listitem>
<para>
- TODO
+ Specifies how regular the regions should be. Low values are
+ irregular. The higher the value, the more the regions start
+ looking like squares.
</para>
</listitem>
</varlistentry>
@@ -85,7 +95,10 @@ referring directly to algorithm and not to wanted action.
<term>Superpixels color</term>
<listitem>
<para>
- TODO
+ This selects how to choose the color for each region. By default
+ <guilabel>Average</guilabel> is used. Which takes the average
+ color of the pixels in the region. The other option is
+ <guilabel>Random</guilabel>, which uses a random color.
</para>
</listitem>
</varlistentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]