Features
Image - GetAnchoredPoint
Returns one of the 9 anchor points of an image (corners or mid-points).
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InPointAnchor | Enum < Anchor2D > | Anchor point to extract. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2D | Point2D | Output point. |
| Error | ErrorState | Gets the execution error message |
Image - GetBox
Returns the box representing the Image's border.
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 |
|---|---|---|
| OutBox | Box | Image's box. |
| Error | ErrorState | Gets the execution error message |
Image - GetCenter
Returns the geometrical center 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 |
|---|---|---|
| OutPoint2D | Point2D | Center. |
| Error | ErrorState | Gets the execution error message |
Image - GetHistogram
Creates the histogram from the image's pixel distribution.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InChannelIndex | Int | Selected channel. Range: 〔0, 3〕. |
| InDomainBegin | Float | The lowest value to consider in the histogram. |
| InBinCount | Int | The number of histogram bars. |
| InBinSize | Float | Width of a single histogram bin. Range: （0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutHistogram | Histogram | Output histogram. |
| Error | ErrorState | Gets the execution error message |
Image - GetLocalMaxima
Search for the local maxima in the image. Note: If the image has more than one channel, the channels' sum is considered to obtain a monochromatic image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InConsiderLowlands | Bool | Whether to consider local maxima zones with more than one pixel equal to the maxima. |
| InMinDistance | Float | Minimal distance between two found maxima. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutExtremum2D | Extremum2DArray | Found local maxima. |
| Error | ErrorState | Gets the execution error message |
Image - GetLocalMinima
Search for the local minima in the image. Note: If the image has more than one channel, the channels' sum is considered to obtain a monochromatic image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InConsiderLowlands | Bool | Whether to consider local minima zones with more than one pixel equal to the minima. |
| InMinDistance | Float | Minimal distance between two found minima. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutExtremum2D | Extremum2DArray | Found local minima. |
| Error | ErrorState | Gets the execution error message |
Image - GetMassCenter
Computes the mass center (based on the image's moments).
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 |
|---|---|---|
| OutPoint2D | Point2D | Mass center. |
| Error | ErrorState | Gets the execution error message |
Image - GetMoment
Computes the selected moment of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InMomentType | Enum < ImageMoment > | Type of moment. |
| InCentral | Bool | Whether to compute the central moment or not. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Moment. |
| Error | ErrorState | Gets the execution error message |
Image - GetNormMoment
Computes the selected normalized moment of the image.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InMomentType | Enum < ImageMoment > | Type of moment. |
| InCentral | Bool | Whether to compute the central moment or not. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Normalized moment. |
| Error | ErrorState | Gets the execution error message |
Image - GetOrientation
Returns the image's orientation (based on its moments). Note: The resulting angle is in the range [0, 180].
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 | Orientation angle. |
| Error | ErrorState | Gets the execution error message |
Image - GetPixelValues
Extracts the array of pixels present in the image (or in the specified 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 |
|---|---|---|
| OutFloat | FloatArray | Pixels' values. |
| Error | ErrorState | Gets the execution error message |
Image - GetProfileAlongPath
Returns the profile based on the image's pixels found on the specified path. Note: First it creates a series of segments across the scan path, then computes the average pixel on each of the segments and use them to create the final profile. The average pixel is not the only option: it can be extracted another value based on one of the accumulation modes existing.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InScanPath | Path | Path along which the profile is extracted. |
| InScanWidth | Int | Width （in pixels） of the scan path. Range: 〔1, +inf）. |
| InSamplingParams | SamplingParams | Parameters controlling the sampling process. |
| InSmoothingStdDev | Float | Standard deviation of the Gaussian smoothing （applied on the obtained profile）. Range: 〔0, +inf）. |
| InAccumulationMode | Enum < AccumulationMode > | How the pixel values are combined （average, median, middle, minimum, maximum or sum）. |
| InBorderColor | Pixel | Pixel value to consider outside the image （used whether the scan path touches an extremity of the image）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | Output profile. |
| Error | ErrorState | Gets the execution error message |
Image - GetProfileAlongPath2
Returns the profile of the image's pixels specified by the scan template in input.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InScanTemplate | ScanTemplate | Defines the path along which the profile is extracted. |
| InSmoothingStdDev | Float | Standard deviation of the Gaussian smoothing （applied on the obtained profile）. Range: 〔0, +inf）. |
| InAccumulationMode | Enum < AccumulationMode > | How the pixel values are combined （average, median, middle, minimum, maximum or sum）. |
| InBorderColor | Pixel | Pixel value to consider outside the image （used whether the scan path touches an extremity of the image）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | Output profile. |
| Error | ErrorState | Gets the execution error message |
Image - GetProjection
Computes the average (or another pixel combination) for each image row or column and merges it into a profile.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | The input Image |
| InProjectionDirection | Enum < ProjectionDirection > | Whether to combine the pixel values horizontally or vertically. |
| InProjectionCombination | Enum < ProjectionCombination > | How the pixel values are merged （average, median, middle, minimum, maximum or sum）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | Output profile. |
| Error | ErrorState | Gets the execution error message |
Image - GetSharpness
Returns the sharpness of the image. Note: The bigger the value the sharper 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 |
|---|---|---|
| OutFloat | Float | Sharpness value. |
| Error | ErrorState | Gets the execution error message |
Image - GetStdDev
Computes the standard deviation of image pixel values.
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 | Standard deviation. |
| Error | ErrorState | Gets the execution error message |
Extremum2D - CreateExtremum2D_CreateFromValues
Creates a new Extremum2D object.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Position with subpixel-precision. |
| InValue | Float | Value. |
| InPolarity | Enum < Polarity > | Polarity （a dark pixel if the extremum represents a minimum, a bright one otherwise）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutExtremum2D | Extremum2D | The Extremum2D instance. |
| Error | ErrorState | Gets the execution error message |