simpleexample
Description
This object is not a node, but the singleton to which nodes of this type point to determine their behaviour.
This docstring will form the help text for the node in the UI. Markdown is permitted and processed into HTML. Look at (say) XFormColourMap for an example of how to write this.
This particular node is a simple example which takes an image, and either multiplies it by a constant and adds another constant, or does the addition first and then the multiplication. It has three parameters - addition constant, multiplication constant, and order of operations. If the image has regions of interest, the operation will only be performed on those regions - the rest of the image will remain unchanged.
This example uses TabGeneric as its user interface, which is the simplest way to do it. If you need custom behaviour, there is another example node - XFormCustomTabExample - which uses Qt to build the interface. It's rather more complex.
Connections
Inputs
| Index | Name | Type | Desc |
|---|---|---|---|
| 0 | (none) | img | (none) |
Outputs
| Index | Name | Type | Desc |
|---|---|---|---|
| 0 | (none) | img | (none) |
Parameters
| simpleexample | mul: float (default 0.0) | multiply |
| add: float (default 0.0) | add | |
| order: string (mul,add, add,mul) (default 'mul,add') | order of ops |
Automatically generated by generate_autodocs.py
Date: 2026-07-03T14:16:39.921215