Basics
Pixel - CreatePixel_CreateFromValues
Constructs a new Pixel object.
IN
| Name | Type | Description |
|---|---|---|
| InX | Float | First pixel component （usually red）. |
| InY | Float | Second pixel component （usually green）. |
| InZ | Float | Third pixel component （usually blue）. |
| InA | Float | Fourth pixel component. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | Pixel | The Pixel instance. |
| Error | ErrorState | Gets the execution error message |
Pixel - Deserialize
De-serialize a Pixel buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | Pixel | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Pixel - Serialize
Serialize the Pixel object using flatbuffers.
IN
| Name | Type | Description |
|---|---|---|
| InPixel | Pixel | The input Pixel |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutByteBuffer | Buffer | Buffer where the object is stored. |
| Error | ErrorState | Gets the execution error message |
PixelFormat - CreatePixelFormat_CreateFromValues
Constructs a new Pixel Format object.
IN
| Name | Type | Description |
|---|---|---|
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixelFormat | PixelFormat | The PixelFormat instance. |
| Error | ErrorState | Gets the execution error message |
Image - ConvertToType
Changes the pixel type (in-place). Note: If the value of pixel component doesn't fit in the range of the new type, it is clipped to the nearest proper value (maximum or minimum for the new type).
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InNewType | Enum < PixelType > | New pixel type of the image. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - ConvertToType_DepthScale
Changes the pixel type. Note: If the value of pixel component doesn't fit in the range of the new type, it is clipped to the nearest proper value (maximum or minimum for the new type).
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InNewType | Enum < PixelType > | New pixel type of the image. |
| InDepthDelta | Int | Pixel values are multiplied by 2^inDepthDelta. Range: 〔-30, 30〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Converted image. |
| Error | ErrorState | Gets the execution error message |
Image - Copy_FromBox
Returns a copy of the image with black pixels outside the box.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRoi | Box | Rectangle of pixels to maintain. |
| 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 - Copy_FromRegion
Returns a copy of the image with black pixels outside the region.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRoi | Region | Region of pixels to maintain. |
| 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 - CreateImage_CreateEmpty
Construct an Image object, setting size, pixel type and number of channels.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width of the image. Range: 〔0, +inf）. |
| InHeight | Int | Height of the image. Range: 〔0, +inf）. |
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - CreateImage_CreateFromBox
Construct a new Image object, using a box to identify the non-zero pixels.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width of the image. Range: 〔0, +inf）. |
| InHeight | Int | Height of the image. Range: 〔0, +inf）. |
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| InBox | Box | Box to define where the pixels will not be set to zero. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - CreateImage_CreateFromData
Construct a new Image object by wrapping existing data.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width of the image. Range: 〔0, +inf）. |
| InHeight | Int | Height of the image. Range: 〔0, +inf）. |
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| InData | Buffer | Existing image data. |
| InDeepCopy | Bool | Whether to perform a deep copy. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - CreateImage_CreateFromPixel
Construct an Image object with all the pixels set to a specific value.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width of the image. Range: 〔1, +inf）. |
| InHeight | Int | Height of the image. Range: 〔1, +inf）. |
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| InPixel | Pixel | Pixel value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - CreateImage_CreateFromPixels
Construct an Image object from an array of pixels. Note: If the pixels are not enough for all the image, only a part (starting from the top-left corner) will be covered.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width of the image. Range: 〔1, +inf）. |
| InHeight | Int | Height of the image. Range: 〔1, +inf）. |
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| InPixels | PixelArray | Pixel values. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - CreateImage_CreateFromProfiles
Construct a new Image object by joining an array of profiles together as consecutive image rows.
IN
| Name | Type | Description |
|---|---|---|
| InProfiles | ProfileArray | Array of profiles. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - CreateImage_CreateFromRegion
Construct a new Image object from a Region of interest.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Width of the image. Range: 〔0, +inf）. |
| InHeight | Int | Height of the image. Range: 〔0, +inf）. |
| InPixelType | Enum < PixelType > | Pixel type. |
| InChannels | Int | Number of inChannels. Range: 〔1, 4〕. |
| InRoi | Region | Region where the pixels will not be set to zero. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The Image instance. |
| Error | ErrorState | Gets the execution error message |
Image - Deserialize
De-serialize an Image buffer.
IN
| Name | Type | Description |
|---|---|---|
| InBuffer | Buffer | Buffer containing the object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | Deserialized object. |
| Error | ErrorState | Gets the execution error message |
Image - GetArea
Returns the area 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 |
|---|---|---|
| OutInt | Int | Area. |
| Error | ErrorState | Gets the execution error message |
Image - GetChannels
Returns the number of channels 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 |
|---|---|---|
| OutInt | Int | Number of channels. |
| Error | ErrorState | Gets the execution error message |
Image - GetColumn
Extracts the array of pixel values from a single column of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InColIndex | Int | Image's column. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | PixelArray | Pixel values of the column. |
| Error | ErrorState | Gets the execution error message |
Image - GetColumnImage
Creates a new image using a single column of the current one.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InColIndex | Int | Image's column. 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 |
Image - GetData
Returns the pointer to the image's data.
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 |
|---|---|---|
| OutIntPtr | Buffer | Data pointer. |
| Error | ErrorState | Gets the execution error message |
Image - GetDataSize
Returns the size of a single image pixel in bytes.
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 |
|---|---|---|
| OutInt | Int | Data size. |
| Error | ErrorState | Gets the execution error message |
Image - GetFrame
Returns a Size object containing the image's width and height.
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 |
|---|---|---|
| OutSize | Size | Image frame. |
| Error | ErrorState | Gets the execution error message |
Image - GetGrayValue
Returns the grayscale pixel's value given a specific spot. Note: Both single-channel and 3-channel images are supported.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InX | Int | X coordinate. Range: 〔0, +inf）. |
| InY | Int | Y coordinate. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Pixel value. |
| Error | ErrorState | Gets the execution error message |
Image - GetHeight
Returns the height 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 |
|---|---|---|
| OutInt | Int | Height. |
| Error | ErrorState | Gets the execution error message |
Image - GetImageFormat
Returns an ImageFormat object associated with the image object.
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 |
|---|---|---|
| OutImageFormat | ImageFormat | Image format. |
| Error | ErrorState | Gets the execution error message |
Image - GetInterpolatedPixel
Returns an interpolated pixel on the image. Note: The position must be inside the image frame.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPosition | Point2D | Point on the image to be accessed. |
| InInterpolation | 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 |
|---|---|---|
| OutPixel | Pixel | Output pixel. |
| Error | ErrorState | Gets the execution error message |
Image - GetInterpolatedPixels
Returns an array of pixel values at specified positions. Note: All positions must be inside the image frame.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPositions | Point2DArray | Points on the image to be accessed. |
| InInterpolation | 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 |
|---|---|---|
| OutPixel | PixelArray | Output pixels. |
| Error | ErrorState | Gets the execution error message |
Image - GetMaxValue
Returns the maximum pixel's value for the current pixel type.
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 |
|---|---|---|
| OutFloat | Float | Maximum value. |
| Error | ErrorState | Gets the execution error message |
Image - GetMinValue
Returns the minimum pixel's value for the current pixel type.
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 |
|---|---|---|
| OutFloat | Float | Minimum value. |
| Error | ErrorState | Gets the execution error message |
Image - GetPitch
Returns the pitch (bytes in a row) 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 |
|---|---|---|
| OutInt | Int | Pitch. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixel
Returns a single pixel of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPosition | Point2Di | Pixel's position. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | Pixel | Output pixel. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixelFormat
Returns the image's pixel format.
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 |
|---|---|---|
| OutPixelFormat | PixelFormat | Pixel format. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixels
Returns an array of pixels at specified positions.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPositions | Point2DiArray | Pixels' positions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | PixelArray | Output pixels. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixelsFromBox
Returns an array of pixels (and their relative positions) inside a box.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRoi | Box | Box where pixels have to be extracted. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | PixelArray | Output pixels. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixelsFromRegion
Returns an array of pixels (and their relative positions) inside a specified region.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRoi | Region | Region of interest. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | PixelArray | Output pixels. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixelSize
Returns the size of a single pixel in bytes.
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 |
|---|---|---|
| OutInt | Int | Pixel's size. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixelType
Returns the image's pixel type.
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 |
|---|---|---|
| OutPixelType | Enum < PixelType > | Pixel type. |
| Error | ErrorState | Gets the execution error message |
Image - GetRow
Extracts the array of pixel values from a single row of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRowIndex | Int | Image's row. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPixel | PixelArray | Pixel values of the row. |
| Error | ErrorState | Gets the execution error message |
Image - GetRowImage
Creates a new image using a single row of the current one.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRowIndex | Int | Image's row. 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 |
Image - GetValue
Returns the pixel's value given a specific spot.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InX | Int | X coordinate. Range: 〔0, +inf）. |
| InY | Int | Y coordinate. Range: 〔0, +inf）. |
| InChannel | Int | Channel. Range: 〔0, 3〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Pixel value. |
| Error | ErrorState | Gets the execution error message |
Image - GetWidth
Returns the width 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 |
|---|---|---|
| OutInt | Int | Width. |
| Error | ErrorState | Gets the execution error message |
Image - IsEmpty
Returns whether the image is empty.
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 |
|---|---|---|
| OutBool | Bool | true if the image is empty. |
| Error | ErrorState | Gets the execution error message |
Image - Serialize
Serialize the Image object using flatbuffers.
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 |
|---|---|---|
| OutByteBuffer | Buffer | Where the image data are stored. |
| Error | ErrorState | Gets the execution error message |
Image - SetColumn
Sets pixel values on an entire column of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InColIndex | Int | Image's column. Range: 〔0, +inf）. |
| InPixel | Pixel | New pixel value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetPixel
Sets a pixel of the image to the selected value.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPixel | Pixel | New pixel value. |
| InPosition | Point2Di | Pixel's position. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetPixels
Sets a selection of pixels, each one to a specific new value.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPixels | PixelArray | New pixel values. |
| InPositions | Point2DiArray | Pixels to set. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetPixelsInBox
Sets the pixels inside the specified box to a new value.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPixel | Pixel | New pixel value. |
| InRoi | Box | Box of pixels to be set. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetPixelsInRegion
Sets the pixels inside the specified region to a new value. Note: If the region is partially outside the image, only the pixels that are inside the image will be set (no exception will be thrown for the out-of-bounds pixels).
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPixel | Pixel | New pixel value. |
| InRoi | Region | Region of pixels to be set. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetPixels_All
Sets all pixels of the image to one value.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPixel | Pixel | Pixel value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetPixels_Selected
Sets a selection of pixels to a new value.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPixel | Pixel | New pixel value. |
| InPositions | Point2DiArray | Pixels to select. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetRow
Sets pixel values in an entire row of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InRowIndex | Int | Image's row. Range: 〔0, +inf）. |
| InPixel | Pixel | New pixel value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - SetValue
Set the pixel's value in a specific spot.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InValue | Float | Pixel value to set. |
| InX | Int | X coordinate. Range: 〔0, +inf）. |
| InY | Int | Y coordinate. Range: 〔0, +inf）. |
| InChannel | Int | Channel. Range: 〔0, 3〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImage | Image | The modified Core.Data.Types.Image |
| Error | ErrorState | Gets the execution error message |
Image - ToRegion
Convert every non-zero pixel of the 1-channel image to a point in the output region.
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 |
|---|---|---|
| OutRegion | Region | Output region. |
| Error | ErrorState | Gets the execution error message |
ImageFormat - CreateImageFormat_CreateFromValues
Creates a new ImageFormat object.
IN
| Name | Type | Description |
|---|---|---|
| InWidth | Int | Image width. |
| InHeight | Int | Image height. |
| InType | Enum < PixelType > | Type of pixel components. |
| InDepth | Int | Number of pixel components. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutImageFormat | ImageFormat | The ImageFormat instance. |
| Error | ErrorState | Gets the execution error message |
ImageFormat - GetArea
Returns the area of the image (width * height).
IN
| Name | Type | Description |
|---|---|---|
| InImageFormat | ImageFormat | The input ImageFormat |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Area of the image. |
| Error | ErrorState | Gets the execution error message |