SpatialTransforms
Image - Crop_Box
Crops the image with a box.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InSelection | Box | Box defining the region to crop. |
| InBorder | Pixel | Pixel value used for areas outside the selected region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Cropped image. |
| Error | ErrorState | Gets the execution error message |
Image - Crop_Quadrangle
Crops the image with a quadrangle (a Path of 4 points).
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InQuadrangle | Path | Quadrangle defining the region to crop. |
| InInterpolationMethod | Enum < InterpolationMethod2D > | Interpolation method. |
| InMargin | Int | Width of the quadrangle margin. Range: 〔0, +inf）. |
| InBorder | Pixel | Pixel value used for areas outside the selected region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Cropped image. |
| Error | ErrorState | Gets the execution error message |
Image - Crop_Rectangle
Crops the image with a rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRectangle | Rectangle2D | Rectangle defining the region to crop. |
| InCropScale | Enum < CropScale > | How to scale the output image （maintaining the input size unchanged or rescaling）. |
| InInterpolationMethod | Enum < InterpolationMethod2D > | Interpolation method. |
| InMargin | Float | Width of the rectangle margin. Range: 〔0, +inf）. |
| InBorder | Pixel | Pixel value used for areas outside the selected region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Cropped image. |
| Error | ErrorState | Gets the execution error message |
Image - Downsample
Downsamples the image, decreasing its size by a factor of two along each axis.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InFactor | Int | How many times the image size is divided by 2. Range: 〔1, 12〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |
Image - GaussianPyramidDownsample
Creates an array of images, where each one represent a downsampled (and smoothed) version of the previous one.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InMinPyramidLevel | Int | Minimum pyramid level. Range: 〔1, 12〕. |
| InMaxPyramidLevel | Int | Maximum pyramid level. Range: 〔1, 12〕. |
| InGaussianKernel | Enum < GaussianKernel > | Gaussian kernel. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | ImageArray | Downsampled images. |
| Error | ErrorState | Gets the execution error message |
Image - Mirror
Inverts image's columns and/or rows.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InMirrorDirection | Enum < MirrorDirection > | Whether to apply the mirroring on the columns （horizontal）, on the rows （vertical） or on both. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |
Image - Polar
Transforms the image to polar or log-polar space.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InCenter | Point2D | Center of the coordinate system. |
| InPolarSpace | Enum < PolarSpace > | Type of polar transformation （polar or log-polar）. |
| InInterpolationMethod | Enum < PolarInterpolationMethod > | Interpolation method. |
| InInverse | Bool | Whether to use the inverse transformation. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |
Image - PyramidDownsample
Creates an array of images, where each one represent a downsampled version of the previous one.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InMinPyramidLevel | Int | Minimum pyramid level. Range: 〔1, 12〕. |
| InMaxPyramidLevel | Int | Maximum pyramid level. Range: 〔1, 12〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | ImageArray | Downsampled images. |
| Error | ErrorState | Gets the execution error message |
Image - Resize_NewSize
Resizes the image, setting new width and height.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InWidth | Int | New width. Range: 〔1, +inf）. |
| InHeight | Int | New height. Range: 〔1, +inf）. |
| InResizeMethod | Enum < ResizeMethod > | Resize method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Resized image. |
| Error | ErrorState | Gets the execution error message |
Image - Resize_OneDimension
Resizes the image, setting new length along the chosen dimension and adapting the other dimension (to maintain the original aspect ratio).
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InLength | Int | New length for the chosen dimension. Range: 〔1, +inf）. |
| InDimension | Enum < Dimension > | Selected dimension. |
| InResizeMethod | Enum < ResizeMethod > | Resize method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Resized image. |
| Error | ErrorState | Gets the execution error message |
Image - Resize_Scale
Resizes the image, specifying the relative scale for each axis.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InScaleX | Float | Horizontal scale. Range: 〔0, +inf）. |
| InScaleY | Float | Vertical scale. Range: 〔0, +inf）. |
| InResizeMethod | Enum < ResizeMethod > | Resize method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Resized image. |
| Error | ErrorState | Gets the execution error message |
Image - Rotate
Rotates the image clockwise.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InAngle | Float | Rotation angle. |
| InRotationSize | Enum < RotationSize > | Output size （whether to fit the image or preserve the original size）. |
| InInterpolationMethod | Enum < InterpolationMethod2D > | Interpolation method. |
| InInverse | Bool | Whether to do the rotation counter-clockwise. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Rotated image. |
| Error | ErrorState | Gets the execution error message |
Image - Shear
Shifts the rows of the image by a certain amount.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InAxis | Enum < Axis > | Axis along which the shear is applied. |
| InShift | Float | Relative shift between consecutive rows or columns. |
| InInterpolationMethod | Enum < InterpolationMethod2D > | Interpolation method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |
Image - Transform
Transforms the image using a specified matrix.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InTransformMatrix | Matrix | Transformation matrix. |
| InInverse | Bool | Whether to apply to inverse transformation. |
| InInterpolationMethod | Enum < InterpolationMethod2D > | Interpolation method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |
Image - Translate
Translates the image by a vector.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InDelta | Vector2D | Translation vector. |
| InInverse | Bool | Whether to invert the translation. |
| InBorder | Pixel | Color used to fill the pixels outside the translated image. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Translated image. |
| Error | ErrorState | Gets the execution error message |
Image - Transpose
Inverts columns and rows of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Transposed image. |
| Error | ErrorState | Gets the execution error message |
Image - Trim
Trims the image to the specified region.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRegion | Region | Region to trim. |
| InBorder | Pixel | Pixel value used for areas outside the selected region. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |
Image - Uncrop
Reverses a crop operation.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InSelection | Box | Box defining the region to 'uncrop'. |
| InWidth | Int | Width of the original image. Range: 〔0, +inf）. |
| InHeight | Int | Height of the original image. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Output image. |
| Error | ErrorState | Gets the execution error message |