<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


## Subsections

 - [aktive query params](#query_params)
 - [aktive query setup](#query_setup)
 - [aktive query type](#query_type)

## Operators

---
### [↑](#top) <a name='format_as_d2'></a> aktive format as d2

Syntax: __aktive format as d2__ src [[→ definition](../../../../file?ci=trunk&ln=6&name=etc/sink/asother.tcl)]

Converts the internal DAG representation of the image into a D2 graph format and returns the resulting string.

Despite the naming the operator is __not strict__. It does not access the input's pixels at all, only the meta information of the pipeline.

    <td valign='top'><img src='example-00036.gif' alt='@2 (charcoal)' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 1)</td>
    <td valign='top'>&nbsp;# -\*- d2 -\*-<br>&nbsp;direction: left<br>&nbsp;1: "aktive read from netpbm\\n(path tests/assets/butterfly.ppm)"<br>&nbsp;1.shape: document<br>&nbsp;1.style.fill: lightgreen<br>&nbsp;2: "aktive op view\\n(port {-1 -1 382 252})"<br>&nbsp;2.shape: oval<br>&nbsp;1 -> 2<br>&nbsp;3: "aktive op tile max\\n(radius 1)"<br>&nbsp;3.shape: oval<br>&nbsp;2 -> 3<br>&nbsp;4: "aktive op view\\n(port {-1 -1 382 252})"<br>&nbsp;4.shape: oval<br>&nbsp;1 -> 4<br>&nbsp;5: "aktive op tile min\\n(radius 1)"<br>&nbsp;5.shape: oval<br>&nbsp;4 -> 5<br>&nbsp;6: "aktive op math sub"<br>&nbsp;6.shape: oval<br>&nbsp;3 -> 6<br>&nbsp;5 -> 6<br>&nbsp;7: "aktive op math1 invert"<br>&nbsp;7.shape: oval<br>&nbsp;6 -> 7<br>&nbsp;8: "aktive op math1 gamma expand"<br>&nbsp;8.shape: oval<br>&nbsp;7 -> 8<br>&nbsp;9: "aktive op color scRGB to Grey"<br>&nbsp;9.shape: oval<br>&nbsp;8 -> 9<br>&nbsp;10: "aktive op math1 scale\\n(factor 0.01)"<br>&nbsp;10.shape: oval<br>&nbsp;10.style.fill: orange<br>&nbsp;9 -> 10</td></tr>
</table>


---
### [↑](#top) <a name='format_as_markdown'></a> aktive format as markdown

Syntax: __aktive format as markdown__ src [[→ definition](../../../../file?ci=trunk&ln=6&name=etc/sink/asother.tcl)]

Converts the internal DAG representation of the image into a Markdown table and returns the resulting string.

Despite the naming the operator is __not strict__. It does not access the input's pixels at all, only the meta information of the pipeline.

    <td valign='top'><img src='example-00039.gif' alt='@2 (charcoal)' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 1)</td>
    <td valign='top'>&nbsp;||Id|Command|Config|Inputs|Notes|<br>&nbsp;|:---|:---|:---|:---|:---|:---|<br>&nbsp;|__FILE__|1|aktive read from netpbm|path tests/assets/butterfly.ppm||FO(2): 2, 4|<br>&nbsp;||2|aktive op view|port {-1 -1 382 252}|1||<br>&nbsp;||3|aktive op tile max|radius 1|2||<br>&nbsp;||4|aktive op view|port {-1 -1 382 252}|1||<br>&nbsp;||5|aktive op tile min|radius 1|4||<br>&nbsp;||6|aktive op math sub||3, 5||<br>&nbsp;||7|aktive op math1 invert||6||<br>&nbsp;||8|aktive op math1 gamma expand||7||<br>&nbsp;||9|aktive op color scRGB to Grey||8||<br>&nbsp;|__OUT__|10|aktive op math1 scale|factor 0.01|9||</td></tr>
</table>


---
### [↑](#top) <a name='format_as_tclscript'></a> aktive format as tclscript

Syntax: __aktive format as tclscript__ src [[→ definition](../../../../file?ci=trunk&ln=6&name=etc/sink/asother.tcl)]

Converts the internal DAG representation of the image into a Tcl script and returns the resulting string.

Despite the naming the operator is __not strict__. It does not access the input's pixels at all, only the meta information of the pipeline.

    <td valign='top'><img src='example-00042.gif' alt='@2 (charcoal)' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 1)</td>
    <td valign='top'>&nbsp;set file1 [aktive read from netpbm path tests/assets/butterfly.ppm]	;# FO(2): tmp2, tmp4<br>&nbsp;set tmp2 [aktive op view $file1 port {-1 -1 382 252}]<br>&nbsp;set tmp3 [aktive op tile max $tmp2 radius 1]<br>&nbsp;set tmp4 [aktive op view $file1 port {-1 -1 382 252}]<br>&nbsp;set tmp5 [aktive op tile min $tmp4 radius 1]<br>&nbsp;set tmp6 [aktive op math sub $tmp3 $tmp5]<br>&nbsp;set tmp7 [aktive op math1 invert $tmp6]<br>&nbsp;set tmp8 [aktive op math1 gamma expand $tmp7]<br>&nbsp;set tmp9 [aktive op color scRGB to Grey $tmp8]<br>&nbsp;set result [aktive op math1 scale $tmp9 factor 0.01]</td></tr>
</table>


---
### [↑](#top) <a name='op_query_colorspace'></a> aktive op query colorspace

Syntax: __aktive op query colorspace__ src [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/accessor/colorspace.tcl)]

Returns the name of the color space the input is in.

If no colorspace is set then `sRGB` is assumed for 3-band images, and `grey` for single-band images.

For anything else an error is thrown instead of making assumptions.


#### <a name='op_query_colorspace__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op query colorspace @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00453.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 3)</td>
    <td valign='top'>&nbsp;sRGB</td></tr>
</table>


---
### [↑](#top) <a name='query_id'></a> aktive query id

Syntax: __aktive query id__ src [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/accessor/attributes.tcl)]

Returns the input's implementation-specific image identity.


---
### [↑](#top) <a name='query_inputs'></a> aktive query inputs

Syntax: __aktive query inputs__ src [[→ definition](../../../../file?ci=trunk&ln=169&name=etc/accessor/attributes.tcl)]

Returns a list of the input's inputs.

For an image without inputs the result is the empty list.


---
### [↑](#top) <a name='query_params'></a> aktive query params

Syntax: __aktive query params__ src [[→ definition](../../../../file?ci=trunk&ln=194&name=etc/accessor/attributes.tcl)]

Returns a dictionary containing the input's parameters.

For an image without parameters the result is the empty dictionary.


#### <a name='query_params__examples'></a> Examples

<table>
<tr><th>@1
    <br>(zone width 32 height 32)</th>
    <th>aktive query params @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00639.gif' alt='@1 (zone width 32 height 32)' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;width 32 height 32</td></tr>
</table>

<table>
<tr><th>@1
    <br>(gradient width 32 height 32 depth 1 first 0 last 1)</th>
    <th>aktive query params @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00641.gif' alt='@1 (gradient width 32 height 32 depth 1 first 0 last 1)' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;width 32 height 32 depth 1 first 0.0 last 1.0</td></tr>
</table>


---
### [↑](#top) <a name='query_setup'></a> aktive query setup

Syntax: __aktive query setup__ src [[→ definition](../../../../file?ci=trunk&ln=219&name=etc/accessor/attributes.tcl)]

Returns a dictionary containing the input's setup.

This includes type, geometry, and parameters, if any. The inputs however are excluded.


#### <a name='query_setup__examples'></a> Examples

<table>
<tr><th>@1
    <br>(zone width 32 height 32)</th>
    <th>aktive query setup @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00651.gif' alt='@1 (zone width 32 height 32)' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;type image::zone domain {x 0 y 0 width 32 height 32 depth 1} config {width 32 height 32}</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query setup @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00653.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;type image::gradient domain {x 0 y 0 width 32 height 32 depth 1} config {width 32 height 32 depth 1 first 0.0 last 1.0}</td></tr>
</table>


---
### [↑](#top) <a name='query_type'></a> aktive query type

Syntax: __aktive query type__ src [[→ definition](../../../../file?ci=trunk&ln=27&name=etc/accessor/attributes.tcl)]

Returns the input's type.


#### <a name='query_type__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query type @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00659.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;image::zone</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query type @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00661.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;image::gradient</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor geometry

## <anchor='top'> Table Of Contents

  - [accessor](accessor.md) ↗


### Operators

 - [aktive query depth](#query_depth)

 - [aktive query xmax](#query_xmax)
 - [aktive query y](#query_y)
 - [aktive query ymax](#query_ymax)

## Operators

---
### [↑](#top) <a name='query_depth'></a> aktive query depth

Syntax: __aktive query depth__ src [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/accessor/attributes.tcl)]

Returns the input's depth.


#### <a name='query_depth__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query depth @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00617.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;1</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query depth @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00619.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;1</td></tr>
</table>


---
### [↑](#top) <a name='query_domain'></a> aktive query domain

Syntax: __aktive query domain__ src [[→ definition](../../../../file?ci=trunk&ln=69&name=etc/accessor/attributes.tcl)]

Returns the input's domain, a 2D rectangle. I.e. location, width, and height.


#### <a name='query_domain__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query domain @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00621.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0 0 32 32</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query domain @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00623.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0 0 32 32</td></tr>
</table>


---
### [↑](#top) <a name='query_geometry'></a> aktive query geometry

Syntax: __aktive query geometry__ src [[→ definition](../../../../file?ci=trunk&ln=90&name=etc/accessor/attributes.tcl)]

Returns the input's full geometry, i.e. domain and depth.


#### <a name='query_geometry__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query geometry @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00625.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0 0 32 32 1</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query geometry @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00627.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0 0 32 32 1</td></tr>
</table>


---
### [↑](#top) <a name='query_height'></a> aktive query height

Syntax: __aktive query height__ src [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/accessor/attributes.tcl)]

Returns the input's height.


#### <a name='query_height__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query height @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00629.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;32</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query height @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00631.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;32</td></tr>
</table>


---
### [↑](#top) <a name='query_location'></a> aktive query location

Syntax: __aktive query location__ src [[→ definition](../../../../file?ci=trunk&ln=48&name=etc/accessor/attributes.tcl)]

Returns the input's location, a 2D point.


#### <a name='query_location__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query location @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00633.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0 0</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query location @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00635.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0 0</td></tr>
</table>


---
### [↑](#top) <a name='query_pitch'></a> aktive query pitch

Syntax: __aktive query pitch__ src [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/accessor/attributes.tcl)]

Returns the input's pitch, the number of values in a row, i.e. width times depth.


#### <a name='query_pitch__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query pitch @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00643.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;32</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query pitch @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00645.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;32</td></tr>
</table>


---
### [↑](#top) <a name='query_pixels'></a> aktive query pixels

Syntax: __aktive query pixels__ src [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/accessor/attributes.tcl)]

Returns the input's number of pixels.


#### <a name='query_pixels__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query pixels @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00647.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;1024</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query pixels @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00649.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;1024</td></tr>
</table>


---
### [↑](#top) <a name='query_size'></a> aktive query size

Syntax: __aktive query size__ src [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/accessor/attributes.tcl)]

Returns the input's size, i.e. the number of pixels times depth.


#### <a name='query_size__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query size @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00655.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;1024</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query size @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00657.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;1024</td></tr>
</table>


---
### [↑](#top) <a name='query_width'></a> aktive query width

Syntax: __aktive query width__ src [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/accessor/attributes.tcl)]

Returns the input's width.


#### <a name='query_width__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query width @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00667.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;32</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query width @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00669.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;32</td></tr>
</table>


---
### [↑](#top) <a name='query_x'></a> aktive query x

Syntax: __aktive query x__ src [[→ definition](../../../../file?ci=trunk&ln=111&name=etc/accessor/attributes.tcl)]

Returns the input's x location.


#### <a name='query_x__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query x @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00671.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query x @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00673.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0</td></tr>
</table>


---
### [↑](#top) <a name='query_xmax'></a> aktive query xmax

Syntax: __aktive query xmax__ src [[→ definition](../../../../file?ci=trunk&ln=111&name=etc/accessor/attributes.tcl)]

Returns the input's maximum x location.


#### <a name='query_xmax__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query xmax @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00675.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;31</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query xmax @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00677.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;31</td></tr>
</table>


---
### [↑](#top) <a name='query_y'></a> aktive query y

Syntax: __aktive query y__ src [[→ definition](../../../../file?ci=trunk&ln=111&name=etc/accessor/attributes.tcl)]

Returns the input's y location.


#### <a name='query_y__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query y @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00679.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query y @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00681.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;0</td></tr>
</table>


---
### [↑](#top) <a name='query_ymax'></a> aktive query ymax

Syntax: __aktive query ymax__ src [[→ definition](../../../../file?ci=trunk&ln=111&name=etc/accessor/attributes.tcl)]

Returns the input's maximum y location.


#### <a name='query_ymax__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query ymax @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00683.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;31</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query ymax @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00685.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'>&nbsp;31</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor metadata

## <anchor='top'> Table Of Contents

  - [accessor](accessor.md) ↗


