SpatialTransforms
Region - Align
Aligns the region using the provided coordinate system.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InAlignment | UCS2D | Coordinate system used to align the region. |
| InInverse | Bool | If true, the opposite alignment is performed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The aligned region. |
| Error | ErrorState | Gets the execution error message |
Region - Crop_Box
Crops the region to the provided box.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InSelection | Box | Selection used to create the new region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The cropped region. |
| Error | ErrorState | Gets the execution error message |
Region - Crop_Rectangle
Crops the region to the provided rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InRectangle | Rectangle2D | Rectangle area used to create the new region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The cropped region. |
| Error | ErrorState | Gets the execution error message |
Region - Downsample
Downsamples the region using the provided downsample mode.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InDownsampleRegionMode | Enum < DownsampleRegionMode > | Algorithm used to downsample the region. |
| InScaleStep | Int | The number of times the region dimensions will be divided by 2. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The downsampled region. |
| Error | ErrorState | Gets the execution error message |
Region - EnlargeNTimes
Increase the region by a given number of times.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InN | Int | Number of times the region is enlarged. Range: 〔1, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The enlarged region. |
| Error | ErrorState | Gets the execution error message |
Region - Mirror
Mirrors the region along the provided direction.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InMirrorDirection | Enum < MirrorDirection > | Mirror direction. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The mirrored region. |
| Error | ErrorState | Gets the execution error message |
Region - Reflect
Rotates the region by 180 degrees using the provided rotation center.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InReflectionCenter | Point2Di | The point used to reflect the region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The reflected region. |
| Error | ErrorState | Gets the execution error message |
Region - ResizeFrame_NewSize
Resizes the region using the provided frame. Note: Every point of the region that fall outside the new frame will be discarded.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InNewFrame | Size | New frame. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The resized region. |
| Error | ErrorState | Gets the execution error message |
Region - ResizeFrame_Scale
Resizes the region using a scale factor.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InScaleX | Float | Horizontal scale factor. Range: 〔0, +inf）. |
| InScaleY | Float | Vertical scale factor. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The resized region. |
| Error | ErrorState | Gets the execution error message |
Region - Rotate
Performs a clockwise rotation of the region by a given angle using the provided rotation center.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InCenter | Point2D | Rotation center. |
| InAngle | Float | Rotation angle. |
| InInverse | Bool | If true, the rotation is performed counterclockwise. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The rotated region. |
| Error | ErrorState | Gets the execution error message |
Region - Shear
Shear the region along the given axis.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InAxis | Enum < Axis > | Switches between X-shear or Y-shear |
| InShear | Float | Shear coefficient. |
| InCenter | Float | Center coordinate in the direction orthogonal to the shear direction. |
| InShearSize | Enum < ShearSize > | Controls the shear post-processing mode. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The sheared region. |
| Error | ErrorState | Gets the execution error message |
Region - ShrinkNTimes
Shrinks the region by a given number of times.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InNX | Int | Number of times the region width is divided by 2. Range 〔1, +inf）. |
| InThreshold | Float | The fraction of pixels used to determine if a point is contained in the region while downsampling. Range 〔0, 1〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The shrunk region. |
| Error | ErrorState | Gets the execution error message |
Region - Translate
Translates the object.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InDeltaX | Int | Translation in the X direction. |
| InDeltaY | Int | Translation in the Y direction. |
| InInverse | Bool | If true, the translation is done in the opposite direction. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The translated region. |
| Error | ErrorState | Gets the execution error message |
Region - Transpose
Returns the transposed region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The transposed region. |
| Error | ErrorState | Gets the execution error message |
Region - Trim
Trim the region points to the provided rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InRectangle | Rectangle2D | Input rectangle used to trim the region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The trimmed region. |
| Error | ErrorState | Gets the execution error message |
Region - Uncrop
Translates a cropped region in the original coordinates.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InSelection | Box | Box used for the original cropping. |
| InUncroppedFrame | Size | New frame of the uncropped region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The uncropped region. |
| Error | ErrorState | Gets the execution error message |