### Operators

 - [aktive meta exists](#meta_exists)
 - [aktive meta for](#meta_for)
 - [aktive meta get](#meta_get)
 - [aktive meta info](#meta_info)
 - [aktive meta keys](#meta_keys)
 - [aktive meta size](#meta_size)
 - [aktive meta values](#meta_values)
 - [aktive query meta](#query_meta)

## Operators

---
### [↑](#top) <a name='meta_exists'></a> aktive meta exists

Syntax: __aktive meta exists__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "exists" for image meta data management.

Returns result of "dict exists" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_for'></a> aktive meta for

Syntax: __aktive meta for__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "for" for image meta data management.

Returns result of "dict for" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_get'></a> aktive meta get

Syntax: __aktive meta get__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "get" for image meta data management.

Returns result of "dict get" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_info'></a> aktive meta info

Syntax: __aktive meta info__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "info" for image meta data management.

Returns result of "dict info" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_keys'></a> aktive meta keys

Syntax: __aktive meta keys__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "keys" for image meta data management.

Returns result of "dict keys" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_size'></a> aktive meta size

Syntax: __aktive meta size__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "size" for image meta data management.

Returns result of "dict size" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_values'></a> aktive meta values

Syntax: __aktive meta values__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "values" for image meta data management.

Returns result of "dict values" applied to the input's meta data dictionary

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input queried|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='query_meta'></a> aktive query meta

Syntax: __aktive query meta__ src [[→ definition](../../../../file?ci=trunk&ln=243&name=etc/accessor/attributes.tcl)]

Returns a dictionary containing the input's meta data.


#### <a name='query_meta__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query meta @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00637.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 3)</td>
    <td valign='top'>&nbsp;netpbm {maxval 255} path tests/assets/sines.ppm colorspace sRGB</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor morphology

## <anchor='top'> Table Of Contents

  - [accessor](accessor.md) ↗


### Operators

 - [aktive op connected-components get](#op_connected_components_get)

## Operators

---
### [↑](#top) <a name='op_connected_components_get'></a> aktive op connected-components get

Syntax: __aktive op connected-components get__ src [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/accessor/cc.tcl)]

Returns a dictionary describing all the connected components of the single-band input.

The input is expected to be binary. If not, all `values > 0` are treated as the foreground searched for components.

#### <a name='op_connected_components_get__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op connected-components get @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00328.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>cc.pretty</td><td valign='top'>&nbsp;1&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;8<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{0 0 5 2}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{3.125 1.625}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{0 5 5}&nbsp;{1 5 5}&nbsp;{2 0 5}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>2&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;15<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{1 1 9 6}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{5.266666666666667 3.4}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{1 8 9}&nbsp;{2 8 9}&nbsp;{3 7 8}&nbsp;{4 1 7}&nbsp;{5 1 1}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{6 1 1}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>3&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;8<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{12 1 14 3}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{13.0 2.0}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{1 12 14}&nbsp;{2 12 12}&nbsp;{2 14 14}&nbsp;{3 12 14}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>4&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;18<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{16 1 20 6}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{18.0 3.5}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{1 16 20}&nbsp;{2 16 16}&nbsp;{2 20 20}&nbsp;{3 16 16}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{3 20 20}&nbsp;{4 16 16}&nbsp;{4 20 20}&nbsp;{5 16 16}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{5 20 20}&nbsp;{6 16 20}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>5&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;45<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{22 1 32 7}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{27.0 3.422222222222222}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{1 24 30}&nbsp;{2 23 31}&nbsp;{3 22 32}&nbsp;{4 22 24}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{4 30 32}&nbsp;{5 22 23}&nbsp;{5 31 32}&nbsp;{6 23 24}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{6 30 31}&nbsp;{7 24 25}&nbsp;{7 29 30}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>6&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;15<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{1 4 9 9}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{4.733333333333333 6.6}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{4 9 9}&nbsp;{5 9 9}&nbsp;{6 3 9}&nbsp;{7 2 3}&nbsp;{8 1 2}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{9 1 2}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>7&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;18<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{22 5 32 10}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{27.0 8.61111111111111}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{5 27 27}&nbsp;{6 27 27}&nbsp;{7 27 27}&nbsp;{8 27 27}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{9 22 32}&nbsp;{10 26 28}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>8&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;8<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{5 8 10 10}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{6.875 8.375}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{8 5 10}&nbsp;{9 5 5}&nbsp;{10 5 5}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>9&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;20<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{12 8 19 10}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{15.5 8.8}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{8 12 19}&nbsp;{9 12 19}&nbsp;{10 12 13}&nbsp;{10 18 19}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>aktive op connected-components get @2
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00330.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00331.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>cc.pretty</td><td valign='top'>&nbsp;1&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;18<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{1 1 4 7}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{2.5 4.0}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{1 1 4}&nbsp;{2 1 1}&nbsp;{2 4 4}&nbsp;{3 1 1}&nbsp;{3 4 4}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{4 1 1}&nbsp;{4 4 4}&nbsp;{5 1 1}&nbsp;{5 4 4}&nbsp;{6 1 1}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{6 4 4}&nbsp;{7 1 4}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>2&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;14<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{9 1 22 1}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{15.5 1.0}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{1 9 22}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>3&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;28<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{7 3 15 9}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{11.0 6.0}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{3 7 15}&nbsp;{4 7 7}&nbsp;{4 15 15}&nbsp;{5 7 7}&nbsp;{5 15 15}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{6 7 7}&nbsp;{6 15 15}&nbsp;{7 7 7}&nbsp;{7 15 15}&nbsp;{8 7 7}<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{8 15 15}&nbsp;{9 7 15}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>4&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;12<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{9 5 13 7}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{11.0 6.0}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{5 9 13}&nbsp;{6 9 9}&nbsp;{6 13 13}&nbsp;{7 9 13}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}<br/>5&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;area&nbsp;24<br/>&nbsp;&nbsp;&nbsp;&nbsp;box&nbsp;{13 10 23 12}<br/>&nbsp;&nbsp;&nbsp;&nbsp;centroid&nbsp;{18.208333333333332 11.208333333333334}<br/>&nbsp;&nbsp;&nbsp;&nbsp;parts&nbsp;{<br/>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{10 18 23}&nbsp;{11 13 18}&nbsp;{11 23 23}&nbsp;{12 13 23}<br/>&nbsp;&nbsp;&nbsp;&nbsp;}<br/>}</td></tr></table></td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor threshold

## <anchor='top'> Table Of Contents

  - [accessor](accessor.md) ↗


## Subsections

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor threshold generate

## <anchor='top'> Table Of Contents

  - [accessor threshold](accessor_threshold.md) ↗


### Operators

 - [aktive image threshold global bernsen](#image_threshold_global_bernsen)
 - [aktive image threshold global mean](#image_threshold_global_mean)
 - [aktive image threshold global niblack](#image_threshold_global_niblack)
 - [aktive image threshold global otsu](#image_threshold_global_otsu)
 - [aktive image threshold global phansalkar](#image_threshold_global_phansalkar)
 - [aktive image threshold global sauvola](#image_threshold_global_sauvola)

## Operators

---
### [↑](#top) <a name='image_threshold_global_bernsen'></a> aktive image threshold global bernsen

Syntax: __aktive image threshold global bernsen__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/accessor/thresholds.tcl)]

Returns a global threshold for the input, according to [Bernsen](https://craftofcoding.wordpress.com/2021/10/27/thresholding-algorithms-bernsen-local)'s method.

The operator [aktive image mask per global bernsen](transform_threshold_mask_generate.md#image_mask_per_global_bernsen) uses this to generate a mask of the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately reduced to the threshold.


#### <a name='image_threshold_global_bernsen__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global bernsen @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00241.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td>
    <td valign='top'>&nbsp;0.33137254901960783</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global bernsen @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00243.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'>&nbsp;0.5078431372549019</td></tr>
</table>


---
### [↑](#top) <a name='image_threshold_global_mean'></a> aktive image threshold global mean

Syntax: __aktive image threshold global mean__ src [[→ definition](../../../../file?ci=trunk&ln=19&name=etc/accessor/thresholds.tcl)]

Returns a global threshold for the input, as the image mean.

The operator [aktive image mask per global mean](transform_threshold_mask_generate.md#image_mask_per_global_mean) uses this to generate a mask of the input.

There are better methods. Extensions to the simple mean, in order of creation (and complexity), are [Sauvola](https://craftofcoding.wordpress.com/2021/10/06/thresholding-algorithms-sauvola-local), [Niblack](https://craftofcoding.wordpress.com/2021/09/30/thresholding-algorithms-niblack-local), and [Phansalkar](https://craftofcoding.wordpress.com/2021/09/28/thresholding-algorithms-phansalkar-local). Each of these modifies the plain mean with a bias based on a mix of mean, standard deviation, and parameters.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately reduced to the threshold.


#### <a name='image_threshold_global_mean__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global mean @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00245.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td>
    <td valign='top'>&nbsp;0.46493130718954245</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global mean @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00247.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'>&nbsp;0.37447068455452354</td></tr>
</table>


---
### [↑](#top) <a name='image_threshold_global_niblack'></a> aktive image threshold global niblack

Syntax: __aktive image threshold global niblack__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=112&name=etc/accessor/thresholds.tcl)]

Returns a global threshold for the input, according to [Niblack](https://craftofcoding.wordpress.com/2021/09/30/thresholding-algorithms-niblack-local)'s method.

The operator [aktive image mask per global niblack](transform_threshold_mask_generate.md#image_mask_per_global_niblack) uses this to generate a mask of the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately reduced to the threshold.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|k|double|-0.2|niblack parameter|

#### <a name='image_threshold_global_niblack__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global niblack @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00249.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td>
    <td valign='top'>&nbsp;0.4461036579290674</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global niblack @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00251.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'>&nbsp;0.3194965780697608</td></tr>
</table>


---
### [↑](#top) <a name='image_threshold_global_otsu'></a> aktive image threshold global otsu

Syntax: __aktive image threshold global otsu__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=274&name=etc/accessor/thresholds.tcl)]

Returns a global threshold for the input, according to [Otsu](https://en.wikipedia.org/wiki/Otsu%27s_method)'s method.

The operator [aktive image mask per global otsu](transform_threshold_mask_generate.md#image_mask_per_global_otsu) uses this to generate a mask of the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately reduced to the threshold.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|bins|int|256|The number of bins used by the internal histogram. The pixel values are quantized to fit. Only values in the range of `[0..1]` are considered valid. Values outside of that range are placed into the smallest/largest bins, respectively. The default quantizes the image values to 8-bit.|

#### <a name='image_threshold_global_otsu__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global otsu @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00253.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td>
    <td valign='top'>&nbsp;0.3515625</td></tr>
</table>


---
### [↑](#top) <a name='image_threshold_global_phansalkar'></a> aktive image threshold global phansalkar

Syntax: __aktive image threshold global phansalkar__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=217&name=etc/accessor/thresholds.tcl)]

Returns a global threshold for the input, according to [Phansalkar](https://craftofcoding.wordpress.com/2021/09/28/thresholding-algorithms-phansalkar-local)'s method.

The operator [aktive image mask per global phansalkar](transform_threshold_mask_generate.md#image_mask_per_global_phansalkar) uses this to generate a mask of the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately reduced to the threshold.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|k|double|0.25|phansalkar parameter|
|R|double|0.5|phansalkar parameter|
|p|double|3|phansalkar parameter|
|q|double|10|phansalkar parameter|

#### <a name='image_threshold_global_phansalkar__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global phansalkar @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00255.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td>
    <td valign='top'>&nbsp;0.3839280179396569</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global phansalkar @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00257.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'>&nbsp;0.35887882734383425</td></tr>
</table>


---
### [↑](#top) <a name='image_threshold_global_sauvola'></a> aktive image threshold global sauvola

Syntax: __aktive image threshold global sauvola__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=164&name=etc/accessor/thresholds.tcl)]

Returns a global threshold for the input, according to [Sauvola](https://craftofcoding.wordpress.com/2021/10/06/thresholding-algorithms-sauvola-local)'s method.

The operator [aktive image mask per global sauvola](transform_threshold_mask_generate.md#image_mask_per_global_sauvola) uses this to generate a mask of the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately reduced to the threshold.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|k|double|0.5|sauvola parameter|
|R|double|128|sauvola parameter|

#### <a name='image_threshold_global_sauvola__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global sauvola @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00259.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td>
    <td valign='top'>&nbsp;0.23263662163348175</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive image threshold global sauvola @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00261.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'>&nbsp;0.18763741632585793</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- accessor values

## <anchor='top'> Table Of Contents

  - [accessor](accessor.md) ↗


### Operators

 - [aktive query value around](#query_value_around)
 - [aktive query value at](#query_value_at)
 - [aktive query values](#query_values)

## Operators

---
### [↑](#top) <a name='query_value_around'></a> aktive query value around

Syntax: __aktive query value around__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=318&name=etc/accessor/attributes.tcl)]

Returns the input's pixel values for the region around the specified 2D point, within the manhattan `radius`.

The result is __not__ an image.

Beware that the coordinate domain is `0..width|height`, regardless of image location.

This operator is __strict__ in its single input. The requested pixel region is materialized in memory.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|x|int||Physical x-coordinate of the pixel to query|
|y|int||Physical y-coordinate of the pixel to query|
|radius|uint|1|Region radius, defaults to 1, i.e. a 3x3 region.|

---
### [↑](#top) <a name='query_value_at'></a> aktive query value at

Syntax: __aktive query value at__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=288&name=etc/accessor/attributes.tcl)]

Returns the input's pixel value(s) at the given 2D point.

The result is __not__ an image. It is a list of floating point numbers for a multi-band input, and a single floating point number otherwise.

#### <a name='query_value_at__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query value at @1 x 0 y 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 16</td><td valign='top'><img src='example-00663.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td></tr></table></td>
    <td valign='top'>&nbsp;0.6666666666666666</td></tr>
</table>


---
### [↑](#top) <a name='query_values'></a> aktive query values

Syntax: __aktive query values__ src [[→ definition](../../../../file?ci=trunk&ln=262&name=etc/accessor/attributes.tcl)]

Returns a list containing the input's pixel values.

The values are provided in row-major order.

The list has length "[aktive query size](accessor_geometry.md#query_size) \<src\>".

This operator is __strict__ in its single input. The image is materialized in memory.


#### <a name='query_values__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive query values @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 16</td><td valign='top'><img src='example-00665.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td></tr></table></td>
    <td valign='top'>&nbsp;0.0 0.3333333333333333 0.6666666666666666 1.0</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- cache

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


### Operators

 - [aktive op cache](#op_cache)

## Operators

---
### [↑](#top) <a name='op_cache'></a> aktive op cache

Syntax: __aktive op cache__ src [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/cache.tcl)]

Returns the unchanged input.

However, this operator materializes and caches the input in memory, for fast random access. Yet it is __not strict__, as the materialization is deferred until the first access.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- composer

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


### Operators

 - [aktive op montage x](#op_montage_x)
 - [aktive op montage x-core](#op_montage_x_core)
 - [aktive op montage x-rep](#op_montage_x_rep)
 - [aktive op montage y](#op_montage_y)
 - [aktive op montage y-core](#op_montage_y_core)
 - [aktive op montage y-rep](#op_montage_y_rep)
 - [aktive op montage z](#op_montage_z)
 - [aktive op montage z-core](#op_montage_z_core)
 - [aktive op montage z-rep](#op_montage_z_rep)

## Operators

---
### [↑](#top) <a name='op_montage_x'></a> aktive op montage x

Syntax: __aktive op montage x__ srcs... [[→ definition](../../../../file?ci=trunk&ln=40&name=etc/composer/montage.tcl)]

Returns image with all inputs joined left to right along the x-axis.


#### <a name='op_montage_x__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>@3
    <br>&nbsp;</th>
    <th>aktive op montage x @1 @2 @3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00383.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'><img src='example-00384.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00385.gif' alt='@3' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00386.gif' alt='aktive op montage x @1 @2 @3' style='border:4px solid gold'>
    <br>geometry(0 0 224 128 1)</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>@3
    <br>&nbsp;</th>
    <th>aktive op montage x @1 @2 @3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00387.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00388.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00389.gif' alt='@3' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00390.gif' alt='aktive op montage x @1 @2 @3' style='border:4px solid gold'>
    <br>geometry(0 0 192 64 1)</td></tr>
</table>


---
### [↑](#top) <a name='op_montage_x_core'></a> aktive op montage x-core

Syntax: __aktive op montage x-core__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/composer/montage.tcl)]

Returns image with the 2 inputs joined left to right along the x-axis.

The location of the first image becomes the location of the result.

The other location is ignored.

The width of the result is the sum of the widths of the inputs.

The other dimensions use the maximum of the same over the inputs.

In the result the uncovered parts are zero (black)-filled.


---
### [↑](#top) <a name='op_montage_x_rep'></a> aktive op montage x-rep

Syntax: __aktive op montage x-rep__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=12&name=etc/composer/montage.tcl)]

Returns image with input joined left to right with itself N times along the x-axis.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|by|uint||Replication factor|

#### <a name='op_montage_x_rep__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op montage x-rep @1 by 3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00391.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'><img src='example-00392.gif' alt='aktive op montage x-rep @1 by 3' style='border:4px solid gold'>
    <br>geometry(0 0 96 32 1)</td></tr>
</table>


---
### [↑](#top) <a name='op_montage_y'></a> aktive op montage y

Syntax: __aktive op montage y__ srcs... [[→ definition](../../../../file?ci=trunk&ln=40&name=etc/composer/montage.tcl)]

Returns image with all inputs joined top to bottom along the y-axis.


#### <a name='op_montage_y__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>@3
    <br>&nbsp;</th>
    <th>aktive op montage y @1 @2 @3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00393.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'><img src='example-00394.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00395.gif' alt='@3' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00396.gif' alt='aktive op montage y @1 @2 @3' style='border:4px solid gold'>
    <br>geometry(0 0 128 224 1)</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>@3
    <br>&nbsp;</th>
    <th>aktive op montage y @1 @2 @3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00397.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00398.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00399.gif' alt='@3' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00400.gif' alt='aktive op montage y @1 @2 @3' style='border:4px solid gold'>
    <br>geometry(0 0 64 192 1)</td></tr>
</table>


---
### [↑](#top) <a name='op_montage_y_core'></a> aktive op montage y-core

Syntax: __aktive op montage y-core__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/composer/montage.tcl)]

Returns image with the 2 inputs joined top to bottom along the y-axis.

The location of the first image becomes the location of the result.

The other location is ignored.

The height of the result is the sum of the heights of the inputs.

The other dimensions use the maximum of the same over the inputs.

In the result the uncovered parts are zero (black)-filled.


---
### [↑](#top) <a name='op_montage_y_rep'></a> aktive op montage y-rep

Syntax: __aktive op montage y-rep__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=12&name=etc/composer/montage.tcl)]

Returns image with input joined top to bottom with itself N times along the y-axis.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|by|uint||Replication factor|

#### <a name='op_montage_y_rep__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op montage y-rep @1 by 3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00401.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'><img src='example-00402.gif' alt='aktive op montage y-rep @1 by 3' style='border:4px solid gold'>
    <br>geometry(0 0 32 96 1)</td></tr>
</table>


---
### [↑](#top) <a name='op_montage_z'></a> aktive op montage z

Syntax: __aktive op montage z__ srcs... [[→ definition](../../../../file?ci=trunk&ln=40&name=etc/composer/montage.tcl)]

Returns image with all inputs joined front to back along the z-axis.


#### <a name='op_montage_z__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>@3
    <br>&nbsp;</th>
    <th>aktive op montage z @1 @2 @3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00403.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'><img src='example-00404.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00405.gif' alt='@3' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00406.gif' alt='aktive op montage z @1 @2 @3' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 3)</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>@3
    <br>&nbsp;</th>
    <th>aktive op montage z @1 @2 @3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00407.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00408.gif' alt='@2' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00409.gif' alt='@3' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td>
    <td valign='top'><img src='example-00410.gif' alt='aktive op montage z @1 @2 @3' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_montage_z_core'></a> aktive op montage z-core

Syntax: __aktive op montage z-core__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/composer/montage.tcl)]

Returns image with the 2 inputs joined front to back along the z-axis.

The location of the first image becomes the location of the result.

The other location is ignored.

The depth of the result is the sum of the depths of the inputs.

The other dimensions use the maximum of the same over the inputs.

In the result the uncovered parts are zero (black)-filled.


---
### [↑](#top) <a name='op_montage_z_rep'></a> aktive op montage z-rep

Syntax: __aktive op montage z-rep__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=12&name=etc/composer/montage.tcl)]

Returns image with input joined front to back with itself N times along the z-axis.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|by|uint||Replication factor|

#### <a name='op_montage_z_rep__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op montage z-rep @1 by 3
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00411.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 1)</td>
    <td valign='top'><img src='example-00412.gif' alt='aktive op montage z-rep @1 by 3' style='border:4px solid gold'>
    <br>geometry(0 0 32 32 3)</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- generator

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


## Subsections

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- generator reader

## <anchor='top'> Table Of Contents

  - [generator](generator.md) ↗


### Operators

 - [aktive read from aktive](#read_from_aktive)
 - [aktive read from netpbm](#read_from_netpbm)

## Operators

---
### [↑](#top) <a name='read_from_aktive'></a> aktive read from aktive

Syntax: __aktive read from aktive__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/generator/reader/aktive.tcl)]

Construct image from file content in the native AKTIVE format.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|path|object||Path to file holding the AKTIVE image data to read|

#### <a name='read_from_aktive__examples'></a> Examples

<table>
<tr><th>aktive read from aktive path tests/assets/results/format-colorbox.aktive
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00687.gif' alt='aktive read from aktive path tests/assets/results/format-colorbox.aktive' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 3)</td></tr></table></td></tr>
</table>

<table>
<tr><th>aktive read from aktive path tests/assets/results/format-graybox.aktive
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00688.gif' alt='aktive read from aktive path tests/assets/results/format-graybox.aktive' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='read_from_netpbm'></a> aktive read from netpbm

Syntax: __aktive read from netpbm__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/generator/reader/netpbm.tcl)]

Construct image from file content in one of the NetPBM formats.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|path|object||Path to file holding the NetPBM image data to read|

#### <a name='read_from_netpbm__examples'></a> Examples

<table>
<tr><th>aktive read from netpbm path tests/assets/sines.ppm
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00689.gif' alt='aktive read from netpbm path tests/assets/sines.ppm' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 3)</td></tr>
</table>

<table>
<tr><th>aktive read from netpbm path tests/assets/crop.pgm
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00690.gif' alt='aktive read from netpbm path tests/assets/crop.pgm' style='border:4px solid gold'>
    <br>geometry(0 0 300 200 1)</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- generator virtual

## <anchor='top'> Table Of Contents

  - [generator](generator.md) ↗


## Subsections

 - [aktive image vbar](#image_vbar)
 - [aktive image xcross](#image_xcross)
 - [aktive image zone](#image_zone)

## Operators

---
### [↑](#top) <a name='image_cbar'></a> aktive image cbar

Syntax: __aktive image cbar__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a cross diagonal bar. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00044.gif' alt='aktive image cbar radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_checkers'></a> aktive image checkers

Syntax: __aktive image checkers__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=143&name=etc/generator/virtual/pattern/checkers.tcl)]

Returns image containing a black/white checker board.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00047.gif' alt='aktive image checkers width 128 height 128 black 16 white 32 offset 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_circle'></a> aktive image circle

Syntax: __aktive image circle__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a circle (disc perimeter). The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00048.gif' alt='aktive image circle radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_cross'></a> aktive image cross

Syntax: __aktive image cross__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a cross. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00049.gif' alt='aktive image cross radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_dbar'></a> aktive image dbar

Syntax: __aktive image dbar__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a diagonal bar. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00050.gif' alt='aktive image dbar radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_dgrid'></a> aktive image dgrid

Syntax: __aktive image dgrid__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=29&name=etc/generator/virtual/pattern/checkers.tcl)]

Returns image containing a diagonal black/white grid with configurable stripes

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00053.gif' alt='aktive image dgrid width 128 height 128 black 16 white 32 offset 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_disc'></a> aktive image disc

Syntax: __aktive image disc__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a filled disc. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Radius of the filled disc.|

#### <a name='image_disc__examples'></a> Examples

<table>
<tr><th>aktive image disc radius 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00054.gif' alt='aktive image disc radius 32' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_dstripes'></a> aktive image dstripes

Syntax: __aktive image dstripes__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=98&name=etc/generator/virtual/pattern/checkers.tcl)]

Returns image containing a series of diagonal black/white stripes.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00084.gif' alt='aktive image dstripes width 128 height 128 black 16 white 32 offset 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_eye'></a> aktive image eye

Syntax: __aktive image eye__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/pattern/eye.tcl)]

Returns image containing a test pattern with increasing spatial frequency from left to right, and increasing amplitude (i.e. black to white) from top to bottom.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00085.gif' alt='aktive image eye width 256 height 256 factor 0.8' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_from_band'></a> aktive image from band

Syntax: __aktive image from band__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=29&name=etc/generator/virtual/constant.tcl)]

Returns image where all pixels have the same band values.

Depth is len(value)

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00087.gif' alt='aktive image from band width 64 height 64 values 0.3 0.5 0.7' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 3)</td></tr>
</table>


---
### [↑](#top) <a name='image_from_column'></a> aktive image from column

Syntax: __aktive image from column__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=83&name=etc/generator/virtual/constant.tcl)]

Returns image of the specified width where all columns have the same set of values.

The image's height is the number of values.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00088.gif' alt='aktive image from column width 64 values 0 0.05 0.1 0.15 0.2 0.25 0.3 0.35 0.4 0.45 0.5 0.55 0.6 0.6 0.7 0.75 0.8 0.85 0.9 0.95 1' style='border:4px solid gold'>
    <br>geometry(0 0 64 21 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_from_matrix'></a> aktive image from matrix

Syntax: __aktive image from matrix__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=109&name=etc/generator/virtual/constant.tcl)]

Returns single-band image with the pixel VALUEs.

Less than width by height values are extended with zeroes.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00089.gif' alt='aktive image from matrix width 16 height 16 values 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_from_row'></a> aktive image from row

Syntax: __aktive image from row__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=57&name=etc/generator/virtual/constant.tcl)]

Returns image of the specified height where all rows have the same set of values.

The image's width is the number of values.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00090.gif' alt='aktive image from row height 64 values 0 0.05 0.1 0.15 0.2 0.25 0.3 0.35 0.4 0.45 0.5 0.55 0.6 0.6 0.7 0.75 0.8 0.85 0.9 0.95 1' style='border:4px solid gold'>
    <br>geometry(0 0 21 64 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_from_sparse_deltas'></a> aktive image from sparse deltas

Syntax: __aktive image from sparse deltas__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=55&name=etc/generator/virtual/sparse.tcl)]

Returns a single-band image where pixels are set to white at exactly the specified points. In contrast to `sparse points` the points are specified as linear distances from the origin.

The height is infered from the points

<tr><td valign='top'><table><tr><td valign='top'><img src='example-00091.gif' alt='aktive image from sparse deltas width 7 deltas 0 20 5 15' style='border:4px solid gold'>
    <br>geometry(0 0 7 6 1)</td><td valign='top'>times 8</td><td valign='top'><img src='example-00092.gif' alt='aktive image from sparse deltas width 7 deltas 0 20 5 15' style='border:4px solid gold'>
    <br>geometry(0 0 56 48 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_from_sparse_points'></a> aktive image from sparse points

Syntax: __aktive image from sparse points__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/sparse.tcl)]

Returns a single-band image where pixels are set to white at exactly the specified coordinates.

Generally, the bounding box specifies the geometry, especially also the image origin

<tr><td valign='top'><table><tr><td valign='top'><img src='example-00093.gif' alt='aktive image from sparse points coords {0 0} {4 3} {5 5} {6 2}' style='border:4px solid gold'>
    <br>geometry(0 0 7 6 1)</td><td valign='top'>times 8</td><td valign='top'><img src='example-00094.gif' alt='aktive image from sparse points coords {0 0} {4 3} {5 5} {6 2}' style='border:4px solid gold'>
    <br>geometry(0 0 56 48 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_from_sparse_ranges'></a> aktive image from sparse ranges

Syntax: __aktive image from sparse ranges__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=126&name=etc/generator/virtual/sparse.tcl)]

Returns a single-band image where the pixels are set to the specified values as per the provided row ranges.

A single row range is specified by 4 numbers.

<tr><td valign='top'><table><tr><td valign='top'><img src='example-00095.gif' alt='aktive image from sparse ranges ranges {1 24 30 1} {2 23 31 1} {3 22 32 1} {4 22 24 0.75} {4 30 32 0.75} {5 22 23 0.75} {5 31 32 0.75} {6 23 24 0.5} {6 30 31 0.5} {7 24 25 0.5} {7 29 30 0.5}' style='border:4px solid gold'>
    <br>geometry(22 1 11 7 1)</td><td valign='top'>times 8</td><td valign='top'><img src='example-00096.gif' alt='aktive image from sparse ranges ranges {1 24 30 1} {2 23 31 1} {3 22 32 1} {4 22 24 0.75} {4 30 32 0.75} {5 22 23 0.75} {5 31 32 0.75} {6 23 24 0.5} {6 30 31 0.5} {7 24 25 0.5} {7 29 30 0.5}' style='border:4px solid gold'>
    <br>geometry(22 1 88 56 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_from_value'></a> aktive image from value

Syntax: __aktive image from value__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/constant.tcl)]

Returns image which has the same VALUE everywhere.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00098.gif' alt='aktive image from value width 64 height 64 depth 3 value 0.5' style='border:4px solid gold'>
    <br>geometry(0 0 64 64 3)</td></tr>
</table>


---
### [↑](#top) <a name='image_gradient'></a> aktive image gradient

Syntax: __aktive image gradient__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/gradient.tcl)]

Returns image containing a linear gradient through all cells.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00100.gif' alt='aktive image gradient width 128 height 128 depth 1 first 0 last 1' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_grey'></a> aktive image grey

Syntax: __aktive image grey__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/grey.tcl)]

Returns image containing a left to right black to white gradient.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00101.gif' alt='aktive image grey width 256 height 32' style='border:4px solid gold'>
    <br>geometry(0 0 256 32 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_grid'></a> aktive image grid

Syntax: __aktive image grid__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/pattern/checkers.tcl)]

Returns image containing an axis-aligned black/white grid with configurable stripes

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00104.gif' alt='aktive image grid width 128 height 128 black 16 white 32 offset 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_hbar'></a> aktive image hbar

Syntax: __aktive image hbar__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a horizontal bar. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00105.gif' alt='aktive image hbar radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_indexed'></a> aktive image indexed

Syntax: __aktive image indexed__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/indexed.tcl)]

Returns a 2-band image where each pixel declares its own position.

__Note__ that while the result is usable as a warp map for the <!xref aktive op warp map> operation, it will not do anything, as it represents the identity warping.

<tr><th>aktive image indexed x -5 y -5 width 8 height 8
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>(-5, -5)</td><td>(-4, -5)</td><td>(-3, -5)</td><td>(-2, -5)</td><td>(-1, -5)</td><td>(0, -5)</td><td>(1, -5)</td><td>(2, -5)</td></tr><tr><td>(-5, -4)</td><td>(-4, -4)</td><td>(-3, -4)</td><td>(-2, -4)</td><td>(-1, -4)</td><td>(0, -4)</td><td>(1, -4)</td><td>(2, -4)</td></tr><tr><td>(-5, -3)</td><td>(-4, -3)</td><td>(-3, -3)</td><td>(-2, -3)</td><td>(-1, -3)</td><td>(0, -3)</td><td>(1, -3)</td><td>(2, -3)</td></tr><tr><td>(-5, -2)</td><td>(-4, -2)</td><td>(-3, -2)</td><td>(-2, -2)</td><td>(-1, -2)</td><td>(0, -2)</td><td>(1, -2)</td><td>(2, -2)</td></tr><tr><td>(-5, -1)</td><td>(-4, -1)</td><td>(-3, -1)</td><td>(-2, -1)</td><td>(-1, -1)</td><td>(0, -1)</td><td>(1, -1)</td><td>(2, -1)</td></tr><tr><td>(-5, 0)</td><td>(-4, 0)</td><td>(-3, 0)</td><td>(-2, 0)</td><td>(-1, 0)</td><td>(0, 0)</td><td>(1, 0)</td><td>(2, 0)</td></tr><tr><td>(-5, 1)</td><td>(-4, 1)</td><td>(-3, 1)</td><td>(-2, 1)</td><td>(-1, 1)</td><td>(0, 1)</td><td>(1, 1)</td><td>(2, 1)</td></tr><tr><td>(-5, 2)</td><td>(-4, 2)</td><td>(-3, 2)</td><td>(-2, 2)</td><td>(-1, 2)</td><td>(0, 2)</td><td>(1, 2)</td><td>(2, 2)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_emboss'></a> aktive image kernel emboss

Syntax: __aktive image kernel emboss__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for embossing effect


#### <a name='image_kernel_emboss__examples'></a> Examples

<table>
<tr><th>aktive image kernel emboss 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>2</td><td>0</td><td>0</td></tr><tr><td>0</td><td>-1</td><td>0</td></tr><tr><td>0</td><td>0</td><td>-1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss3_x'></a> aktive image kernel gauss3 x

Syntax: __aktive image kernel gauss3 x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss3ian blur effect


#### <a name='image_kernel_gauss3_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss3 x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.2500</td><td>0.5000</td><td>0.2500</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss3_xy'></a> aktive image kernel gauss3 xy

Syntax: __aktive image kernel gauss3 xy__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss3ian blur effect


#### <a name='image_kernel_gauss3_xy__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss3 xy 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0625</td><td>0.1250</td><td>0.0625</td></tr><tr><td>0.1250</td><td>0.2500</td><td>0.1250</td></tr><tr><td>0.0625</td><td>0.1250</td><td>0.0625</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss3_y'></a> aktive image kernel gauss3 y

Syntax: __aktive image kernel gauss3 y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss3ian blur effect


#### <a name='image_kernel_gauss3_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss3 y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.2500</td></tr><tr><td>0.5000</td></tr><tr><td>0.2500</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss5_x'></a> aktive image kernel gauss5 x

Syntax: __aktive image kernel gauss5 x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss5ian blur effect


#### <a name='image_kernel_gauss5_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss5 x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0625</td><td>0.2500</td><td>0.3750</td><td>0.2500</td><td>0.0625</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss5_y'></a> aktive image kernel gauss5 y

Syntax: __aktive image kernel gauss5 y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss5ian blur effect


#### <a name='image_kernel_gauss5_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss5 y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0625</td></tr><tr><td>0.2500</td></tr><tr><td>0.3750</td></tr><tr><td>0.2500</td></tr><tr><td>0.0625</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss7_x'></a> aktive image kernel gauss7 x

Syntax: __aktive image kernel gauss7 x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss7ian blur effect


#### <a name='image_kernel_gauss7_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss7 x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0156</td><td>0.0938</td><td>0.2344</td><td>0.3125</td><td>0.2344</td><td>0.0938</td><td>0.0156</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss7_y'></a> aktive image kernel gauss7 y

Syntax: __aktive image kernel gauss7 y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss7ian blur effect


#### <a name='image_kernel_gauss7_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss7 y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0156</td></tr><tr><td>0.0938</td></tr><tr><td>0.2344</td></tr><tr><td>0.3125</td></tr><tr><td>0.2344</td></tr><tr><td>0.0938</td></tr><tr><td>0.0156</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss9_x'></a> aktive image kernel gauss9 x

Syntax: __aktive image kernel gauss9 x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss9ian blur effect


#### <a name='image_kernel_gauss9_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss9 x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0078</td><td>0.0625</td><td>0.2188</td><td>0.4375</td><td>0.5469</td><td>0.4375</td><td>0.2188</td><td>0.0625</td><td>0.0078</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss9_y'></a> aktive image kernel gauss9 y

Syntax: __aktive image kernel gauss9 y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for gauss9ian blur effect


#### <a name='image_kernel_gauss9_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel gauss9 y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0078</td></tr><tr><td>0.0625</td></tr><tr><td>0.2188</td></tr><tr><td>0.4375</td></tr><tr><td>0.5469</td></tr><tr><td>0.4375</td></tr><tr><td>0.2188</td></tr><tr><td>0.0625</td></tr><tr><td>0.0078</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_gauss_discrete'></a> aktive image kernel gauss discrete

Syntax: __aktive image kernel gauss discrete__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=99&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns the 1D discrete gaussian convolution kernel, for the specified sigma and radius. By default sigma is 1. By default the radius is max(1,ceil(3*sigma)).

For more about the math see http://en.wikipedia.org/wiki/Scale_space_implementation#The_discrete_Gaussian_kernel

<tr><th>aktive image kernel gauss discrete sigma 1 radius 6
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0.0000</td><td>0.0001</td><td>0.0010</td><td>0.0082</td><td>0.0499</td><td>0.2079</td><td>0.4658</td><td>0.2079</td><td>0.0499</td><td>0.0082</td><td>0.0010</td><td>0.0001</td><td>0.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_kirsch_md'></a> aktive image kernel kirsch md

Syntax: __aktive image kernel kirsch md__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for kirsch edge detection


#### <a name='image_kernel_kirsch_md__examples'></a> Examples

<table>
<tr><th>aktive image kernel kirsch md 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-3</td><td>5</td><td>5</td></tr><tr><td>-3</td><td>0</td><td>5</td></tr><tr><td>-3</td><td>-3</td><td>-3</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_kirsch_sd'></a> aktive image kernel kirsch sd

Syntax: __aktive image kernel kirsch sd__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for kirsch edge detection


#### <a name='image_kernel_kirsch_sd__examples'></a> Examples

<table>
<tr><th>aktive image kernel kirsch sd 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>5</td><td>5</td><td>-3</td></tr><tr><td>5</td><td>0</td><td>-3</td></tr><tr><td>-3</td><td>-3</td><td>-3</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_kirsch_x'></a> aktive image kernel kirsch x

Syntax: __aktive image kernel kirsch x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for kirsch edge detection


#### <a name='image_kernel_kirsch_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel kirsch x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>5</td><td>-3</td><td>-3</td></tr><tr><td>5</td><td>0</td><td>-3</td></tr><tr><td>5</td><td>-3</td><td>-3</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_kirsch_y'></a> aktive image kernel kirsch y

Syntax: __aktive image kernel kirsch y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for kirsch edge detection


#### <a name='image_kernel_kirsch_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel kirsch y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>5</td><td>5</td><td>5</td></tr><tr><td>-3</td><td>0</td><td>-3</td></tr><tr><td>-3</td><td>-3</td><td>-3</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_lanczos'></a> aktive image kernel lanczos

Syntax: __aktive image kernel lanczos__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=165&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns lanczos convolution kernel of the specified order. The default order is 3. Step expands the kernel to the given resolution (default 1).

For more about the math see https://en.wikipedia.org/wiki/Lanczos_resampling#Lanczos_kernel

<tr><th>aktive image kernel lanczos order 2 step 0.25
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-0.0179</td><td>-0.0637</td><td>-0.0847</td><td>0.0000</td><td>0.2353</td><td>0.5732</td><td>0.8774</td><td>1.0000</td><td>0.8774</td><td>0.5732</td><td>0.2353</td><td>0.0000</td><td>-0.0847</td><td>-0.0637</td><td>-0.0179</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_laplace_4'></a> aktive image kernel laplace 4

Syntax: __aktive image kernel laplace 4__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for laplacian edge detection


#### <a name='image_kernel_laplace_4__examples'></a> Examples

<table>
<tr><th>aktive image kernel laplace 4 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0</td><td>-1</td><td>0</td></tr><tr><td>-1</td><td>4</td><td>-1</td></tr><tr><td>0</td><td>-1</td><td>0</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_laplace_8'></a> aktive image kernel laplace 8

Syntax: __aktive image kernel laplace 8__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for laplacian edge detection


#### <a name='image_kernel_laplace_8__examples'></a> Examples

<table>
<tr><th>aktive image kernel laplace 8 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-1</td><td>-1</td><td>-1</td></tr><tr><td>-1</td><td>8</td><td>-1</td></tr><tr><td>-1</td><td>-1</td><td>-1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_laplace_X'></a> aktive image kernel laplace X

Syntax: __aktive image kernel laplace X__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for laplacian edge detection


#### <a name='image_kernel_laplace_X__examples'></a> Examples

<table>
<tr><th>aktive image kernel laplace X 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>-2</td><td>1</td></tr><tr><td>-2</td><td>4</td><td>-2</td></tr><tr><td>1</td><td>-2</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_prewitt_md'></a> aktive image kernel prewitt md

Syntax: __aktive image kernel prewitt md__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for prewitt edge detection


#### <a name='image_kernel_prewitt_md__examples'></a> Examples

<table>
<tr><th>aktive image kernel prewitt md 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0</td><td>1</td><td>1</td></tr><tr><td>-1</td><td>0</td><td>1</td></tr><tr><td>-1</td><td>-1</td><td>0</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_prewitt_sd'></a> aktive image kernel prewitt sd

Syntax: __aktive image kernel prewitt sd__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for prewitt edge detection


#### <a name='image_kernel_prewitt_sd__examples'></a> Examples

<table>
<tr><th>aktive image kernel prewitt sd 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-1</td><td>-1</td><td>0</td></tr><tr><td>-1</td><td>0</td><td>1</td></tr><tr><td>0</td><td>1</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_prewitt_x'></a> aktive image kernel prewitt x

Syntax: __aktive image kernel prewitt x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for prewitt edge detection


#### <a name='image_kernel_prewitt_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel prewitt x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-1</td><td>0</td><td>1</td></tr><tr><td>-1</td><td>0</td><td>1</td></tr><tr><td>-1</td><td>0</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_prewitt_y'></a> aktive image kernel prewitt y

Syntax: __aktive image kernel prewitt y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for prewitt edge detection


#### <a name='image_kernel_prewitt_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel prewitt y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-1</td><td>-1</td><td>-1</td></tr><tr><td>0</td><td>0</td><td>0</td></tr><tr><td>1</td><td>1</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_roberts_x'></a> aktive image kernel roberts x

Syntax: __aktive image kernel roberts x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for roberts cross edge detection


#### <a name='image_kernel_roberts_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel roberts x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0</td><td>-1</td><td>0</td></tr><tr><td>1</td><td>0</td><td>0</td></tr><tr><td>0</td><td>0</td><td>0</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_roberts_y'></a> aktive image kernel roberts y

Syntax: __aktive image kernel roberts y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for roberts cross edge detection


#### <a name='image_kernel_roberts_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel roberts y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-1</td><td>0</td><td>0</td></tr><tr><td>0</td><td>1</td><td>0</td></tr><tr><td>0</td><td>0</td><td>0</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_scharr_x'></a> aktive image kernel scharr x

Syntax: __aktive image kernel scharr x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for scharr edge detection


#### <a name='image_kernel_scharr_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel scharr x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-3</td><td>0</td><td>3</td></tr><tr><td>-10</td><td>0</td><td>10</td></tr><tr><td>-3</td><td>0</td><td>3</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_scharr_y'></a> aktive image kernel scharr y

Syntax: __aktive image kernel scharr y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for scharr edge detection


#### <a name='image_kernel_scharr_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel scharr y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-3</td><td>-10</td><td>-3</td></tr><tr><td>0</td><td>0</td><td>0</td></tr><tr><td>3</td><td>10</td><td>3</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sharp_4'></a> aktive image kernel sharp 4

Syntax: __aktive image kernel sharp 4__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sharpening effect


#### <a name='image_kernel_sharp_4__examples'></a> Examples

<table>
<tr><th>aktive image kernel sharp 4 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0</td><td>-1</td><td>0</td></tr><tr><td>-1</td><td>5</td><td>-1</td></tr><tr><td>0</td><td>-1</td><td>0</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sharp_8'></a> aktive image kernel sharp 8

Syntax: __aktive image kernel sharp 8__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sharpening effect


#### <a name='image_kernel_sharp_8__examples'></a> Examples

<table>
<tr><th>aktive image kernel sharp 8 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>-1</td><td>-1</td><td>-1</td></tr><tr><td>-1</td><td>9</td><td>-1</td></tr><tr><td>-1</td><td>-1</td><td>-1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sharp_X'></a> aktive image kernel sharp X

Syntax: __aktive image kernel sharp X__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sharpening effect


#### <a name='image_kernel_sharp_X__examples'></a> Examples

<table>
<tr><th>aktive image kernel sharp X 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>-2</td><td>1</td></tr><tr><td>-2</td><td>5</td><td>-2</td></tr><tr><td>1</td><td>-2</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sobel_md'></a> aktive image kernel sobel md

Syntax: __aktive image kernel sobel md__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sobel edge detection


#### <a name='image_kernel_sobel_md__examples'></a> Examples

<table>
<tr><th>aktive image kernel sobel md 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>0</td><td>-1</td><td>-1</td></tr><tr><td>2</td><td>0</td><td>-2</td></tr><tr><td>1</td><td>1</td><td>0</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sobel_sd'></a> aktive image kernel sobel sd

Syntax: __aktive image kernel sobel sd__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sobel edge detection


#### <a name='image_kernel_sobel_sd__examples'></a> Examples

<table>
<tr><th>aktive image kernel sobel sd 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>1</td><td>0</td></tr><tr><td>2</td><td>0</td><td>-2</td></tr><tr><td>0</td><td>-1</td><td>-1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sobel_x'></a> aktive image kernel sobel x

Syntax: __aktive image kernel sobel x__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sobel edge detection


#### <a name='image_kernel_sobel_x__examples'></a> Examples

<table>
<tr><th>aktive image kernel sobel x 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>0</td><td>-1</td></tr><tr><td>2</td><td>0</td><td>-2</td></tr><tr><td>1</td><td>0</td><td>-1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_kernel_sobel_y'></a> aktive image kernel sobel y

Syntax: __aktive image kernel sobel y__  [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/generator/virtual/pattern/kernels.tcl)]

Returns convolution kernel for sobel edge detection


#### <a name='image_kernel_sobel_y__examples'></a> Examples

<table>
<tr><th>aktive image kernel sobel y 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>2</td><td>1</td></tr><tr><td>0</td><td>0</td><td>0</td></tr><tr><td>-1</td><td>-2</td><td>-1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_noise_gauss'></a> aktive image noise gauss

Syntax: __aktive image noise gauss__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/noise/gauss.tcl)]

Returns image where pixels are set to random values drawn from a gaussian distribution with mean and sigma over +/-sigma. The defaults are 0 and 1.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|width|uint||Width of the returned image|
|height|uint||Height of the returned image|
|depth|uint||Depth of the returned image|
|mean|double|0|Mean of the desired gauss distribution.|
|sigma|double|1|Sigma of the desired gauss distribution.|
|seed|uint|[expr {int(4294967296*rand())}]|Randomizer seed. Needed only to force fixed results.|

#### <a name='image_noise_gauss__examples'></a> Examples

<table>
<tr><th>aktive image noise gauss width 256 height 256 depth 1 seed 703011174
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00194.gif' alt='aktive image noise gauss width 256 height 256 depth 1 seed 703011174' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 1)</td></tr>
</table>

<table>
<tr><th>aktive image noise gauss width 256 height 256 depth 3 seed 703011174
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00195.gif' alt='aktive image noise gauss width 256 height 256 depth 3 seed 703011174' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 3)</td></tr>
</table>


---
### [↑](#top) <a name='image_noise_salt'></a> aktive image noise salt

Syntax: __aktive image noise salt__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/generator/virtual/noise/salt.tcl)]

Returns image containing salt and pepper noise.

Pixels are set where the uniformly distributed random value is under the threshold.

|seed|uint|[expr {int(4294967296*rand())}]|Randomizer seed. Needed only to force fixed results.|

#### <a name='image_noise_salt__examples'></a> Examples

<table>
<tr><th>aktive image noise salt width 256 height 256 depth 1 seed 703011174 threshold 0.02
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00196.gif' alt='aktive image noise salt width 256 height 256 depth 1 seed 703011174 threshold 0.02' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 1)</td></tr>
</table>

<table>
<tr><th>aktive image noise salt width 256 height 256 depth 3 seed 703011174 threshold 0.02
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00197.gif' alt='aktive image noise salt width 256 height 256 depth 3 seed 703011174 threshold 0.02' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 3)</td></tr>
</table>


---
### [↑](#top) <a name='image_noise_uniform'></a> aktive image noise uniform

Syntax: __aktive image noise uniform__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/noise/uniform.tcl)]

Returns image where pixels are set to random values drawn from a uniform distribution over [0..1]

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|width|uint||Width of the returned image|
|height|uint||Height of the returned image|
|depth|uint||Depth of the returned image|
|seed|uint|[expr {int(4294967296*rand())}]|Randomizer seed. Needed only to force fixed results.|

#### <a name='image_noise_uniform__examples'></a> Examples

<table>
<tr><th>aktive image noise uniform width 256 height 256 depth 1 seed 703011174
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00198.gif' alt='aktive image noise uniform width 256 height 256 depth 1 seed 703011174' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 1)</td></tr>
</table>

<table>
<tr><th>aktive image noise uniform width 256 height 256 depth 3 seed 703011174
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00199.gif' alt='aktive image noise uniform width 256 height 256 depth 3 seed 703011174' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 3)</td></tr>
</table>


---
### [↑](#top) <a name='image_palette_color'></a> aktive image palette color

Syntax: __aktive image palette color__  [[→ definition](../../../../file?ci=trunk&ln=19&name=etc/generator/virtual/pattern/palette.tcl)]

Returns a 128x128 image containing a color palette.


#### <a name='image_palette_color__examples'></a> Examples

<table>
<tr><th>aktive image palette color 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00200.gif' alt='aktive image palette color ' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 3)</td></tr>
</table>


---
### [↑](#top) <a name='image_palette_grey'></a> aktive image palette grey

Syntax: __aktive image palette grey__  [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/pattern/palette.tcl)]

Returns a 128x128 image containing a gray palette.


#### <a name='image_palette_grey__examples'></a> Examples

<table>
<tr><th>aktive image palette grey 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00201.gif' alt='aktive image palette grey ' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_sines'></a> aktive image sines

Syntax: __aktive image sines__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/pattern/sines.tcl)]

Returns image containing a sine wave in two dimensions.

The ratio between horizontal and vertical frequencies determines the angle of the composite wave relative to the X axis.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|width|uint||Width of the returned image|
|height|uint||Height of the returned image|
|hf|double||Horizontal frequency|
|vf|double||Vertical frequency|

#### <a name='image_sines__examples'></a> Examples

<table>
<tr><th>aktive image sines width 256 height 256 hf 0.5 vf 0.6
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00232.gif' alt='aktive image sines width 256 height 256 hf 0.5 vf 0.6' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_square'></a> aktive image square

Syntax: __aktive image square__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=17&name=etc/generator/virtual/pattern/selements.tcl)]

Returns single-band white square with radius. Default radius 1.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Radius of the square. Full size is 2*radius + 1.|

#### <a name='image_square__examples'></a> Examples

<table>
<tr><th>aktive image square radius 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00233.gif' alt='aktive image square radius 32' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_stripes'></a> aktive image stripes

Syntax: __aktive image stripes__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=53&name=etc/generator/virtual/pattern/checkers.tcl)]

Returns image containing a series of vertical black/white stripes.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|width|uint||Width of the returned image|
|height|uint||Height of the returned image|
|offset|uint|0|Pattern offset|
|black|uint|8|Width of the black stripe|
|white|uint|8|Width of the white stripe|

#### <a name='image_stripes__examples'></a> Examples

<table>
<tr><th>aktive image stripes width 128 height 128
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00234.gif' alt='aktive image stripes width 128 height 128' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>

<table>
<tr><th>aktive image stripes width 128 height 128 black 16 white 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00235.gif' alt='aktive image stripes width 128 height 128 black 16 white 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>

<table>
<tr><th>aktive image stripes width 128 height 128 black 16 white 32 offset 8
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00236.gif' alt='aktive image stripes width 128 height 128 black 16 white 32 offset 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_vbar'></a> aktive image vbar

Syntax: __aktive image vbar__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a vertical bar. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Radius of the vertical bar.|
|width|uint|0|Width of the element. Default 0. Has to be less or equal to the radius.|

#### <a name='image_vbar__examples'></a> Examples

<table>
<tr><th>aktive image vbar radius 32 width 8
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00285.gif' alt='aktive image vbar radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_xcross'></a> aktive image xcross

Syntax: __aktive image xcross__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=34&name=etc/generator/virtual/pattern/selements.tcl)]

Returns square single-band image containing a diagonal cross. The image has size `2*radius + 1` squared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Radius of the diagonal cross.|
|width|uint|0|Width of the element. Default 0. Has to be less or equal to the radius.|

#### <a name='image_xcross__examples'></a> Examples

<table>
<tr><th>aktive image xcross radius 32 width 8
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00286.gif' alt='aktive image xcross radius 32 width 8' style='border:4px solid gold'>
    <br>geometry(0 0 65 65 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_zone'></a> aktive image zone

Syntax: __aktive image zone__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/pattern/zone.tcl)]

Returns image containing a zone plate test pattern.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|width|uint||Width of the returned image|
|height|uint||Height of the returned image|

#### <a name='image_zone__examples'></a> Examples

<table>
<tr><th>aktive image zone width 256 height 256
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00287.gif' alt='aktive image zone width 256 height 256' style='border:4px solid gold'>
    <br>geometry(0 0 256 256 1)</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- generator virtual drawing

## <anchor='top'> Table Of Contents

  - [generator virtual](generator_virtual.md) ↗


### Operators

 - [aktive image draw box](#image_draw_box)
 - [aktive image draw box-rounded](#image_draw_box_rounded)
 - [aktive image draw circle](#image_draw_circle)
 - [aktive image draw circles](#image_draw_circles)
 - [aktive image draw line](#image_draw_line)
 - [aktive image draw parallelogram](#image_draw_parallelogram)
 - [aktive image draw polyline](#image_draw_polyline)
 - [aktive image draw rhombus](#image_draw_rhombus)
 - [aktive image draw triangle](#image_draw_triangle)

## Operators

---
### [↑](#top) <a name='image_draw_box'></a> aktive image draw box

Syntax: __aktive image draw box__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a box drawn into it.

Beware, the location and size of the box are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a box located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00057.gif' alt='aktive image draw box center {64 64} width 128 height 128 ewidth 32 eheight 32 antialiased 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_box_rounded'></a> aktive image draw box-rounded

Syntax: __aktive image draw box-rounded__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a box drawn into it.

Beware, the location and size of the box are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a box located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00060.gif' alt='aktive image draw box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32 upleftradius 32 antialiased 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_circle'></a> aktive image draw circle

Syntax: __aktive image draw circle__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a circle drawn into it.

Beware, the location and size of the circle are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a circle located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00063.gif' alt='aktive image draw circle center {64 64} width 128 height 128 radius 32 antialiased 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_circles'></a> aktive image draw circles

Syntax: __aktive image draw circles__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a set of circles drawn into it.

Beware, the location and size of the set of circles are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a set of circles located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00066.gif' alt='aktive image draw circles width 128 height 128 radius 8 antialiased 0 centers {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_line'></a> aktive image draw line

Syntax: __aktive image draw line__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a line drawn into it.

Beware, the location and size of the line are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a line located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00069.gif' alt='aktive image draw line width 128 height 128 from {10 10} to {30 80} antialiased 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_parallelogram'></a> aktive image draw parallelogram

Syntax: __aktive image draw parallelogram__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a parallelogram drawn into it.

Beware, the location and size of the parallelogram are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a parallelogram located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00072.gif' alt='aktive image draw parallelogram center {64 64} width 128 height 128 ewidth 32 eheight 32 eskew 8 antialiased 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_polyline'></a> aktive image draw polyline

Syntax: __aktive image draw polyline__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a set of lines drawn into it.

Beware, the location and size of the set of lines are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a set of lines located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00075.gif' alt='aktive image draw polyline width 128 height 128 antialiased 0 points {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_rhombus'></a> aktive image draw rhombus

Syntax: __aktive image draw rhombus__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a rhombus drawn into it.

Beware, the location and size of the rhombus are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a rhombus located completely outside of the image domain.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00078.gif' alt='aktive image draw rhombus center {64 64} width 128 height 128 ewidth 32 eheight 32 antialiased 0' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='image_draw_triangle'></a> aktive image draw triangle

Syntax: __aktive image draw triangle__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=52&name=etc/generator/virtual/draw.tcl)]

Returns an image with the given dimensions and location, with a triangle drawn into it.

Beware, the location and size of the triangle are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a triangle located completely outside of the image domain.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- generator virtual sdf

## <anchor='top'> Table Of Contents

  - [generator virtual](generator_virtual.md) ↗


### Operators

 - [aktive image sdf box](#image_sdf_box)
 - [aktive image sdf box-rounded](#image_sdf_box_rounded)
 - [aktive image sdf circle](#image_sdf_circle)
 - [aktive image sdf circles](#image_sdf_circles)
 - [aktive image sdf line](#image_sdf_line)
 - [aktive image sdf parallelogram](#image_sdf_parallelogram)
 - [aktive image sdf polyline](#image_sdf_polyline)
 - [aktive image sdf rhombus](#image_sdf_rhombus)
 - [aktive image sdf triangle](#image_sdf_triangle)

## Operators

---
### [↑](#top) <a name='image_sdf_box'></a> aktive image sdf box

Syntax: __aktive image sdf box__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a box.

Beware, the location and size of the box are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a box located completely outside of the image domain.

|center|point||Element center|

#### <a name='image_sdf_box__examples'></a> Examples

<table>
<tr><th>aktive image sdf box center {64 64} width 128 height 128 ewidth 32 eheight 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00202.gif' alt='aktive image sdf box center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00203.gif' alt='aktive image sdf box center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00204.gif' alt='aktive image sdf box center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_box_rounded'></a> aktive image sdf box-rounded

Syntax: __aktive image sdf box-rounded__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a box.

Beware, the location and size of the box are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a box located completely outside of the image domain.

|center|point||Element center|

#### <a name='image_sdf_box_rounded__examples'></a> Examples

<table>
<tr><th>aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00205.gif' alt='aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00206.gif' alt='aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00207.gif' alt='aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32 upleftradius 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00208.gif' alt='aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32 upleftradius 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00209.gif' alt='aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32 upleftradius 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00210.gif' alt='aktive image sdf box-rounded center {64 64} width 128 height 128 ewidth 32 eheight 32 upleftradius 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_circle'></a> aktive image sdf circle

Syntax: __aktive image sdf circle__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a circle.

Beware, the location and size of the circle are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a circle located completely outside of the image domain.

|center|point||Element center|

#### <a name='image_sdf_circle__examples'></a> Examples

<table>
<tr><th>aktive image sdf circle center {64 64} width 128 height 128 radius 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00211.gif' alt='aktive image sdf circle center {64 64} width 128 height 128 radius 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00212.gif' alt='aktive image sdf circle center {64 64} width 128 height 128 radius 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00213.gif' alt='aktive image sdf circle center {64 64} width 128 height 128 radius 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_circles'></a> aktive image sdf circles

Syntax: __aktive image sdf circles__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a set of circles.

Beware, the location and size of the set of circles are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a set of circles located completely outside of the image domain.

|centers|point...||Circle centers|

#### <a name='image_sdf_circles__examples'></a> Examples

<table>
<tr><th>aktive image sdf circles width 128 height 128 radius 8 centers {10 10} {30 80} {80 30}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00214.gif' alt='aktive image sdf circles width 128 height 128 radius 8 centers {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00215.gif' alt='aktive image sdf circles width 128 height 128 radius 8 centers {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00216.gif' alt='aktive image sdf circles width 128 height 128 radius 8 centers {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_line'></a> aktive image sdf line

Syntax: __aktive image sdf line__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a line.

Beware, the location and size of the line are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a line located completely outside of the image domain.

|to|point||End location|

#### <a name='image_sdf_line__examples'></a> Examples

<table>
<tr><th>aktive image sdf line width 128 height 128 from {10 10} to {30 80}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00217.gif' alt='aktive image sdf line width 128 height 128 from {10 10} to {30 80}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00218.gif' alt='aktive image sdf line width 128 height 128 from {10 10} to {30 80}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00219.gif' alt='aktive image sdf line width 128 height 128 from {10 10} to {30 80}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_parallelogram'></a> aktive image sdf parallelogram

Syntax: __aktive image sdf parallelogram__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a parallelogram.

Beware, the location and size of the parallelogram are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a parallelogram located completely outside of the image domain.

|center|point||Element center|

#### <a name='image_sdf_parallelogram__examples'></a> Examples

<table>
<tr><th>aktive image sdf parallelogram center {64 64} width 128 height 128 ewidth 32 eheight 32 eskew 8
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00220.gif' alt='aktive image sdf parallelogram center {64 64} width 128 height 128 ewidth 32 eheight 32 eskew 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00221.gif' alt='aktive image sdf parallelogram center {64 64} width 128 height 128 ewidth 32 eheight 32 eskew 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00222.gif' alt='aktive image sdf parallelogram center {64 64} width 128 height 128 ewidth 32 eheight 32 eskew 8' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_polyline'></a> aktive image sdf polyline

Syntax: __aktive image sdf polyline__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a set of lines.

Beware, the location and size of the set of lines are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a set of lines located completely outside of the image domain.

|points|point...||Points of the poly-line|

#### <a name='image_sdf_polyline__examples'></a> Examples

<table>
<tr><th>aktive image sdf polyline width 128 height 128 points {10 10} {30 80} {80 30}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00223.gif' alt='aktive image sdf polyline width 128 height 128 points {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00224.gif' alt='aktive image sdf polyline width 128 height 128 points {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00225.gif' alt='aktive image sdf polyline width 128 height 128 points {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_rhombus'></a> aktive image sdf rhombus

Syntax: __aktive image sdf rhombus__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a rhombus.

Beware, the location and size of the rhombus are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a rhombus located completely outside of the image domain.

|center|point||Element center|

#### <a name='image_sdf_rhombus__examples'></a> Examples

<table>
<tr><th>aktive image sdf rhombus center {64 64} width 128 height 128 ewidth 32 eheight 32
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00226.gif' alt='aktive image sdf rhombus center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00227.gif' alt='aktive image sdf rhombus center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00228.gif' alt='aktive image sdf rhombus center {64 64} width 128 height 128 ewidth 32 eheight 32' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='image_sdf_triangle'></a> aktive image sdf triangle

Syntax: __aktive image sdf triangle__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=75&name=etc/generator/virtual/sdf.tcl)]

Returns an image with the given dimensions and location, containing the signed distance field of a triangle.

Beware, the location and size of the triangle are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a triangle located completely outside of the image domain.

|c|point||Triangle point C|

#### <a name='image_sdf_triangle__examples'></a> Examples

<table>
<tr><th>aktive image sdf triangle width 128 height 128 a {10 10} b {30 80} c {80 30}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>sdf-fit</td><td valign='top'><img src='example-00229.gif' alt='aktive image sdf triangle width 128 height 128 a {10 10} b {30 80} c {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-smooth</td><td valign='top'><img src='example-00230.gif' alt='aktive image sdf triangle width 128 height 128 a {10 10} b {30 80} c {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td><td valign='top'>sdf-pixelated</td><td valign='top'><img src='example-00231.gif' alt='aktive image sdf triangle width 128 height 128 a {10 10} b {30 80} c {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr></table></td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- generator virtual warp

## <anchor='top'> Table Of Contents

  - [generator virtual](generator_virtual.md) ↗


### Operators

 - [aktive transform affine](#transform_affine)

 - [aktive warp noise gauss](#warp_noise_gauss)
 - [aktive warp noise uniform](#warp_noise_uniform)
 - [aktive warp swirl](#warp_swirl)

## Operators

---
### [↑](#top) <a name='transform_affine'></a> aktive transform affine

Syntax: __aktive transform affine__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=686&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image holding the affine transformation specifed by the 6 parameters a to f.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><th>aktive transform affine a 1 b 2 c 3 d 4 e 5 f 6
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>2</td><td>3</td></tr><tr><td>4</td><td>5</td><td>6</td></tr><tr><td>0</td><td>0</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_compose'></a> aktive transform compose

Syntax: __aktive transform compose__ srcs... [[→ definition](../../../../file?ci=trunk&ln=155&name=etc/generator/virtual/warp.tcl)]

Takes any number of 3x3 projective transformation matrices and returns their composition.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

    <td valign='top'><table><tr><td>0.7071</td><td>-0.7071</td><td>0.0000</td></tr><tr><td>0.7071</td><td>0.7071</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>5.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>6.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.7071</td><td>-0.7071</td><td>-5.7071</td></tr><tr><td>0.7071</td><td>0.7071</td><td>1.7782</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_compose_core'></a> aktive transform compose-core

Syntax: __aktive transform compose-core__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=183&name=etc/generator/virtual/warp.tcl)]

Takes two 3x3 projective transformation matrices and returns their composition.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>5.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>6.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.7071</td><td>-0.7071</td><td>0.0000</td></tr><tr><td>0.7071</td><td>0.7071</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.7071</td><td>-0.7071</td><td>5.0000</td></tr><tr><td>0.7071</td><td>0.7071</td><td>6.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_domain'></a> aktive transform domain

Syntax: __aktive transform domain__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=42&name=etc/generator/virtual/warp.tcl)]

Returns the domain generated by applying the transformation (`src0`) to the domain of the image (`src1`). The domain is returned in the same form at as generated by [aktive query domain](accessor_geometry.md#query_domain), i.e. a 4-element Tcl list in the format __{x y w h}__.

Fractions are rounded to integers such that the actual domain is kept enclosed.

This operator is __strict__ in the 1st input. The projective matrix is materialized for the calculation of the domain.


#### <a name='transform_domain__examples'></a> Examples

<table>
<tr><th>@1
    <br>(assets/butterfly.ppm)</th>
    <th>@2
    <br>(rotate by 30)</th>
    <th>aktive transform domain @2 @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00712.gif' alt='@1 (assets/butterfly.ppm)' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><table><tr><td>0.8660</td><td>-0.5000</td><td>0.0000</td></tr><tr><td>0.5000</td><td>0.8660</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'>&nbsp;-124 0 454 407</td></tr>
</table>


---
### [↑](#top) <a name='transform_identity'></a> aktive transform identity

Syntax: __aktive transform identity__  [[→ definition](../../../../file?ci=trunk&ln=220&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image containing the identity transform.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)


#### <a name='transform_identity__examples'></a> Examples

<table>
<tr><th>aktive transform identity 
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_invert'></a> aktive transform invert

Syntax: __aktive transform invert__ src [[→ definition](../../../../file?ci=trunk&ln=124&name=etc/generator/virtual/warp.tcl)]

Takes a single 3x3 projective transformation matrix and returns the matrix of the inverted transformation. This is used to turn forward into backward transformations, and vice versa.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>-5.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>-6.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>-0.0000</td><td>5.0000</td></tr><tr><td>-0.0000</td><td>1.0000</td><td>6.0000</td></tr><tr><td>0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_point'></a> aktive transform point

Syntax: __aktive transform point__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=10&name=etc/generator/virtual/warp.tcl)]

Returns the point generated by the application of the transformation to the input point.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <td valign='top'>&nbsp;7.000000000000001 1.0000000000000004</td>
    <td valign='top'>&nbsp;8.000000000000002 7.000000000000002</td>
    <td valign='top'>&nbsp;1.0000000000000004 7.000000000000002</td></tr>
</table>


---
### [↑](#top) <a name='transform_projective'></a> aktive transform projective

Syntax: __aktive transform projective__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=714&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image holding the projective transformation specifed by the 8 parameters a to h.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><th>aktive transform projective a 1 b 2 c 3 d 4 e 5 f 6 g 7 h 8
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1</td><td>2</td><td>3</td></tr><tr><td>4</td><td>5</td><td>6</td></tr><tr><td>7</td><td>8</td><td>1</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_quad_2quad'></a> aktive transform quad 2quad

Syntax: __aktive transform quad 2quad__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=501&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image transforming the specified quadrilateral A to the second quadrilateral B.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

    <td valign='top'>&nbsp;100.0 125.0</td>
    <td valign='top'>&nbsp;210.00000000000003 80.0</td>
    <td valign='top'>&nbsp;190.0 10.0</td></tr>
</table>


---
### [↑](#top) <a name='transform_quad_unit2'></a> aktive transform quad unit2

Syntax: __aktive transform quad unit2__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=390&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image transforming the unit square to the specified quadrilateral.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>5.0000</td><td>1.0000</td><td>1.0000</td></tr><tr><td>-1.0000</td><td>5.0000</td><td>2.0000</td></tr><tr><td>-0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.1923</td><td>-0.0385</td><td>-0.1154</td></tr><tr><td>0.0385</td><td>0.1923</td><td>-0.4231</td></tr><tr><td>0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_reflect_line'></a> aktive transform reflect line

Syntax: __aktive transform reflect line__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=626&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a reflection along either the line through point A and the origin, or the line through points A and B.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>0.3243</td><td>0.9459</td><td>0.5405</td></tr><tr><td>0.9459</td><td>-0.3243</td><td>-0.7568</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.3243</td><td>0.9459</td><td>0.5405</td></tr><tr><td>0.9459</td><td>-0.3243</td><td>-0.7568</td></tr><tr><td>-0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>-0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_reflect_x'></a> aktive transform reflect x

Syntax: __aktive transform reflect x__  [[→ definition](../../../../file?ci=trunk&ln=576&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a reflection along the x-axis.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>-1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>-1.0000</td><td>0.0000</td><td>-0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>-0.0000</td></tr><tr><td>-0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_reflect_y'></a> aktive transform reflect y

Syntax: __aktive transform reflect y__  [[→ definition](../../../../file?ci=trunk&ln=601&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a reflection along the y-axis.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>-1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>-0.0000</td></tr><tr><td>0.0000</td><td>-1.0000</td><td>0.0000</td></tr><tr><td>-0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_rotate'></a> aktive transform rotate

Syntax: __aktive transform rotate__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=349&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a rotation around the coordinate origin, by the given angle (in degrees).

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>0.7071</td><td>-0.7071</td><td>0.0000</td></tr><tr><td>0.7071</td><td>0.7071</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.7071</td><td>0.7071</td><td>-0.0000</td></tr><tr><td>-0.7071</td><td>0.7071</td><td>-0.0000</td></tr><tr><td>0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_scale'></a> aktive transform scale

Syntax: __aktive transform scale__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=240&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a scaling by x- and y factors.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>3.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.5000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>0.3333</td><td>-0.0000</td><td>0.0000</td></tr><tr><td>-0.0000</td><td>2.0000</td><td>-0.0000</td></tr><tr><td>0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_shear'></a> aktive transform shear

Syntax: __aktive transform shear__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=296&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a shearing along the axes. When both X and Y angles are specified the result will shear X first, then shear Y.

__Beware__ that angles at +/- 90 degrees are poles of infinity.

<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0875</td><td>0.0000</td></tr><tr><td>0.0524</td><td>1.0046</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0046</td><td>-0.0875</td><td>0.0000</td></tr><tr><td>-0.0524</td><td>1.0000</td><td>-0.0000</td></tr><tr><td>0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='transform_translate'></a> aktive transform translate

Syntax: __aktive transform translate__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=268&name=etc/generator/virtual/warp.tcl)]

Returns a single-band 3x3 image specifying a translation by x- and y offsets.

The result is suitable for use with [aktive warp matrix](generator_virtual_warp.md#warp_matrix)

<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>3.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>1.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>-0.0000</td><td>-3.0000</td></tr><tr><td>-0.0000</td><td>1.0000</td><td>-1.0000</td></tr><tr><td>0.0000</td><td>-0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>1.0000</td><td>0.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='warp_matrix'></a> aktive warp matrix

Syntax: __aktive warp matrix__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/warp/matrix.tcl)]

Returns the origin map for the projective transformation specified by the 3x3x1 matrix (`src`) applied to an image of the given geometry and location.

__Attention__. As a origin map declares origin positions for output pixels the matrix has to specify a __backward transformation__.

    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>1.0000</td><td>0.0875</td><td>0.0000</td></tr><tr><td>0.0000</td><td>1.0000</td><td>0.0000</td></tr><tr><td>0.0000</td><td>0.0000</td><td>1.0000</td></tr></table></td>
    <td valign='top'><table><tr><td>(0.0000, 0.0000)</td><td>(1.0000, 0.0000)</td><td>(2.0000, 0.0000)</td><td>(3.0000, 0.0000)</td><td>(4.0000, 0.0000)</td></tr><tr><td>(0.0875, 1.0000)</td><td>(1.0875, 1.0000)</td><td>(2.0875, 1.0000)</td><td>(3.0875, 1.0000)</td><td>(4.0875, 1.0000)</td></tr><tr><td>(0.1750, 2.0000)</td><td>(1.1750, 2.0000)</td><td>(2.1750, 2.0000)</td><td>(3.1750, 2.0000)</td><td>(4.1750, 2.0000)</td></tr><tr><td>(0.2625, 3.0000)</td><td>(1.2625, 3.0000)</td><td>(2.2625, 3.0000)</td><td>(3.2625, 3.0000)</td><td>(4.2625, 3.0000)</td></tr><tr><td>(0.3500, 4.0000)</td><td>(1.3500, 4.0000)</td><td>(2.3500, 4.0000)</td><td>(3.3500, 4.0000)</td><td>(4.3500, 4.0000)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='warp_noise_gauss'></a> aktive warp noise gauss

Syntax: __aktive warp noise gauss__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=42&name=etc/generator/virtual/warp/noise.tcl)]

Returns a origin map derived from the identity map by application of gaussian noise as displacement values.

The result is designed to be usable with the [aktive op warp bicubic](transform_structure_warp.md#op_warp_bicubic) operation and its relatives.

<tr><th>aktive warp noise gauss width 5 height 5 seed 703011174
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>(-2.0121, 1.5892)</td><td>(1.3499, 0.2499)</td><td>(2.7147, -0.1152)</td><td>(3.8782, -1.6135)</td><td>(5.1449, 0.2902)</td></tr><tr><td>(-0.6889, 2.2202)</td><td>(2.3416, -0.5845)</td><td>(1.2220, -0.3694)</td><td>(3.6195, 0.7493)</td><td>(4.7044, 0.2976)</td></tr><tr><td>(0.0954, 2.3508)</td><td>(-1.0648, 0.3407)</td><td>(1.7567, 1.7429)</td><td>(4.3928, 0.8721)</td><td>(3.1299, 2.1653)</td></tr><tr><td>(-0.1816, 2.7917)</td><td>(0.6991, 4.0203)</td><td>(3.5031, 2.0773)</td><td>(2.9707, 1.2286)</td><td>(2.6036, 4.7599)</td></tr><tr><td>(-1.3935, 4.7155)</td><td>(-0.9779, 3.3744)</td><td>(2.9045, 3.9337)</td><td>(5.0461, 5.1393)</td><td>(5.4505, 3.5626)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='warp_noise_uniform'></a> aktive warp noise uniform

Syntax: __aktive warp noise uniform__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/warp/noise.tcl)]

Returns a origin map derived from the identity map by application of uniform noise as displacement values

The result is designed to be usable with the [aktive op warp bicubic](transform_structure_warp.md#op_warp_bicubic) operation and its relatives.

<tr><th>aktive warp noise uniform width 5 height 5 seed 703011174
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td>(0.8863, 0.8719)</td><td>(1.7793, 0.2554)</td><td>(2.4107, 0.5807)</td><td>(3.9289, 0.7495)</td><td>(4.3616, 0.7607)</td></tr><tr><td>(0.3324, 1.3431)</td><td>(1.1898, 1.9291)</td><td>(2.6310, 1.1222)</td><td>(3.3401, 1.4667)</td><td>(4.3098, 1.1832)</td></tr><tr><td>(0.5581, 2.0059)</td><td>(1.9649, 2.9972)</td><td>(2.6588, 2.9941)</td><td>(3.4623, 2.0973)</td><td>(4.0229, 2.5306)</td></tr><tr><td>(0.5197, 3.8011)</td><td>(1.9559, 3.6307)</td><td>(2.3224, 3.6220)</td><td>(3.8149, 3.1401)</td><td>(4.2486, 3.3354)</td></tr><tr><td>(0.5329, 4.0316)</td><td>(1.1691, 4.5186)</td><td>(2.8783, 4.5382)</td><td>(3.5672, 4.7050)</td><td>(4.2872, 4.0349)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='warp_swirl'></a> aktive warp swirl

Syntax: __aktive warp swirl__  ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/generator/virtual/warp/swirl.tcl)]

Returns the origin map for a swirl effect around the specified __center__, with fixed rotation __phi__, a base rotation __from__, and a __decay__ factor.

The rotation angle added to a pixel is given by "__phi__ + __from__ * exp(-__radius__ * __decay__)", where __radius__ is the distance of the pixel from the __center__. A large decay reduces the swirl at shorter radii. A decay of zero disables the decay.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- miscellaneous

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


## Subsections


 - [miscellaneous geometry](miscellaneous_geometry.md) ↘

### Operators

 - [aktive error](#error)
 - [aktive processors](#processors)
 - [aktive version](#version)

## Operators

---
### [↑](#top) <a name='error'></a> aktive error

Syntax: __aktive error__ m args... [[→ definition](../../../../file?ci=trunk&ln=198&name=etc/aktive.tcl)]

Throw error with message and error code.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|m|str||Human readable error message|
|args|str...||Trappable error code suffix|

---
### [↑](#top) <a name='processors'></a> aktive processors

Syntax: __aktive processors__ n [[→ definition](../../../../file?ci=trunk&ln=215&name=etc/aktive.tcl)]

Set/Return number of processor cores available for concurrent operation.

Setting the default, `0`, causes the system to query the OS for the number of available processors and use the result. Anything else limits concurrency to the defined count. __Beware__ overcommit is possible, if more processors are declared for use than actually exist.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|n|int|0|Set number of processor available for concurrent operation.|

---
### [↑](#top) <a name='version'></a> aktive version

Syntax: __aktive version__  [[→ definition](../../../../file?ci=trunk&ln=208&name=etc/aktive.tcl)]

Return package version number.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- miscellaneous geometry

## <anchor='top'> Table Of Contents

  - [miscellaneous](miscellaneous.md) ↗


### Operators

 - [aktive point add](#point_add)

 - [aktive rectangle subset](#rectangle_subset)
 - [aktive rectangle union](#rectangle_union)
 - [aktive rectangle zones](#rectangle_zones)

## Operators

---
### [↑](#top) <a name='point_add'></a> aktive point add

Syntax: __aktive point add__ point delta [[→ definition](../../../../file?ci=trunk&ln=22&name=etc/other/point.tcl)]

Translate a 2D point by a specific amount given as 2D vector

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|point|point||Point to modify|
|delta|point||Point to add|

#### <a name='point_add__examples'></a> Examples

<table>
<tr><th>aktive point add {11 23} {-1 7}
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;10 30</td></tr>
</table>


---
### [↑](#top) <a name='point_box'></a> aktive point box

Syntax: __aktive point box__ points... [[→ definition](../../../../file?ci=trunk&ln=59&name=etc/other/point.tcl)]

Compute minimum axis-aligned 2D rectangle enclosing the set of 2D points

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|points|point...||Points to find the bounding box for|

#### <a name='point_box__examples'></a> Examples

<table>
<tr><th>aktive point box {11 23} {45 5} {5 45}
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;5 5 41 41</td></tr>
</table>


---
### [↑](#top) <a name='point_make'></a> aktive point make

Syntax: __aktive point make__ x y [[→ definition](../../../../file?ci=trunk&ln=6&name=etc/other/point.tcl)]

Construct a 2D point from x- and y-coordinates

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|x|int||Point location, Column|
|y|int||Point location, Row|

#### <a name='point_make__examples'></a> Examples

<table>
<tr><th>aktive point make 11 23
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;11 23</td></tr>
</table>


---
### [↑](#top) <a name='point_move'></a> aktive point move

Syntax: __aktive point move__ point dx dy [[→ definition](../../../../file?ci=trunk&ln=40&name=etc/other/point.tcl)]

Translate a 2D point by a specific amount given as separate x- and y-deltas

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive point move {11 23} -1 7
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;10 30</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_empty'></a> aktive rectangle empty

Syntax: __aktive rectangle empty__ rect [[→ definition](../../../../file?ci=trunk&ln=99&name=etc/other/rectangle.tcl)]

Test a 2D rectangle for emptiness

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive rectangle empty {11 23 0 0}
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;1</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_equal'></a> aktive rectangle equal

Syntax: __aktive rectangle equal__ a b [[→ definition](../../../../file?ci=trunk&ln=70&name=etc/other/rectangle.tcl)]

Test two 2D rectangles for equality (location and dimensions)

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive rectangle equal {11 23 30 20} {11 23 10 20}
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;0</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_grow'></a> aktive rectangle grow

Syntax: __aktive rectangle grow__ rect left right top bottom [[→ definition](../../../../file?ci=trunk&ln=26&name=etc/other/rectangle.tcl)]

Modify 2D rectangle by moving its 4 borders by a specific amount

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive rectangle grow {11 23 30 20} 1 7 5 10
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;10 18 38 35</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_intersect'></a> aktive rectangle intersect

Syntax: __aktive rectangle intersect__ rects... [[→ definition](../../../../file?ci=trunk&ln=139&name=etc/other/rectangle.tcl)]

Compute the maximum axis-aligned 2D rectangle shared by all input rectangles

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|rects|rect...||Rectangles to intersect|

---
### [↑](#top) <a name='rectangle_make'></a> aktive rectangle make

Syntax: __aktive rectangle make__ x y w h [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/other/rectangle.tcl)]

Construct a 2D rectangle from x- and y-coordinates and width/height dimensions

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive rectangle make 11 23 30 20
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;11 23 30 20</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_move'></a> aktive rectangle move

Syntax: __aktive rectangle move__ rect dx dy [[→ definition](../../../../file?ci=trunk&ln=49&name=etc/other/rectangle.tcl)]

Translate a 2D rectangle by a specific amount given as separate x- and y-deltas

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive rectangle move {11 23 30 20} -5 7
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;6 30 30 20</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_subset'></a> aktive rectangle subset

Syntax: __aktive rectangle subset__ a b [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/other/rectangle.tcl)]

Test if the first 2D rectangle is a subset of the second.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<tr><th>aktive rectangle subset {11 23 30 20} {10 20 40 25}
    <br>&nbsp;</th></tr>
<tr><td valign='top'>&nbsp;1</td></tr>
</table>


---
### [↑](#top) <a name='rectangle_union'></a> aktive rectangle union

Syntax: __aktive rectangle union__ rects... [[→ definition](../../../../file?ci=trunk&ln=114&name=etc/other/rectangle.tcl)]

Compute the minimum axis-aligned 2D rectangle encompassing all input rectangles

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|rects|rect...||Rectangles to union|

---
### [↑](#top) <a name='rectangle_zones'></a> aktive rectangle zones

Syntax: __aktive rectangle zones__ domain request [[→ definition](../../../../file?ci=trunk&ln=166&name=etc/other/rectangle.tcl)]

Compute a set of 2D rectangles describing the relation of the request to the domain.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|domain|rect||Area covered by image pixels|
|request|rect||Area to get the pixels for|

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- sink

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


## Subsections

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- sink statistics

## <anchor='top'> Table Of Contents

  - [sink](sink.md) ↗


### Operators

 - [aktive op compare mse](#op_compare_mse)

 - [aktive op image sum](#op_image_sum)
 - [aktive op image sumsquared](#op_image_sumsquared)
 - [aktive op image variance](#op_image_variance)

## Operators

---
### [↑](#top) <a name='op_compare_mse'></a> aktive op compare mse

Syntax: __aktive op compare mse__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/sink/compare.tcl)]

Compares the two input images and returns the MSE metric for their difference

This operator is __strict__ in both inputs. The computed pixels are not materialized. They are immediately used for the comparison and then discarded.


---
### [↑](#top) <a name='op_compare_rmse'></a> aktive op compare rmse

Syntax: __aktive op compare rmse__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/sink/compare.tcl)]

Compares the two input images and returns the RMSE metric for their difference

This operator is __strict__ in both inputs. The computed pixels are not materialized. They are immediately used for the comparison and then discarded.


---
### [↑](#top) <a name='op_image_max'></a> aktive op image max

Syntax: __aktive op image max__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the maximum of the values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.


---
### [↑](#top) <a name='op_image_mean'></a> aktive op image mean

Syntax: __aktive op image mean__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the arithmetic mean of the values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.


---
### [↑](#top) <a name='op_image_mean_stddev'></a> aktive op image mean-stddev

Syntax: __aktive op image mean-stddev__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=74&name=etc/sink/statistics.tcl)]

Returns a 2-element list containing lower and upper bounds for the image values, based on the image's mean and a multiple of its standard deviation.

This operator is __strict__ in its single input. The computed pixels are not materialized and just used for the calculation of the statistics.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|sigma|double|1.2|Interval around the mean to return.|

---
### [↑](#top) <a name='op_image_min'></a> aktive op image min

Syntax: __aktive op image min__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the minimum of the values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.


---
### [↑](#top) <a name='op_image_min_max'></a> aktive op image min-max

Syntax: __aktive op image min-max__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=44&name=etc/sink/statistics.tcl)]

Returns a 2-element list containing the min and max of the image, in this order.

The results can be modified by setting lower and upper percentiles.

This operator is __strict__ in its single input. The computed pixels are not materialized and just used for the for the calculation of the statistics.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|upper|double|1|Upper percentile to apply to max. Default is 100%|
|lower|double|0|Lower percentile to apply to min. Default is 0%|

---
### [↑](#top) <a name='op_image_stddev'></a> aktive op image stddev

Syntax: __aktive op image stddev__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the standard deviation of the values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.


---
### [↑](#top) <a name='op_image_sum'></a> aktive op image sum

Syntax: __aktive op image sum__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the sum of the values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.


---
### [↑](#top) <a name='op_image_sumsquared'></a> aktive op image sumsquared

Syntax: __aktive op image sumsquared__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the sum of the squared values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.


---
### [↑](#top) <a name='op_image_variance'></a> aktive op image variance

Syntax: __aktive op image variance__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/sink/statistics.tcl)]

Returns a single value, the variance of the values (across all rows, columns, and bands)

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately used for the calculation of the statistic and then discarded.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- sink writer

## <anchor='top'> Table Of Contents

  - [sink](sink.md) ↗


### Operators

 - [aktive format as aktive 2chan](#format_as_aktive_2chan)

 - [aktive format as ppm text 2file](#format_as_ppm_text_2file)
 - [aktive format as ppm text 2string](#format_as_ppm_text_2string)
 - [aktive format as tcl](#format_as_tcl)

## Operators

---
### [↑](#top) <a name='format_as_aktive_2chan'></a> aktive format as aktive 2chan

Syntax: __aktive format as aktive 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=29&name=etc/sink/aktive.tcl)]

Writes image to the DST channel, serialized with the [AKTIVE](ff-aktive.md) format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the image data is written to|

---
### [↑](#top) <a name='format_as_aktive_2file'></a> aktive format as aktive 2file

Syntax: __aktive format as aktive 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/aktive.tcl)]

Writes image to the destination file, serialized with the [AKTIVE](ff-aktive.md) format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the image data is written to.|

---
### [↑](#top) <a name='format_as_aktive_2string'></a> aktive format as aktive 2string

Syntax: __aktive format as aktive 2string__ src [[→ definition](../../../../file?ci=trunk&ln=58&name=etc/sink/aktive.tcl)]

Returns byte array containing the image, serialized with the [AKTIVE](ff-aktive.md) format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_null_s_2string'></a> aktive format as null-s 2string

Syntax: __aktive format as null-s 2string__ src [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/null.tcl)]

Returns nothing, while triggering full pixel calculation for the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are ignored, immediately discarded.


---
### [↑](#top) <a name='format_as_null_2string'></a> aktive format as null 2string

Syntax: __aktive format as null 2string__ src [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/null.tcl)]

Returns nothing, while triggering full pixel calculation for the input.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are ignored, immediately discarded.


---
### [↑](#top) <a name='format_as_pgm_byte_2chan'></a> aktive format as pgm byte 2chan

Syntax: __aktive format as pgm byte 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PGM](ff-netpbm.md)'s byte format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the pgm byte image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_byte_2file'></a> aktive format as pgm byte 2file

Syntax: __aktive format as pgm byte 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PGM](ff-netpbm.md)'s byte format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the pgm byte image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_byte_2string'></a> aktive format as pgm byte 2string

Syntax: __aktive format as pgm byte 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PGM](ff-netpbm.md)'s byte format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_pgm_etext_2chan'></a> aktive format as pgm etext 2chan

Syntax: __aktive format as pgm etext 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PGM](ff-netpbm.md)'s etext format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the pgm etext image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_etext_2file'></a> aktive format as pgm etext 2file

Syntax: __aktive format as pgm etext 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PGM](ff-netpbm.md)'s etext format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the pgm etext image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_etext_2string'></a> aktive format as pgm etext 2string

Syntax: __aktive format as pgm etext 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PGM](ff-netpbm.md)'s etext format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_pgm_short_2chan'></a> aktive format as pgm short 2chan

Syntax: __aktive format as pgm short 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PGM](ff-netpbm.md)'s short format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the pgm short image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_short_2file'></a> aktive format as pgm short 2file

Syntax: __aktive format as pgm short 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PGM](ff-netpbm.md)'s short format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the pgm short image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_short_2string'></a> aktive format as pgm short 2string

Syntax: __aktive format as pgm short 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PGM](ff-netpbm.md)'s short format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_pgm_text_2chan'></a> aktive format as pgm text 2chan

Syntax: __aktive format as pgm text 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PGM](ff-netpbm.md)'s text format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the pgm text image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_text_2file'></a> aktive format as pgm text 2file

Syntax: __aktive format as pgm text 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PGM](ff-netpbm.md)'s text format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the pgm text image data is written to.|

---
### [↑](#top) <a name='format_as_pgm_text_2string'></a> aktive format as pgm text 2string

Syntax: __aktive format as pgm text 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PGM](ff-netpbm.md)'s text format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_ppm_byte_2chan'></a> aktive format as ppm byte 2chan

Syntax: __aktive format as ppm byte 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PPM](ff-netpbm.md)'s byte format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the ppm byte image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_byte_2file'></a> aktive format as ppm byte 2file

Syntax: __aktive format as ppm byte 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PPM](ff-netpbm.md)'s byte format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the ppm byte image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_byte_2string'></a> aktive format as ppm byte 2string

Syntax: __aktive format as ppm byte 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PPM](ff-netpbm.md)'s byte format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_ppm_etext_2chan'></a> aktive format as ppm etext 2chan

Syntax: __aktive format as ppm etext 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PPM](ff-netpbm.md)'s etext format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the ppm etext image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_etext_2file'></a> aktive format as ppm etext 2file

Syntax: __aktive format as ppm etext 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PPM](ff-netpbm.md)'s etext format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the ppm etext image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_etext_2string'></a> aktive format as ppm etext 2string

Syntax: __aktive format as ppm etext 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PPM](ff-netpbm.md)'s etext format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_ppm_short_2chan'></a> aktive format as ppm short 2chan

Syntax: __aktive format as ppm short 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PPM](ff-netpbm.md)'s short format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the ppm short image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_short_2file'></a> aktive format as ppm short 2file

Syntax: __aktive format as ppm short 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PPM](ff-netpbm.md)'s short format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the ppm short image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_short_2string'></a> aktive format as ppm short 2string

Syntax: __aktive format as ppm short 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PPM](ff-netpbm.md)'s short format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_ppm_text_2chan'></a> aktive format as ppm text 2chan

Syntax: __aktive format as ppm text 2chan__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=38&name=etc/sink/netpbm.tcl)]

Writes image to the destination channel, serialized with [PPM](ff-netpbm.md)'s text format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|channel||Destination channel the ppm text image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_text_2file'></a> aktive format as ppm text 2file

Syntax: __aktive format as ppm text 2file__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/netpbm.tcl)]

Writes image to the destination file, serialized with [PPM](ff-netpbm.md)'s text format.

This operator is __strict__ in its single input. The computed pixels are not materialized. They are immediately saved to the destination file.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|into|str||Destination file the ppm text image data is written to.|

---
### [↑](#top) <a name='format_as_ppm_text_2string'></a> aktive format as ppm text 2string

Syntax: __aktive format as ppm text 2string__ src [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/sink/netpbm.tcl)]

Returns byte array containing the image, serialized with [PPM](ff-netpbm.md)'s text format.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.


---
### [↑](#top) <a name='format_as_tcl'></a> aktive format as tcl

Syntax: __aktive format as tcl__ src [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/sink/astcl.tcl)]

Returns string containing the image serialized into readable Tcl structures. Dictionary with flat pixel list.

This operator is __strict__ in its single input. The computed pixels __are__ materialized into the returned string.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform

## <anchor='top'> Table Of Contents

  - [Roots](bysection.md) ↗


## Subsections

 - [aktive op bands recombine](#op_bands_recombine)
 - [aktive op view](#op_view)

## Operators

---
### [↑](#top) <a name='op_bands_recombine'></a> aktive op bands recombine

Syntax: __aktive op bands recombine__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/transformer/filter/recombine.tcl)]

Returns image with the input's band information recombined through a matrix-vector multiplication.

The band values of the input pixels are the vectors which are multiplied with the matrix specified as the first image argument. The input to be processed is the second image argument.

The matrix has to be single-band and its height has to match the depth of the input. The width of the matrix becomes the depth of the result.

The location of the matrix image is ignored.


---
### [↑](#top) <a name='op_view'></a> aktive op view

Syntax: __aktive op view__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=5&name=etc/transformer/viewport.tcl)]

Returns image arbitrarily offset and sized compared to the input domain. In other words, an arbitrary rectangular view (port) into the input.

Beware, the requested area may fall __anywhere__ with respect to the input's domain. Same, inside (subset), outside, partially overlapping, etc.

This is useful to add after an application of [aktive op transform by](transform_structure_warp.md#op_transform_by), as a means of focusing on the desired part of the transformation's result.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|port|rect||The specific area to view in the plane. A rectangle of the form {x y w h}.|

#### <a name='op_view__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op view @1 port {190 125 380 250}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00607.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00608.gif' alt='aktive op view @1 port {190 125 380 250}' style='border:4px solid gold'>
    <br>geometry(190 125 380 250 3)</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op view @1 port {-190 -125 380 250}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00609.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00610.gif' alt='aktive op view @1 port {-190 -125 380 250}' style='border:4px solid gold'>
    <br>geometry(-190 -125 380 250 3)</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op view @1 port {80 80 80 80}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00611.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00612.gif' alt='aktive op view @1 port {80 80 80 80}' style='border:4px solid gold'>
    <br>geometry(80 80 80 80 3)</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform color

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op color correct greyworld global](#op_color_correct_greyworld_global)

 - [aktive op color Yxy to scRGB](#op_color_Yxy_to_scRGB)
 - [aktive op color Yxy to sRGB](#op_color_Yxy_to_sRGB)
 - [aktive op color Yxy to XYZ](#op_color_Yxy_to_XYZ)

## Operators

---
### [↑](#top) <a name='op_color_correct_greyworld_global'></a> aktive op color correct greyworld global

Syntax: __aktive op color correct greyworld global__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=9&name=etc/transformer/color/recast.tcl)]

Corrects a color cast in the input using a global grey world assumption and returns the result.

Accepts inputs in the `sRGB` and `scRGB` color spaces, and returns a result in the same space.

The actual correction is always done in the `scRGB` space, i.e. with linear colors.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|mean|double|{}|Use as a fixed global mean, if specified. Else use the actual global mean for the input.|

---
### [↑](#top) <a name='op_color_correct_greyworld_local'></a> aktive op color correct greyworld local

Syntax: __aktive op color correct greyworld local__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=65&name=etc/transformer/color/recast.tcl)]

Corrects a color cast in the input using a local grey world assumption and returns the result.

Accepts inputs in the `sRGB` and `scRGB` color spaces, and returns a result in the same space.

The actual correction is always done in the `scRGB` space, i.e. with linear colors.

The size of the window/tile used to compute local conditions is set by radius. The default is 10.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|10|Tile size as radius from center. Full width and height of the tile are `2*radius+1`. Default value is 10.|
|mean|double|{}|Use as a fixed xglobal mean, if specified. Else use the actual xglobal mean for the input.|

---
### [↑](#top) <a name='op_color_HSL_to_Grey'></a> aktive op color HSL to Grey

Syntax: __aktive op color HSL to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Grey colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_HSV'></a> aktive op color HSL to HSV

Syntax: __aktive op color HSL to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in HSV colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_Lab'></a> aktive op color HSL to Lab

Syntax: __aktive op color HSL to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Lab colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_LCh'></a> aktive op color HSL to LCh

Syntax: __aktive op color HSL to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in LCh colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_scRGB'></a> aktive op color HSL to scRGB

Syntax: __aktive op color HSL to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in scRGB colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_sRGB'></a> aktive op color HSL to sRGB

Syntax: __aktive op color HSL to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=90&name=etc/transformer/color/hsl-srgb.tcl)]

Returns image in sRGB colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_XYZ'></a> aktive op color HSL to XYZ

Syntax: __aktive op color HSL to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in XYZ colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSL_to_Yxy'></a> aktive op color HSL to Yxy

Syntax: __aktive op color HSL to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Yxy colorspace, from input in HSL colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_Grey'></a> aktive op color HSV to Grey

Syntax: __aktive op color HSV to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Grey colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_HSL'></a> aktive op color HSV to HSL

Syntax: __aktive op color HSV to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSL colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_Lab'></a> aktive op color HSV to Lab

Syntax: __aktive op color HSV to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Lab colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_LCh'></a> aktive op color HSV to LCh

Syntax: __aktive op color HSV to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in LCh colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_scRGB'></a> aktive op color HSV to scRGB

Syntax: __aktive op color HSV to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in scRGB colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_sRGB'></a> aktive op color HSV to sRGB

Syntax: __aktive op color HSV to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=87&name=etc/transformer/color/hsv-srgb.tcl)]

Returns image in sRGB colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_XYZ'></a> aktive op color HSV to XYZ

Syntax: __aktive op color HSV to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in XYZ colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_HSV_to_Yxy'></a> aktive op color HSV to Yxy

Syntax: __aktive op color HSV to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Yxy colorspace, from input in HSV colorspace.


---
### [↑](#top) <a name='op_color_Lab_to_Grey'></a> aktive op color Lab to Grey

Syntax: __aktive op color Lab to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=133&name=etc/transformer/color/xyz-lab.tcl)]

Returns image converted to greyscale, from input in Lab colorspace.

The gray data is just the Y channel of a conversion to XYZ colorspace. A separate operator is used to completely avoid the calculation of the unwanted XZ data.

This conversion is based on the (1,1,1) reference white.

For a different whitepoint scale the greyscale by the associated illuminant value after performing the conversion.


---
### [↑](#top) <a name='op_color_Lab_to_HSL'></a> aktive op color Lab to HSL

Syntax: __aktive op color Lab to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSL colorspace, from input in Lab colorspace.


---
### [↑](#top) <a name='op_color_Lab_to_HSV'></a> aktive op color Lab to HSV

Syntax: __aktive op color Lab to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSV colorspace, from input in Lab colorspace.


---
### [↑](#top) <a name='op_color_Lab_to_LCh'></a> aktive op color Lab to LCh

Syntax: __aktive op color Lab to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=9&name=etc/transformer/color/lab-lch.tcl)]

Returns image in LCh colorspace, from input in Lab colorspace.

The H coordinate is provided in degrees.


---
### [↑](#top) <a name='op_color_Lab_to_scRGB'></a> aktive op color Lab to scRGB

Syntax: __aktive op color Lab to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in scRGB colorspace, from input in Lab colorspace.


---
### [↑](#top) <a name='op_color_Lab_to_sRGB'></a> aktive op color Lab to sRGB

Syntax: __aktive op color Lab to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in sRGB colorspace, from input in Lab colorspace.


---
### [↑](#top) <a name='op_color_Lab_to_XYZ'></a> aktive op color Lab to XYZ

Syntax: __aktive op color Lab to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=9&name=etc/transformer/color/xyz-lab.tcl)]

Returns image in XYZ colorspace, from input in Lab colorspace.

This conversion is based on the (1,1,1) reference white.

For a different whitepoint scale the XYZ bands by the associated illuminant values after performing the conversion.


---
### [↑](#top) <a name='op_color_Lab_to_Yxy'></a> aktive op color Lab to Yxy

Syntax: __aktive op color Lab to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in Yxy colorspace, from input in Lab colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_Grey'></a> aktive op color LCh to Grey

Syntax: __aktive op color LCh to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Grey colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_HSL'></a> aktive op color LCh to HSL

Syntax: __aktive op color LCh to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSL colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_HSV'></a> aktive op color LCh to HSV

Syntax: __aktive op color LCh to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSV colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_Lab'></a> aktive op color LCh to Lab

Syntax: __aktive op color LCh to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/color/lab-lch.tcl)]

Returns image in Lab colorspace, from input in LCH colorspace.

The H coordinate is expected to be in degrees.


---
### [↑](#top) <a name='op_color_LCh_to_scRGB'></a> aktive op color LCh to scRGB

Syntax: __aktive op color LCh to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in scRGB colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_sRGB'></a> aktive op color LCh to sRGB

Syntax: __aktive op color LCh to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in sRGB colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_XYZ'></a> aktive op color LCh to XYZ

Syntax: __aktive op color LCh to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in XYZ colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_LCh_to_Yxy'></a> aktive op color LCh to Yxy

Syntax: __aktive op color LCh to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in Yxy colorspace, from input in LCh colorspace.


---
### [↑](#top) <a name='op_color_scRGB_to_Grey'></a> aktive op color scRGB to Grey

Syntax: __aktive op color scRGB to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=150&name=etc/transformer/color/scrgb-xyz.tcl)]

Returns input converted to grey scale, from input in scRGB colorspace.

The gray data is just the Y channel of a conversion to XYZ colorspace. A separate operator is used to completely avoid the calculation of the unwanted XZ data.


---
### [↑](#top) <a name='op_color_scRGB_to_HSL'></a> aktive op color scRGB to HSL

Syntax: __aktive op color scRGB to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSL colorspace, from input in scRGB colorspace.


---
### [↑](#top) <a name='op_color_scRGB_to_HSV'></a> aktive op color scRGB to HSV

Syntax: __aktive op color scRGB to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSV colorspace, from input in scRGB colorspace.


---
### [↑](#top) <a name='op_color_scRGB_to_Lab'></a> aktive op color scRGB to Lab

Syntax: __aktive op color scRGB to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Lab colorspace, from input in scRGB colorspace.


---
### [↑](#top) <a name='op_color_scRGB_to_LCh'></a> aktive op color scRGB to LCh

Syntax: __aktive op color scRGB to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in LCh colorspace, from input in scRGB colorspace.


---
### [↑](#top) <a name='op_color_scRGB_to_sRGB'></a> aktive op color scRGB to sRGB

Syntax: __aktive op color scRGB to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/transformer/color/srgb-scrgb.tcl)]

Returns image in sRGB colorspace, from input in scRGB colorspace. Linear light becomes (gamma) compressed light.


---
### [↑](#top) <a name='op_color_scRGB_to_XYZ'></a> aktive op color scRGB to XYZ

Syntax: __aktive op color scRGB to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=9&name=etc/transformer/color/scrgb-xyz.tcl)]

Returns image in XYZ colorspace, from input in scRGB colorspace.


---
### [↑](#top) <a name='op_color_scRGB_to_Yxy'></a> aktive op color scRGB to Yxy

Syntax: __aktive op color scRGB to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Yxy colorspace, from input in scRGB colorspace.


---
### [↑](#top) <a name='op_color_set'></a> aktive op color set

Syntax: __aktive op color set__ src colorspace [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/color/non-core.tcl)]

Forcibly sets the colorspace attribute of the input image to the specified value

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|colorspace|str||New colorspace to assume|

---
### [↑](#top) <a name='op_color_sRGB_to_Grey'></a> aktive op color sRGB to Grey

Syntax: __aktive op color sRGB to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Grey colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_sRGB_to_HSL'></a> aktive op color sRGB to HSL

Syntax: __aktive op color sRGB to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=13&name=etc/transformer/color/hsl-srgb.tcl)]

Returns image in HSL colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_sRGB_to_HSV'></a> aktive op color sRGB to HSV

Syntax: __aktive op color sRGB to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=13&name=etc/transformer/color/hsv-srgb.tcl)]

Returns image in HSV colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_sRGB_to_Lab'></a> aktive op color sRGB to Lab

Syntax: __aktive op color sRGB to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Lab colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_sRGB_to_LCh'></a> aktive op color sRGB to LCh

Syntax: __aktive op color sRGB to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in LCh colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_sRGB_to_scRGB'></a> aktive op color sRGB to scRGB

Syntax: __aktive op color sRGB to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=22&name=etc/transformer/color/srgb-scrgb.tcl)]

Returns image in scRGB colorspace, from input in sRGB colorspace. (gamma) compressed light becomes linear light.


---
### [↑](#top) <a name='op_color_sRGB_to_XYZ'></a> aktive op color sRGB to XYZ

Syntax: __aktive op color sRGB to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in XYZ colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_sRGB_to_Yxy'></a> aktive op color sRGB to Yxy

Syntax: __aktive op color sRGB to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Yxy colorspace, from input in sRGB colorspace.


---
### [↑](#top) <a name='op_color_XYZ_to_Grey'></a> aktive op color XYZ to Grey

Syntax: __aktive op color XYZ to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=136&name=etc/transformer/color/scrgb-xyz.tcl)]

Returns input converted to grey scale, from input in XYZ colorspace.

The gray data is just the Y channel of the input.


---
### [↑](#top) <a name='op_color_XYZ_to_HSL'></a> aktive op color XYZ to HSL

Syntax: __aktive op color XYZ to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSL colorspace, from input in XYZ colorspace.


---
### [↑](#top) <a name='op_color_XYZ_to_HSV'></a> aktive op color XYZ to HSV

Syntax: __aktive op color XYZ to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSV colorspace, from input in XYZ colorspace.


---
### [↑](#top) <a name='op_color_XYZ_to_Lab'></a> aktive op color XYZ to Lab

Syntax: __aktive op color XYZ to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=71&name=etc/transformer/color/xyz-lab.tcl)]

Returns image in Lab colorspace, from input in XYZ colorspace.

This conversion is based on the (1,1,1) reference white.

For a different whitepoint divide the XYZ bands by the associated illuminant values before performing the conversion.


---
### [↑](#top) <a name='op_color_XYZ_to_LCh'></a> aktive op color XYZ to LCh

Syntax: __aktive op color XYZ to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in LCh colorspace, from input in XYZ colorspace.


---
### [↑](#top) <a name='op_color_XYZ_to_scRGB'></a> aktive op color XYZ to scRGB

Syntax: __aktive op color XYZ to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=70&name=etc/transformer/color/scrgb-xyz.tcl)]

Returns image in scRGB colorspace, from input in XYZ colorspace.


---
### [↑](#top) <a name='op_color_XYZ_to_sRGB'></a> aktive op color XYZ to sRGB

Syntax: __aktive op color XYZ to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in sRGB colorspace, from input in XYZ colorspace.


---
### [↑](#top) <a name='op_color_XYZ_to_Yxy'></a> aktive op color XYZ to Yxy

Syntax: __aktive op color XYZ to Yxy__ src [[→ definition](../../../../file?ci=trunk&ln=65&name=etc/transformer/color/xyz-yxy.tcl)]

Returns image in Yxy colorspace, from input in XYZ colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_Grey'></a> aktive op color Yxy to Grey

Syntax: __aktive op color Yxy to Grey__ src [[→ definition](../../../../file?ci=trunk&ln=126&name=etc/transformer/color/xyz-yxy.tcl)]

Returns image converted to grey scale, from input in Yxy colorspace.

The gray data is just the Y channel of a conversion to XYZ colorspace. A separate operator is used to completely avoid the calculation of the unwanted XZ data.


---
### [↑](#top) <a name='op_color_Yxy_to_HSL'></a> aktive op color Yxy to HSL

Syntax: __aktive op color Yxy to HSL__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSL colorspace, from input in Yxy colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_HSV'></a> aktive op color Yxy to HSV

Syntax: __aktive op color Yxy to HSV__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in HSV colorspace, from input in Yxy colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_Lab'></a> aktive op color Yxy to Lab

Syntax: __aktive op color Yxy to Lab__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in Lab colorspace, from input in Yxy colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_LCh'></a> aktive op color Yxy to LCh

Syntax: __aktive op color Yxy to LCh__ src [[→ definition](../../../../file?ci=trunk&ln=72&name=etc/transformer/color/non-core.tcl)]

Returns image in LCh colorspace, from input in Yxy colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_scRGB'></a> aktive op color Yxy to scRGB

Syntax: __aktive op color Yxy to scRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in scRGB colorspace, from input in Yxy colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_sRGB'></a> aktive op color Yxy to sRGB

Syntax: __aktive op color Yxy to sRGB__ src [[→ definition](../../../../file?ci=trunk&ln=96&name=etc/transformer/color/non-core.tcl)]

Returns image in sRGB colorspace, from input in Yxy colorspace.


---
### [↑](#top) <a name='op_color_Yxy_to_XYZ'></a> aktive op color Yxy to XYZ

Syntax: __aktive op color Yxy to XYZ__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/transformer/color/xyz-yxy.tcl)]

Returns image in XYZ colorspace, from input in Yxy colorspace.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform convolution

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op convolve xy](#op_convolve_xy)

## Operators

---
### [↑](#top) <a name='op_convolve_xy'></a> aktive op convolve xy

Syntax: __aktive op convolve xy__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=15&name=etc/transformer/filter/convolve.tcl)]

Returns image of input (2nd argument) convolved with the matrix (1st argument).

This operator is __strict__ in the 1st input. The convolution kernel is materialized and cached.

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>aktive op convolve xy @2 @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00339.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><table><tr><td>0.0078</td><td>0.0625</td><td>0.2188</td><td>0.4375</td><td>0.5469</td><td>0.4375</td><td>0.2188</td><td>0.0625</td><td>0.0078</td></tr></table></td>
    <td valign='top'><img src='example-00341.gif' alt='aktive op convolve xy @2 @1' style='border:4px solid gold'>
    <br>geometry(4 0 120 128 1)</td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>@2
    <br>&nbsp;</th>
    <th>aktive op convolve xy @2 @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00342.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><table><tr><td>0.0078</td></tr><tr><td>0.0625</td></tr><tr><td>0.2188</td></tr><tr><td>0.4375</td></tr><tr><td>0.5469</td></tr><tr><td>0.4375</td></tr><tr><td>0.2188</td></tr><tr><td>0.0625</td></tr><tr><td>0.0078</td></tr></table></td>
    <td valign='top'><img src='example-00344.gif' alt='aktive op convolve xy @2 @1' style='border:4px solid gold'>
    <br>geometry(0 4 128 120 1)</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform drawing

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op draw box-rounded on](#op_draw_box_rounded_on)
 - [aktive op draw box on](#op_draw_box_on)
 - [aktive op draw circle on](#op_draw_circle_on)
 - [aktive op draw circles on](#op_draw_circles_on)
 - [aktive op draw line on](#op_draw_line_on)
 - [aktive op draw parallelogram on](#op_draw_parallelogram_on)
 - [aktive op draw polyline on](#op_draw_polyline_on)
 - [aktive op draw rhombus on](#op_draw_rhombus_on)
 - [aktive op draw triangle on](#op_draw_triangle_on)

## Operators

---
### [↑](#top) <a name='op_draw_box_rounded_on'></a> aktive op draw box-rounded on

Syntax: __aktive op draw box-rounded on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a box is drawn on the input image.

Beware, the location and size of the box are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a box located completely outside of the image domain.

#### <a name='op_draw_box_rounded_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw box-rounded on @1 center {64 64} ewidth 32 eheight 32 upleftradius 32 outlined 1 color {1 0 0}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00347.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00348.gif' alt='aktive op draw box-rounded on @1 center {64 64} ewidth 32 eheight 32 upleftradius 32 outlined 1 color {1 0 0}' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_box_on'></a> aktive op draw box on

Syntax: __aktive op draw box on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a box is drawn on the input image.

Beware, the location and size of the box are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a box located completely outside of the image domain.

#### <a name='op_draw_box_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw box on @1 center {64 64} ewidth 32 eheight 32 color {1 0 0} outlined 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00349.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00350.gif' alt='aktive op draw box on @1 center {64 64} ewidth 32 eheight 32 color {1 0 0} outlined 1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_circle_on'></a> aktive op draw circle on

Syntax: __aktive op draw circle on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a circle is drawn on the input image.

Beware, the location and size of the circle are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a circle located completely outside of the image domain.

#### <a name='op_draw_circle_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw circle on @1 center {64 64} radius 32 color {1 0 0} outlined 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00351.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00352.gif' alt='aktive op draw circle on @1 center {64 64} radius 32 color {1 0 0} outlined 1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_circles_on'></a> aktive op draw circles on

Syntax: __aktive op draw circles on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a set of circles is drawn on the input image.

Beware, the location and size of the set of circles are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a set of circles located completely outside of the image domain.

#### <a name='op_draw_circles_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw circles on @1 radius 8 color {1 0 0} outlined 1 centers {10 10} {30 80} {80 30}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00353.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00354.gif' alt='aktive op draw circles on @1 radius 8 color {1 0 0} outlined 1 centers {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_line_on'></a> aktive op draw line on

Syntax: __aktive op draw line on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a line is drawn on the input image.

Beware, the location and size of the line are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a line located completely outside of the image domain.

#### <a name='op_draw_line_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw line on @1 from {10 10} to {30 80} color {1 0 0} strokewidth 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00355.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00356.gif' alt='aktive op draw line on @1 from {10 10} to {30 80} color {1 0 0} strokewidth 1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_parallelogram_on'></a> aktive op draw parallelogram on

Syntax: __aktive op draw parallelogram on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a parallelogram is drawn on the input image.

Beware, the location and size of the parallelogram are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a parallelogram located completely outside of the image domain.

#### <a name='op_draw_parallelogram_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw parallelogram on @1 center {64 64} ewidth 32 eheight 32 eskew 8 color {1 0 0} outlined 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00357.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00358.gif' alt='aktive op draw parallelogram on @1 center {64 64} ewidth 32 eheight 32 eskew 8 color {1 0 0} outlined 1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_polyline_on'></a> aktive op draw polyline on

Syntax: __aktive op draw polyline on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a set of lines is drawn on the input image.

Beware, the location and size of the set of lines are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a set of lines located completely outside of the image domain.

#### <a name='op_draw_polyline_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw polyline on @1 color {1 0 0} strokewidth 1 points {10 10} {30 80} {80 30}
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00359.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00360.gif' alt='aktive op draw polyline on @1 color {1 0 0} strokewidth 1 points {10 10} {30 80} {80 30}' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_rhombus_on'></a> aktive op draw rhombus on

Syntax: __aktive op draw rhombus on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a rhombus is drawn on the input image.

Beware, the location and size of the rhombus are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a rhombus located completely outside of the image domain.

#### <a name='op_draw_rhombus_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw rhombus on @1 center {64 64} ewidth 32 eheight 32 outlined 1 color {1 0 0} outlined 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00361.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00362.gif' alt='aktive op draw rhombus on @1 center {64 64} ewidth 32 eheight 32 outlined 1 color {1 0 0} outlined 1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='op_draw_triangle_on'></a> aktive op draw triangle on

Syntax: __aktive op draw triangle on__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=95&name=etc/generator/virtual/draw.tcl)]

Returns an image where a triangle is drawn on the input image.

Beware, the location and size of the triangle are independent of image location and dimensions. The operator is perfectly fine computing the SDF of a triangle located completely outside of the image domain.

#### <a name='op_draw_triangle_on__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op draw triangle on @1 a {10 10} b {30 80} c {80 30} color {1 0 0} outlined 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><img src='example-00363.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00364.gif' alt='aktive op draw triangle on @1 a {10 10} b {30 80} c {80 30} color {1 0 0} outlined 1' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform effect

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive effect blur](#effect_blur)
 - [aktive effect charcoal](#effect_charcoal)
 - [aktive effect emboss](#effect_emboss)
 - [aktive effect jitter gauss](#effect_jitter_gauss)
 - [aktive effect jitter uniform](#effect_jitter_uniform)
 - [aktive effect sharpen](#effect_sharpen)
 - [aktive effect sketch](#effect_sketch)
 - [aktive effect swirl](#effect_swirl)

## Operators

---
### [↑](#top) <a name='effect_blur'></a> aktive effect blur

Syntax: __aktive effect blur__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=187&name=etc/transformer/filter/effects.tcl)]

Returns blurred input, per the specified blur radius.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00004.gif' alt='aktive effect blur @1 radius 16' style='border:4px solid gold'>
    <br>geometry(16 0 96 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='effect_charcoal'></a> aktive effect charcoal

Syntax: __aktive effect charcoal__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=232&name=etc/transformer/filter/effects.tcl)]

Returns a grey image with a charcoal-like sketch of the sRGB input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00008.gif' alt='aktive effect charcoal @1 light yes' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 1)</td></tr>
</table>


---
### [↑](#top) <a name='effect_emboss'></a> aktive effect emboss

Syntax: __aktive effect emboss__ src [[→ definition](../../../../file?ci=trunk&ln=151&name=etc/transformer/filter/effects.tcl)]

Returns embossed input.


#### <a name='effect_emboss__examples'></a> Examples

    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00010.gif' alt='aktive effect emboss @1' style='border:4px solid gold'>
    <br>geometry(1 1 126 126 1)</td></tr>
</table>


---
### [↑](#top) <a name='effect_jitter_gauss'></a> aktive effect jitter gauss

Syntax: __aktive effect jitter gauss__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=109&name=etc/transformer/filter/effects.tcl)]

Returns the input with a jitter effect based on gaussian noise applied to it. Visually this looks like frosted glass.

The underlying operation is [aktive warp noise gauss](generator_virtual_warp.md#warp_noise_gauss).

    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00016.gif' alt='aktive effect jitter gauss @1 sigma 4 seed 703011174' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='effect_jitter_uniform'></a> aktive effect jitter uniform

Syntax: __aktive effect jitter uniform__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=67&name=etc/transformer/filter/effects.tcl)]

Returns the input with a jitter effect based on uniform noise applied to it. Visually this looks like frosted glass.

The underlying operation is [aktive warp noise uniform](generator_virtual_warp.md#warp_noise_uniform).

    <br>geometry(0 0 380 250 3)</td>
    <td valign='top'><img src='example-00022.gif' alt='aktive effect jitter uniform @1 min 1 max 6 seed 703011174' style='border:4px solid gold'>
    <br>geometry(0 0 380 250 3)</td></tr>
</table>


---
### [↑](#top) <a name='effect_sharpen'></a> aktive effect sharpen

Syntax: __aktive effect sharpen__ src [[→ definition](../../../../file?ci=trunk&ln=170&name=etc/transformer/filter/effects.tcl)]

Returns sharpened input.


#### <a name='effect_sharpen__examples'></a> Examples

    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00024.gif' alt='aktive effect sharpen @1' style='border:4px solid gold'>
    <br>geometry(1 1 126 126 1)</td></tr>
</table>


---
### [↑](#top) <a name='effect_sketch'></a> aktive effect sketch

Syntax: __aktive effect sketch__ src [[→ definition](../../../../file?ci=trunk&ln=210&name=etc/transformer/filter/effects.tcl)]

Returns image with a general sketch of the input.


#### <a name='effect_sketch__examples'></a> Examples

    <br>geometry(0 0 128 128 1)</td>
    <td valign='top'><img src='example-00028.gif' alt='aktive effect sketch @1' style='border:4px solid gold'>
    <br>geometry(0 0 128 128 1)</td></tr>
</table>


---
### [↑](#top) <a name='effect_swirl'></a> aktive effect swirl

Syntax: __aktive effect swirl__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/effects.tcl)]

Returns the input with a swirling effect applied to it.

This effect applies around the specified __center__, with fixed rotation __phi__, a base rotation __from__, and a __decay__ factor.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform geometry

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op geometry bands fold](#op_geometry_bands_fold)
 - [aktive op geometry bands unfold](#op_geometry_bands_unfold)

## Operators

---
### [↑](#top) <a name='op_geometry_bands_fold'></a> aktive op geometry bands fold

Syntax: __aktive op geometry bands fold__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=12&name=etc/transformer/structure/band-geometry.tcl)]

Returns image with the input's columns folded into bands, reducing width. The result is a (input depth * k)-band image and input width divided by k.

The parameter k has to be a proper divisor of the input width. I.e. the input width divided by k leaves no remainder.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|by|uint||Folding factor. Range 2... Factor 1 is a nop-op.|

---
### [↑](#top) <a name='op_geometry_bands_unfold'></a> aktive op geometry bands unfold

Syntax: __aktive op geometry bands unfold__ src [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/structure/band-geometry.tcl)]

Returns image with the input's bands unfolded and making it wider. The result is a single-band image wider by input depth times.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform global histogram

## <anchor='top'> Table Of Contents

  - [transform global](transform_global.md) ↗


## Subsections

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform global histogram equalization

## <anchor='top'> Table Of Contents

  - [transform global histogram](transform_global_histogram.md) ↗


### Operators

 - [aktive op equalization global](#op_equalization_global)

## Operators

---
### [↑](#top) <a name='op_equalization_global'></a> aktive op equalization global

Syntax: __aktive op equalization global__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/filter/equalization.tcl)]

Returns input with equalized global histogram.

The location of the input is ignored, and passed to the result.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform identity

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op pass](#op_pass)

## Operators

---
### [↑](#top) <a name='op_pass'></a> aktive op pass

Syntax: __aktive op pass__ src [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/identity.tcl)]

Returns unchanged input.

This is useful for round-trip testing, to stop application of simplification rules which would otherwise eliminate or modify the chain of operations under test.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform kuwahara

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op kuwahara](#op_kuwahara)
 - [aktive op kuwahara-core](#op_kuwahara_core)

## Operators

---
### [↑](#top) <a name='op_kuwahara'></a> aktive op kuwahara

Syntax: __aktive op kuwahara__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/filter/kuwahara.tcl)]

Returns input with a Kuwahara filter applied to it.

The location of the input is ignored.

The image is allowed to be multi-band.

For known colorspaces the core filter is applied to the luminance channel of the input.

The image may be converted into and out of a colorspace with such a channel if it does not have one on its own.

For images without known colorspace the last band is used as the luminance channel.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|k|uint|2|Filter radius. Actual window size is `2*k-1`. The default value is 2. This is also the minimum allowed value.|

---
### [↑](#top) <a name='op_kuwahara_core'></a> aktive op kuwahara-core

Syntax: __aktive op kuwahara-core__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=101&name=etc/transformer/filter/kuwahara.tcl)]

Returns input with a Kuwahara filter applied to it.

The location of the input is ignored.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform location

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op location move by](#op_location_move_by)
 - [aktive op location move to](#op_location_move_to)

## Operators

---
### [↑](#top) <a name='op_location_move_by'></a> aktive op location move by

Syntax: __aktive op location move by__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/location.tcl)]

Returns image translationally shifted along the x- and y-axes by a specific amount

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|dx|int||Shift amount for x location of image in the plane, positive to the right, negative left|
|dy|int||Shift amount for y location of image in the plane, positive downward, negative upward|

---
### [↑](#top) <a name='op_location_move_to'></a> aktive op location move to

Syntax: __aktive op location move to__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=7&name=etc/transformer/location.tcl)]

Returns image translationally shifted along the x- and y-axes to a specific location

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform lookup

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


## Subsections

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform lookup indexed

## <anchor='top'> Table Of Contents

  - [transform lookup](transform_lookup.md) ↗


## Subsections


 - [transform lookup indexed compose](transform_lookup_indexed_compose.md) ↘
 - [transform lookup indexed make](transform_lookup_indexed_make.md) ↘

### Operators

 - [aktive op lut indexed](#op_lut_indexed)
 - [aktive op lut indexed-core](#op_lut_indexed_core)

## Operators

---
### [↑](#top) <a name='op_lut_indexed'></a> aktive op lut indexed

Syntax: __aktive op lut indexed__ src0 src1 ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=84&name=etc/transformer/filter/lookup.tcl)]

Map the input image (second argument) through the LUT image provided as the first arguments and return the result.

This operator is __strict__ in the 1st input. The LUT to map through is materialized and cached.

to interpolate linearly between the values at the LUT index, and the next index.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|interpolate|bool|false|Flag to activate value interpolation mode.|

---
### [↑](#top) <a name='op_lut_indexed_core'></a> aktive op lut indexed-core

Syntax: __aktive op lut indexed-core__ src0 src1 ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=126&name=etc/transformer/filter/lookup.tcl)]

Map the input image (second argument) through the LUT image provided as the first arguments and return the result.

The location of the LUT image is ignored.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform lookup indexed compose

## <anchor='top'> Table Of Contents

  - [transform lookup indexed](transform_lookup_indexed.md) ↗


### Operators

 - [aktive op lut compose](#op_lut_compose)

## Operators

---
### [↑](#top) <a name='op_lut_compose'></a> aktive op lut compose

Syntax: __aktive op lut compose__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/filter/lookup.tcl)]

Taking two indexed LUTs A and B it returns the indexed LUT computing `res = A (B (src))`.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform lookup indexed make

## <anchor='top'> Table Of Contents

  - [transform lookup indexed](transform_lookup_indexed.md) ↗


### Operators

 - [aktive op lut from](#op_lut_from)

## Operators

---
### [↑](#top) <a name='op_lut_from'></a> aktive op lut from

Syntax: __aktive op lut from__  (param value)... [[→ definition](../../../../file?ci=trunk&ln=50&name=etc/transformer/filter/lookup.tcl)]

Create a single-band indexed LUT from values

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


## Subsections


 - [transform math binary](transform_math_binary.md) ↘
 - [transform math n-ary](transform_math_nary.md) ↘
 - [transform math unary](transform_math_unary.md) ↘

### Operators

 - [aktive op math linear](#op_math_linear)

## Operators

---
### [↑](#top) <a name='op_math_linear'></a> aktive op math linear

Syntax: __aktive op math linear__ src0 src1 src2 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/other.tcl)]

Blends first and second input under control of the third.

As an equation: `result = A + T*(B-A)`.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math binary

## <anchor='top'> Table Of Contents

  - [transform math](transform_math.md) ↗


## Subsections

 - [aktive op math pow](#op_math_pow)
 - [aktive op math screen](#op_math_screen)
 - [aktive op math sub](#op_math_sub)

## Operators

---
### [↑](#top) <a name='op_math_atan2'></a> aktive op math atan2

Syntax: __aktive op math atan2__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'atan2(A, B)' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_difference'></a> aktive op math difference

Syntax: __aktive op math difference__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/binary.tcl)]

Returns image holding the absolute difference of the inputs.


---
### [↑](#top) <a name='op_math_div'></a> aktive op math div

Syntax: __aktive op math div__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A / B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_eq'></a> aktive op math eq

Syntax: __aktive op math eq__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A == B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_ge'></a> aktive op math ge

Syntax: __aktive op math ge__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A >= B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_gt'></a> aktive op math gt

Syntax: __aktive op math gt__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A > B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_hypot'></a> aktive op math hypot

Syntax: __aktive op math hypot__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'hypot (A, B)' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_le'></a> aktive op math le

Syntax: __aktive op math le__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A <= B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_lt'></a> aktive op math lt

Syntax: __aktive op math lt__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A < B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_mod'></a> aktive op math mod

Syntax: __aktive op math mod__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A % B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_ne'></a> aktive op math ne

Syntax: __aktive op math ne__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A != B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_pow'></a> aktive op math pow

Syntax: __aktive op math pow__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'pow (A, B)' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_math_screen'></a> aktive op math screen

Syntax: __aktive op math screen__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=21&name=etc/transformer/math/binary.tcl)]

Returns image holding the `screen` of the inputs


---
### [↑](#top) <a name='op_math_sub'></a> aktive op math sub

Syntax: __aktive op math sub__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation 'A - B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math binary logical

## <anchor='top'> Table Of Contents

  - [transform math binary](transform_math_binary.md) ↗


### Operators

 - [aktive op math nand](#op_math_nand)
 - [aktive op math nor](#op_math_nor)

## Operators

---
### [↑](#top) <a name='op_math_nand'></a> aktive op math nand

Syntax: __aktive op math nand__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation '!(A && B)' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.

As a logical operation the inputs are trivially thresholded at 0.5. Values <= 0.5 are seen as false, else as true.


---
### [↑](#top) <a name='op_math_nor'></a> aktive op math nor

Syntax: __aktive op math nor__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=47&name=etc/transformer/math/binary.tcl)]

Returns image with the binary operation '!(A || B)' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math complex

## <anchor='top'> Table Of Contents

  - [transform math](transform_math.md) ↗


## Subsections

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math complex binary

## <anchor='top'> Table Of Contents

  - [transform math complex](transform_math_complex.md) ↗


### Operators

 - [aktive op cmath add](#op_cmath_add)
 - [aktive op cmath cons](#op_cmath_cons)
 - [aktive op cmath div](#op_cmath_div)
 - [aktive op cmath mul](#op_cmath_mul)
 - [aktive op cmath pow](#op_cmath_pow)
 - [aktive op cmath sub](#op_cmath_sub)

## Operators

---
### [↑](#top) <a name='op_cmath_add'></a> aktive op cmath add

Syntax: __aktive op cmath add__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/complex/binary.tcl)]

Returns complex-valued image with the complex-valued binary operation 'A + B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_cmath_cons'></a> aktive op cmath cons

Syntax: __aktive op cmath cons__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=41&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image constructed from the 2 single-band inputs. First input becomes the real part, second the imaginary.


---
### [↑](#top) <a name='op_cmath_div'></a> aktive op cmath div

Syntax: __aktive op cmath div__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/complex/binary.tcl)]

Returns complex-valued image with the complex-valued binary operation 'A / B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_cmath_mul'></a> aktive op cmath mul

Syntax: __aktive op cmath mul__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/complex/binary.tcl)]

Returns complex-valued image with the complex-valued binary operation 'A * B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_cmath_pow'></a> aktive op cmath pow

Syntax: __aktive op cmath pow__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/complex/binary.tcl)]

Returns complex-valued image with the complex-valued binary operation 'pow(A, B)' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.


---
### [↑](#top) <a name='op_cmath_sub'></a> aktive op cmath sub

Syntax: __aktive op cmath sub__ src0 src1 [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/math/complex/binary.tcl)]

Returns complex-valued image with the complex-valued binary operation 'A - B' applied to all shared pixels of the two inputs.

The result geometry is the intersection of the inputs.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math complex reduce

## <anchor='top'> Table Of Contents

  - [transform math complex](transform_math_complex.md) ↗


### Operators

 - [aktive op cmath abs](#op_cmath_abs)
 - [aktive op cmath arg](#op_cmath_arg)
 - [aktive op cmath imaginary](#op_cmath_imaginary)
 - [aktive op cmath real](#op_cmath_real)
 - [aktive op cmath sqabs](#op_cmath_sqabs)

## Operators

---
### [↑](#top) <a name='op_cmath_abs'></a> aktive op cmath abs

Syntax: __aktive op cmath abs__ src [[→ definition](../../../../file?ci=trunk&ln=29&name=etc/transformer/math/complex/reduce.tcl)]

Returns single-band image with the complex unary reduction function 'abs(I)' applied to all pixels of the complex-valued input.

The result geometry is the same as the input, except for depth, which becomes 1.


---
### [↑](#top) <a name='op_cmath_arg'></a> aktive op cmath arg

Syntax: __aktive op cmath arg__ src [[→ definition](../../../../file?ci=trunk&ln=29&name=etc/transformer/math/complex/reduce.tcl)]

Returns single-band image with the complex unary reduction function 'phase-angle(I)' applied to all pixels of the complex-valued input.

The result geometry is the same as the input, except for depth, which becomes 1.


---
### [↑](#top) <a name='op_cmath_imaginary'></a> aktive op cmath imaginary

Syntax: __aktive op cmath imaginary__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/transformer/math/complex/reduce.tcl)]

Returns single-band image containing the imaginary part of the complex-valued input.


---
### [↑](#top) <a name='op_cmath_real'></a> aktive op cmath real

Syntax: __aktive op cmath real__ src [[→ definition](../../../../file?ci=trunk&ln=11&name=etc/transformer/math/complex/reduce.tcl)]

Returns single-band image containing the real part of the complex-valued input.


---
### [↑](#top) <a name='op_cmath_sqabs'></a> aktive op cmath sqabs

Syntax: __aktive op cmath sqabs__ src [[→ definition](../../../../file?ci=trunk&ln=29&name=etc/transformer/math/complex/reduce.tcl)]

Returns single-band image with the complex unary reduction function 'abs^2(I)' applied to all pixels of the complex-valued input.

The result geometry is the same as the input, except for depth, which becomes 1.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math complex unary

## <anchor='top'> Table Of Contents

  - [transform math complex](transform_math_complex.md) ↗


### Operators

 - [aktive op cmath acos](#op_cmath_acos)

 - [aktive op cmath tanh](#op_cmath_tanh)
 - [aktive op cmath tocartesian](#op_cmath_tocartesian)
 - [aktive op cmath topolar](#op_cmath_topolar)

## Operators

---
### [↑](#top) <a name='op_cmath_acos'></a> aktive op cmath acos

Syntax: __aktive op cmath acos__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'acos(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_acosh'></a> aktive op cmath acosh

Syntax: __aktive op cmath acosh__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'acosh(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_as_imaginary'></a> aktive op cmath as-imaginary

Syntax: __aktive op cmath as-imaginary__ src [[→ definition](../../../../file?ci=trunk&ln=14&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image constructed from the single-band input. Input becomes the imaginary part.


---
### [↑](#top) <a name='op_cmath_as_real'></a> aktive op cmath as-real

Syntax: __aktive op cmath as-real__ src [[→ definition](../../../../file?ci=trunk&ln=14&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image constructed from the single-band input. Input becomes the real part.


---
### [↑](#top) <a name='op_cmath_asin'></a> aktive op cmath asin

Syntax: __aktive op cmath asin__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'asin(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_asinh'></a> aktive op cmath asinh

Syntax: __aktive op cmath asinh__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'asinh(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_atan'></a> aktive op cmath atan

Syntax: __aktive op cmath atan__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'atan(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_atanh'></a> aktive op cmath atanh

Syntax: __aktive op cmath atanh__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'atanh(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_cbrt'></a> aktive op cmath cbrt

Syntax: __aktive op cmath cbrt__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'cbrt(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_conjugate'></a> aktive op cmath conjugate

Syntax: __aktive op cmath conjugate__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'conjugate(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_cos'></a> aktive op cmath cos

Syntax: __aktive op cmath cos__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'cos(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_cosh'></a> aktive op cmath cosh

Syntax: __aktive op cmath cosh__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'cosh(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_exp'></a> aktive op cmath exp

Syntax: __aktive op cmath exp__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'exp(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_exp2'></a> aktive op cmath exp2

Syntax: __aktive op cmath exp2__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'exp2(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_exp10'></a> aktive op cmath exp10

Syntax: __aktive op cmath exp10__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'exp10(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_log'></a> aktive op cmath log

Syntax: __aktive op cmath log__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'log(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_log2'></a> aktive op cmath log2

Syntax: __aktive op cmath log2__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'log2(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_log10'></a> aktive op cmath log10

Syntax: __aktive op cmath log10__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'log10(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_neg'></a> aktive op cmath neg

Syntax: __aktive op cmath neg__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function '-I' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_reciproc'></a> aktive op cmath reciproc

Syntax: __aktive op cmath reciproc__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function '1/I' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_sign'></a> aktive op cmath sign

Syntax: __aktive op cmath sign__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'sign(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_sin'></a> aktive op cmath sin

Syntax: __aktive op cmath sin__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'sin(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_sinh'></a> aktive op cmath sinh

Syntax: __aktive op cmath sinh__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'sinh(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_sqrt'></a> aktive op cmath sqrt

Syntax: __aktive op cmath sqrt__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'sqrt(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_tan'></a> aktive op cmath tan

Syntax: __aktive op cmath tan__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'tan(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_tanh'></a> aktive op cmath tanh

Syntax: __aktive op cmath tanh__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'tanh(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_tocartesian'></a> aktive op cmath tocartesian

Syntax: __aktive op cmath tocartesian__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'tocartesian(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_cmath_topolar'></a> aktive op cmath topolar

Syntax: __aktive op cmath topolar__ src [[→ definition](../../../../file?ci=trunk&ln=64&name=etc/transformer/math/complex/unary.tcl)]

Returns complex-valued image with the complex-valued unary function 'topolar(I)' applied to all pixels of the image.

The resulting image has the same geometry as the input.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math n-ary

## <anchor='top'> Table Of Contents

  - [transform math](transform_math.md) ↗


## Subsections


 - [transform math n-ary logical](transform_math_nary_logical.md) ↘

### Operators

 - [aktive op math add](#op_math_add)
 - [aktive op math max](#op_math_max)
 - [aktive op math min](#op_math_min)
 - [aktive op math mul](#op_math_mul)

## Operators

---
### [↑](#top) <a name='op_math_add'></a> aktive op math add

Syntax: __aktive op math add__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

Returns image aggregated from the application of the associative binary operation 'A + B' to all shared pixels of all the inputs.


---
### [↑](#top) <a name='op_math_max'></a> aktive op math max

Syntax: __aktive op math max__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

Returns image aggregated from the application of the associative binary operation 'max(A, B)' to all shared pixels of all the inputs.


---
### [↑](#top) <a name='op_math_min'></a> aktive op math min

Syntax: __aktive op math min__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

Returns image aggregated from the application of the associative binary operation 'min(A, B)' to all shared pixels of all the inputs.


---
### [↑](#top) <a name='op_math_mul'></a> aktive op math mul

Syntax: __aktive op math mul__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

Returns image aggregated from the application of the associative binary operation 'A * B' to all shared pixels of all the inputs.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math n-ary logical

## <anchor='top'> Table Of Contents

  - [transform math n-ary](transform_math_nary.md) ↗


### Operators

 - [aktive op math and](#op_math_and)
 - [aktive op math or](#op_math_or)
 - [aktive op math xor](#op_math_xor)

## Operators

---
### [↑](#top) <a name='op_math_and'></a> aktive op math and

Syntax: __aktive op math and__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

As a logical operation the inputs are trivially thresholded at 0.5. Values <= 0.5 are seen as false, else as true.

Returns image aggregated from the application of the associative binary operation 'A && B' to all shared pixels of all the inputs.


---
### [↑](#top) <a name='op_math_or'></a> aktive op math or

Syntax: __aktive op math or__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

As a logical operation the inputs are trivially thresholded at 0.5. Values <= 0.5 are seen as false, else as true.

Returns image aggregated from the application of the associative binary operation 'A || B' to all shared pixels of all the inputs.


---
### [↑](#top) <a name='op_math_xor'></a> aktive op math xor

Syntax: __aktive op math xor__ srcs... [[→ definition](../../../../file?ci=trunk&ln=107&name=etc/transformer/math/binary.tcl)]

As a logical operation the inputs are trivially thresholded at 0.5. Values <= 0.5 are seen as false, else as true.

Returns image aggregated from the application of the associative binary operation 'A ^^ B' to all shared pixels of all the inputs.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math unary

## <anchor='top'> Table Of Contents

  - [transform math](transform_math.md) ↗


## Subsections

 - [aktive op math1 tan](#op_math1_tan)
 - [aktive op math1 tanh](#op_math1_tanh)
 - [aktive op math1 wrap](#op_math1_wrap)

## Operators

---
### [↑](#top) <a name='op_math1_abs'></a> aktive op math1 abs

Syntax: __aktive op math1 abs__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'abs(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_acos'></a> aktive op math1 acos

Syntax: __aktive op math1 acos__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'acos(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_acosh'></a> aktive op math1 acosh

Syntax: __aktive op math1 acosh__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'acosh(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_asin'></a> aktive op math1 asin

Syntax: __aktive op math1 asin__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'asin(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_asinh'></a> aktive op math1 asinh

Syntax: __aktive op math1 asinh__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'asinh(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_atan'></a> aktive op math1 atan

Syntax: __aktive op math1 atan__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'atan(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_atan2'></a> aktive op math1 atan2

Syntax: __aktive op math1 atan2__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'atan2(I,x)' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|x|double||Atan by scalar x|

---
### [↑](#top) <a name='op_math1_atan2b'></a> aktive op math1 atan2b

Syntax: __aktive op math1 atan2b__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'atan2(y,I)' applied to all pixels of the input.

The image is the first argument of the command, even if not of the function

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|y|double||Atan by scalar y|

---
### [↑](#top) <a name='op_math1_atanh'></a> aktive op math1 atanh

Syntax: __aktive op math1 atanh__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'atanh(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_cbrt'></a> aktive op math1 cbrt

Syntax: __aktive op math1 cbrt__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'cbrt(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_ceil'></a> aktive op math1 ceil

Syntax: __aktive op math1 ceil__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'ceil(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_clamp'></a> aktive op math1 clamp

Syntax: __aktive op math1 clamp__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'clamp(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_cos'></a> aktive op math1 cos

Syntax: __aktive op math1 cos__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'cos(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_cosh'></a> aktive op math1 cosh

Syntax: __aktive op math1 cosh__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'cosh(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_eq'></a> aktive op math1 eq

Syntax: __aktive op math1 eq__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I == threshold' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Indicate pixels equal to the scalar threshold|

---
### [↑](#top) <a name='op_math1_exp'></a> aktive op math1 exp

Syntax: __aktive op math1 exp__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'exp(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_exp2'></a> aktive op math1 exp2

Syntax: __aktive op math1 exp2__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'exp2(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_exp10'></a> aktive op math1 exp10

Syntax: __aktive op math1 exp10__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'exp10(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_expx'></a> aktive op math1 expx

Syntax: __aktive op math1 expx__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'pow(base,I)' applied to all pixels of the input.

The image is the first argument of the command, even if not of the function

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|base|double||Power by scalar base|

---
### [↑](#top) <a name='op_math1_fit_mean_stddev'></a> aktive op math1 fit mean-stddev

Syntax: __aktive op math1 fit mean-stddev__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=313&name=etc/transformer/math/unary.tcl)]

Returns image fitted into the given range. Default range is 0..1.

Each band of the image is fitted separately.

The actual mean and standard deviation of the image bands are used to compute the necessary fit.

BEWARE, this means that construction incurs a computation cost on the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|min|double|0|Minimum value to fit the image to.|
|max|double|1|Maximum value to fit the image to.|
|sigma|double|1.2|Interval around the input mean to fit into the min/max range.|

---
### [↑](#top) <a name='op_math1_fit_min_max'></a> aktive op math1 fit min-max

Syntax: __aktive op math1 fit min-max__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=285&name=etc/transformer/math/unary.tcl)]

Returns image fitted into the given range. Default range is 0..1.

Each band of the image is fitted separately.

The actual min and max values of the image bands are used to compute the necessary fit. They may be modified by the upper and lower percentiles.

BEWARE, this means that construction incurs a computation cost on the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|min|double|0|Minimum value to fit the image to|
|max|double|1|Maximum value to fit the image to|
|upper|double|1|Upper percentile to apply to input max. Default is 100%|
|lower|double|0|Lower percentile to apply to input min. Default is 0%|

---
### [↑](#top) <a name='op_math1_fit_stretch'></a> aktive op math1 fit stretch

Syntax: __aktive op math1 fit stretch__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=233&name=etc/transformer/math/unary.tcl)]

Returns image fitted into the given range. Default range is 0..1.

Each band of the image is fitted separately.

The (image statistics) method `<by>` is used to determine the range of the image band values to fit into the destination range. The method is expected to return a list of two values, the min and the max to fit, in this order.

BEWARE, this means that construction incurs a computation cost on the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|min|double|0|Destination minimum value to fit the image into|
|max|double|1|Destination maximum value to fit the image into|
|by|str||Method computing the input min and max values to fit into the destination.|
|clamp|bool|1|Force clamping into result range.|

---
### [↑](#top) <a name='op_math1_floor'></a> aktive op math1 floor

Syntax: __aktive op math1 floor__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'floor(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_gamma_compress'></a> aktive op math1 gamma compress

Syntax: __aktive op math1 gamma compress__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'compress(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_gamma_expand'></a> aktive op math1 gamma expand

Syntax: __aktive op math1 gamma expand__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'expand(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_ge'></a> aktive op math1 ge

Syntax: __aktive op math1 ge__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I >= threshold' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Indicate pixels greater or equal to the scalar threshold|

---
### [↑](#top) <a name='op_math1_gt'></a> aktive op math1 gt

Syntax: __aktive op math1 gt__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I > threshold' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Indicate pixels greater than the scalar threshold|

---
### [↑](#top) <a name='op_math1_hypot'></a> aktive op math1 hypot

Syntax: __aktive op math1 hypot__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'hypot(I,y)' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|y|double||Hypot to scalar y|

---
### [↑](#top) <a name='op_math1_inside_cc'></a> aktive op math1 inside-cc

Syntax: __aktive op math1 inside-cc__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the closed/closed interval given by the two boundaries applied to all pixels of the input.

Values inside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower closed boundary|
|high|double||Upper closed boundary|

---
### [↑](#top) <a name='op_math1_inside_co'></a> aktive op math1 inside-co

Syntax: __aktive op math1 inside-co__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the closed/open interval given by the two boundaries applied to all pixels of the input.

Values inside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower closed boundary|
|high|double||Upper open boundary|

---
### [↑](#top) <a name='op_math1_inside_oc'></a> aktive op math1 inside-oc

Syntax: __aktive op math1 inside-oc__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the open/closed interval given by the two boundaries applied to all pixels of the input.

Values inside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower open boundary|
|high|double||Upper closed boundary|

---
### [↑](#top) <a name='op_math1_inside_oo'></a> aktive op math1 inside-oo

Syntax: __aktive op math1 inside-oo__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the open/open interval given by the two boundaries applied to all pixels of the input.

Values inside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower open boundary|
|high|double||Upper open boundary|

---
### [↑](#top) <a name='op_math1_invert'></a> aktive op math1 invert

Syntax: __aktive op math1 invert__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function '1-I' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_le'></a> aktive op math1 le

Syntax: __aktive op math1 le__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I <= threshold' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Indicate pixels less or equal to the scalar threshold|

---
### [↑](#top) <a name='op_math1_linear'></a> aktive op math1 linear

Syntax: __aktive op math1 linear__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=218&name=etc/transformer/math/unary.tcl)]

Returns image with the linear transform `(I*scale)+gain` applied to it.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|scale|double||Input scaling factor|
|gain|double||Post-scaling offset|

---
### [↑](#top) <a name='op_math1_log'></a> aktive op math1 log

Syntax: __aktive op math1 log__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'log(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_log2'></a> aktive op math1 log2

Syntax: __aktive op math1 log2__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'log2(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_log10'></a> aktive op math1 log10

Syntax: __aktive op math1 log10__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'log10(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_lt'></a> aktive op math1 lt

Syntax: __aktive op math1 lt__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I < threshold' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Indicate pixels less than the scalar threshold|

---
### [↑](#top) <a name='op_math1_max'></a> aktive op math1 max

Syntax: __aktive op math1 max__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'max(I,min)' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|min|double||Limit to greater or equal a scalar min|

---
### [↑](#top) <a name='op_math1_min'></a> aktive op math1 min

Syntax: __aktive op math1 min__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'min(I,max)' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|max|double||Limit to less or equal a scalar max|

---
### [↑](#top) <a name='op_math1_mod'></a> aktive op math1 mod

Syntax: __aktive op math1 mod__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I % modulus' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|modulus|double||Remainder by scalar modulus|

---
### [↑](#top) <a name='op_math1_modb'></a> aktive op math1 modb

Syntax: __aktive op math1 modb__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'numerator % I' applied to all pixels of the input.

The image is the first argument of the command, even if not of the function

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|numerator|double||Remainder by scalar numerator|

---
### [↑](#top) <a name='op_math1_ne'></a> aktive op math1 ne

Syntax: __aktive op math1 ne__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I != threshold' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Indicate pixels different from the scalar threshold|

---
### [↑](#top) <a name='op_math1_neg'></a> aktive op math1 neg

Syntax: __aktive op math1 neg__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function '-I' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_neg_shift'></a> aktive op math1 neg-shift

Syntax: __aktive op math1 neg-shift__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'offset-I' applied to all pixels of the input.

The image is the first argument of the command, even if not of the function

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|offset|double||Subtract from scalar offset|

---
### [↑](#top) <a name='op_math1_outside_cc'></a> aktive op math1 outside-cc

Syntax: __aktive op math1 outside-cc__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the closed/closed interval given by the two boundaries applied to all pixels of the input.

Values outside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower closed boundary|
|high|double||Upper closed boundary|

---
### [↑](#top) <a name='op_math1_outside_co'></a> aktive op math1 outside-co

Syntax: __aktive op math1 outside-co__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the closed/open interval given by the two boundaries applied to all pixels of the input.

Values outside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower closed boundary|
|high|double||Upper open boundary|

---
### [↑](#top) <a name='op_math1_outside_oc'></a> aktive op math1 outside-oc

Syntax: __aktive op math1 outside-oc__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the open/closed interval given by the two boundaries applied to all pixels of the input.

Values outside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower open boundary|
|high|double||Upper closed boundary|

---
### [↑](#top) <a name='op_math1_outside_oo'></a> aktive op math1 outside-oo

Syntax: __aktive op math1 outside-oo__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=179&name=etc/transformer/math/unary.tcl)]

Returns image with the double sided thresholding against the open/open interval given by the two boundaries applied to all pixels of the input.

Values outside the interval are indicated in the result.

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|low|double||Lower open boundary|
|high|double||Upper open boundary|

---
### [↑](#top) <a name='op_math1_pow'></a> aktive op math1 pow

Syntax: __aktive op math1 pow__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'pow(I,exponent)' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|exponent|double||Power by scalar exponent|

---
### [↑](#top) <a name='op_math1_reciproc'></a> aktive op math1 reciproc

Syntax: __aktive op math1 reciproc__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function '1/I' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_reciproc_scale'></a> aktive op math1 reciproc-scale

Syntax: __aktive op math1 reciproc-scale__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'factor/I' applied to all pixels of the input.

The image is the first argument of the command, even if not of the function

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|factor|double||Divide from scalar factor|

---
### [↑](#top) <a name='op_math1_round'></a> aktive op math1 round

Syntax: __aktive op math1 round__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'round(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_scale'></a> aktive op math1 scale

Syntax: __aktive op math1 scale__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I*factor' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|factor|double||Multiply by scalar factor|

---
### [↑](#top) <a name='op_math1_shift'></a> aktive op math1 shift

Syntax: __aktive op math1 shift__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'I+offset' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|offset|double||Add scalar offset|

---
### [↑](#top) <a name='op_math1_sign'></a> aktive op math1 sign

Syntax: __aktive op math1 sign__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'sign(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_sign*'></a> aktive op math1 sign*

Syntax: __aktive op math1 sign*__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'sign*(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_sin'></a> aktive op math1 sin

Syntax: __aktive op math1 sin__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'sin(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_sinh'></a> aktive op math1 sinh

Syntax: __aktive op math1 sinh__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'sinh(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_solarize'></a> aktive op math1 solarize

Syntax: __aktive op math1 solarize__ src (param value)... [[→ definition](../../../../file?ci=trunk&ln=102&name=etc/transformer/math/unary.tcl)]

Returns image with the parameterized unary function 'solarize(I,threshold)' applied to all pixels of the input.

The image is the first argument of the command

The resulting image has the same geometry as the input.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|threshold|double||Solarize pixels per the threshold|

---
### [↑](#top) <a name='op_math1_sqrt'></a> aktive op math1 sqrt

Syntax: __aktive op math1 sqrt__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'sqrt(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_square'></a> aktive op math1 square

Syntax: __aktive op math1 square__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'I**2' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_tan'></a> aktive op math1 tan

Syntax: __aktive op math1 tan__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'tan(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_tanh'></a> aktive op math1 tanh

Syntax: __aktive op math1 tanh__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'tanh(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.


---
### [↑](#top) <a name='op_math1_wrap'></a> aktive op math1 wrap

Syntax: __aktive op math1 wrap__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function 'wrap(I)' applied to all pixels of the input.

The resulting image has the same geometry as the input.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform math unary logical

## <anchor='top'> Table Of Contents

  - [transform math unary](transform_math_unary.md) ↗


### Operators

 - [aktive op math1 not](#op_math1_not)

## Operators

---
### [↑](#top) <a name='op_math1_not'></a> aktive op math1 not

Syntax: __aktive op math1 not__ src [[→ definition](../../../../file?ci=trunk&ln=16&name=etc/transformer/math/unary.tcl)]

Returns image with the unary function '!I' applied to all pixels of the input.

The resulting image has the same geometry as the input.

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform metadata

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive meta append](#meta_append)

 - [aktive meta unset](#meta_unset)
 - [aktive op meta clear](#op_meta_clear)
 - [aktive op meta set](#op_meta_set)

## Operators

---
### [↑](#top) <a name='meta_append'></a> aktive meta append

Syntax: __aktive meta append__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "append" for image meta data management.

Returns input with meta data dictionary modified by application of "dict append"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_create'></a> aktive meta create

Syntax: __aktive meta create__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "create" for image meta data management.

Returns input with meta data dictionary modified by application of "dict create"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_filter'></a> aktive meta filter

Syntax: __aktive meta filter__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "filter" for image meta data management.

Returns input with meta data dictionary modified by application of "dict filter"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_incr'></a> aktive meta incr

Syntax: __aktive meta incr__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "incr" for image meta data management.

Returns input with meta data dictionary modified by application of "dict incr"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_lappend'></a> aktive meta lappend

Syntax: __aktive meta lappend__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "lappend" for image meta data management.

Returns input with meta data dictionary modified by application of "dict lappend"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_map'></a> aktive meta map

Syntax: __aktive meta map__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "map" for image meta data management.

Returns input with meta data dictionary modified by application of "dict map"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_merge'></a> aktive meta merge

Syntax: __aktive meta merge__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "merge" for image meta data management.

Returns input with meta data dictionary modified by application of "dict merge"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_remove'></a> aktive meta remove

Syntax: __aktive meta remove__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "remove" for image meta data management.

Returns input with meta data dictionary modified by application of "dict remove"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_replace'></a> aktive meta replace

Syntax: __aktive meta replace__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "replace" for image meta data management.

Returns input with meta data dictionary modified by application of "dict replace"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_set'></a> aktive meta set

Syntax: __aktive meta set__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "set" for image meta data management.

Returns input with meta data dictionary modified by application of "dict set"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='meta_unset'></a> aktive meta unset

Syntax: __aktive meta unset__ src args... [[→ definition](../../../../file?ci=trunk&ln=30&name=etc/transformer/meta.tcl)]

Wraps the dict method "unset" for image meta data management.

Returns input with meta data dictionary modified by application of "dict unset"

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|args|str...||Dict command arguments, except for dict value or variable.|

---
### [↑](#top) <a name='op_meta_clear'></a> aktive op meta clear

Syntax: __aktive op meta clear__ src [[→ definition](../../../../file?ci=trunk&ln=18&name=etc/transformer/meta.tcl)]

Returns input with all meta data cleared.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|

---
### [↑](#top) <a name='op_meta_set'></a> aktive op meta set

Syntax: __aktive op meta set__ src meta [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/meta.tcl)]

Returns input with specified meta data replacing the old.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|src|image||Input to modify|
|meta|object||New meta data dictionary replacing the input's.|

<img src='../assets/aktive-logo-128.png' style='float:right;'>

||||||||
|---|---|---|---|---|---|---|
|[Project ↗](../../README.md)|[Documentation ↗](../index.md)|&mdash;|[Tutorials ↗](../tutorials.md)|[How To's ↗](../howtos.md)|[Explanations ↗](../explanations.md)|References|

|||||||||
|---|---|---|---|---|---|---|---|
|[Entry ↗](index.md)|&mdash;|[Sections ↘](bysection.md)|[Permuted Sections ↘](bypsection.md)|[Names ↘](byname.md)|[Permuted Names ↘](bypname.md)|[Strict ↘](strict.md)|[Implementations ↘](bylang.md)|

# Documentation -- Reference Pages -- transform morphology

## <anchor='top'> Table Of Contents

  - [transform](transform.md) ↗


### Operators

 - [aktive op connected-components labeled](#op_connected_components_labeled)

 - [aktive op morph toggle](#op_morph_toggle)
 - [aktive op morph tophat black](#op_morph_tophat_black)
 - [aktive op morph tophat white](#op_morph_tophat_white)

## Operators

---
### [↑](#top) <a name='op_connected_components_labeled'></a> aktive op connected-components labeled

Syntax: __aktive op connected-components labeled__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/cc.tcl)]

Returns the input with labeled connected components.

See "[aktive op connected-components get](accessor_morphology.md#op_connected_components_get)" for the CC core.

#### <a name='op_connected_components_labeled__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op connected-components labeled @1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00333.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>1</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td></tr><tr><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>1</td><td>0</td><td>0</td><td>2</td><td>2</td><td>0</td><td>0</td><td>3</td><td>3</td><td>3</td><td>0</td><td>4</td><td>4</td><td>4</td><td>4</td><td>4</td><td>0</td><td>0</td><td>0</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>0</td><td>0</td></tr><tr><td>1</td><td>1</td><td>1</td><td>1</td><td>1</td><td>1</td><td>0</td><td>0</td><td>2</td><td>2</td><td>0</td><td>0</td><td>3</td><td>0</td><td>3</td><td>0</td><td>4</td><td>0</td><td>0</td><td>0</td><td>4</td><td>0</td><td>0</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>0</td></tr><tr><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>2</td><td>2</td><td>0</td><td>0</td><td>0</td><td>3</td><td>3</td><td>3</td><td>0</td><td>4</td><td>0</td><td>0</td><td>0</td><td>4</td><td>0</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td><td>5</td></tr><tr><td>0</td><td>2</td><td>2</td><td>2</td><td>2</td><td>2</td><td>2</td><td>2</td><td>0</td><td>6</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>4</td><td>0</td><td>0</td><td>0</td><td>4</td><td>0</td><td>5</td><td>5</td><td>5</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>5</td><td>5</td><td>5</td></tr><tr><td>0</td><td>2</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>6</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>4</td><td>0</td><td>0</td><td>0</td><td>4</td><td>0</td><td>5</td><td>5</td><td>0</td><td>0</td><td>0</td><td>7</td><td>0</td><td>0</td><td>0</td><td>5</td><td>5</td></tr><tr><td>0</td><td>2</td><td>0</td><td>6</td><td>6</td><td>6</td><td>6</td><td>6</td><td>6</td><td>6</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>4</td><td>4</td><td>4</td><td>4</td><td>4</td><td>0</td><td>0</td><td>5</td><td>5</td><td>0</td><td>0</td><td>7</td><td>0</td><td>0</td><td>5</td><td>5</td><td>0</td></tr><tr><td>0</td><td>0</td><td>6</td><td>6</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>5</td><td>5</td><td>0</td><td>7</td><td>0</td><td>5</td><td>5</td><td>0</td><td>0</td></tr><tr><td>0</td><td>6</td><td>6</td><td>0</td><td>0</td><td>8</td><td>8</td><td>8</td><td>8</td><td>8</td><td>8</td><td>0</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>7</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td></tr><tr><td>0</td><td>6</td><td>6</td><td>0</td><td>0</td><td>8</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>9</td><td>0</td><td>0</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td><td>7</td></tr><tr><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>8</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>9</td><td>9</td><td>0</td><td>0</td><td>0</td><td>0</td><td>9</td><td>9</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>0</td><td>7</td><td>7</td><td>7</td><td>0</td><td>0</td><td>0</td><td>0</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op connected-components labeled @1 transform cc.max
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00335.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00336.gif' alt='aktive op connected-components labeled @1 transform cc.max' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op connected-components labeled @1 transform cc.max bbox 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00337.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00338.gif' alt='aktive op connected-components labeled @1 transform cc.max bbox 1' style='border:4px solid gold'>
    <br>geometry(22 1 88 56 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_close'></a> aktive op morph close

Syntax: __aktive op morph close__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological closing (dilate, then erode) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_close__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph close @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00413.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00414.gif' alt='aktive op morph close @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph close @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00415.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00416.gif' alt='aktive op morph close @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_dilate'></a> aktive op morph dilate

Syntax: __aktive op morph dilate__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological dilation of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_dilate__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph dilate @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00417.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00418.gif' alt='aktive op morph dilate @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph dilate @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00419.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00420.gif' alt='aktive op morph dilate @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_erode'></a> aktive op morph erode

Syntax: __aktive op morph erode__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological erosion of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_erode__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph erode @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00421.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00422.gif' alt='aktive op morph erode @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph erode @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00423.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00424.gif' alt='aktive op morph erode @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_gradient_all'></a> aktive op morph gradient all

Syntax: __aktive op morph gradient all__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological gradient (subtract eroded from dilated) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_gradient_all__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph gradient all @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00425.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00426.gif' alt='aktive op morph gradient all @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph gradient all @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00427.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00428.gif' alt='aktive op morph gradient all @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_gradient_external'></a> aktive op morph gradient external

Syntax: __aktive op morph gradient external__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological outer gradient (subtract input from dilated) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_gradient_external__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph gradient external @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00429.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00430.gif' alt='aktive op morph gradient external @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph gradient external @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00431.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00432.gif' alt='aktive op morph gradient external @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_gradient_internal'></a> aktive op morph gradient internal

Syntax: __aktive op morph gradient internal__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological inner gradient (subtract eroded from input) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_gradient_internal__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph gradient internal @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00433.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00434.gif' alt='aktive op morph gradient internal @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph gradient internal @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00435.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00436.gif' alt='aktive op morph gradient internal @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_open'></a> aktive op morph open

Syntax: __aktive op morph open__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological opening (erode, then dilate) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_open__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph open @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00437.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00438.gif' alt='aktive op morph open @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph open @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00439.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00440.gif' alt='aktive op morph open @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_toggle'></a> aktive op morph toggle

Syntax: __aktive op morph toggle__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_toggle__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph toggle @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00441.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00442.gif' alt='aktive op morph toggle @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph toggle @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00443.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00444.gif' alt='aktive op morph toggle @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_tophat_black'></a> aktive op morph tophat black

Syntax: __aktive op morph tophat black__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological black tophat (subtract input from closing) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_tophat_black__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph tophat black @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00445.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00446.gif' alt='aktive op morph tophat black @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph tophat black @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00447.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00448.gif' alt='aktive op morph tophat black @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>


---
### [↑](#top) <a name='op_morph_tophat_white'></a> aktive op morph tophat white

Syntax: __aktive op morph tophat white__ src ?(param value)...? [[→ definition](../../../../file?ci=trunk&ln=8&name=etc/transformer/filter/morphology.tcl)]

Returns image containing the morphological white tophat (subtract opening from input) of the input using a (2*radius+1)x(2*radius+1) square structuring element.

|Parameter|Type|Default|Description|
|:---|:---|:---|:---|
|radius|uint|1|Size of the structuring element to perform the operation with.|
|embed|str|black|Embedding method to use before core operators to keep output from shrinking.|

#### <a name='op_morph_tophat_white__examples'></a> Examples

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph tophat white @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00449.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00450.gif' alt='aktive op morph tophat white @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 264 88 1)</td></tr></table></td></tr>
</table>

<table>
<tr><th>@1
    <br>&nbsp;</th>
    <th>aktive op morph tophat white @1 radius 1
    <br>&nbsp;</th></tr>
<tr><td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00451.gif' alt='@1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td>
    <td valign='top'><table><tr><td valign='top'>times 8</td><td valign='top'><img src='example-00452.gif' alt='aktive op morph tophat white @1 radius 1' style='border:4px solid gold'>
    <br>geometry(0 0 200 104 1)</td></tr></table></td></tr>
</table>