Description: Enhances local contrast using CLAHE.

Syntax: result = Action.AdaptiveContrast([contrastStrengthPercentage], [gridTilesX], [gridTilesY], [contrastClipLimit]).

Return Value: Boolean

Return Description: True if contrast enhancement succeeded; otherwise False.

Example:

Dim success = Action.AdaptiveContrast(20, 8, 8, 1.0F)

Description: Automatically adjusts image contrast.

Syntax: result = Action.AutoContrast([clipPercentage]).

Return Value: Boolean

Return Description: True if contrast adjustment succeeded; otherwise False.

Example:

Dim success = Action.AutoContrast(0.5F)

Description: Equalizes the image histogram across the tonal range.

Syntax: result = Action.AutoEqualize().

Return Value: Boolean

Return Description: True if equalization succeeded; otherwise False.

Example:

Dim success = Action.AutoEqualize()

Description: Automatically adjusts image gamma.

Syntax: result = Action.AutoGamma().

Return Value: Boolean

Return Description: True if gamma adjustment succeeded; otherwise False.

Example:

Dim success = Action.AutoGamma()

Description: Corrects shadow and highlight regions.

Syntax: result = Action.AutoShadowsHighlights([shadowCorrectionStrengthPercentage], [highlightCorrectionStrengthPercentage]).

Return Value: Boolean

Return Description: True if correction succeeded; otherwise False.

Example:

Dim success = Action.AutoShadowsHighlights(50.0F, 10.0F)

Description: Automatically adjusts the image tonal range.

Syntax: result = Action.AutoTone([clipPercentage]).

Return Value: Boolean

Return Description: True if tone adjustment succeeded; otherwise False.

Example:

Dim success = Action.AutoTone(0.5F)

Description: Automatically corrects white balance and color casts.

Syntax: result = Action.AutoWhiteBalance().

Return Value: Boolean

Return Description: True if white balance succeeded; otherwise False.

Example:

Dim success = Action.AutoWhiteBalance()

Description: Adjusts image brightness and contrast.

Syntax: result = Action.BrightContrast([brightnessLevel], [contrastLevel], [autoBrightness]).

Return Value: Boolean

Return Description: True if the adjustment was applied; otherwise False.

Example:

Dim success = Action.BrightContrast(0, 0, False)

Description: Replaces one RGB color with another.

Syntax: result = Action.ChangeColor([sourceColorRed], [sourceColorGreen], [sourceColorBlue], [targetColorRed], [targetColorGreen], [targetColorBlue]).

Return Value: Boolean

Return Description: True if replacement succeeded; otherwise False.

Example:

Dim success = Action.ChangeColor(255, 255, 255, 0, 0, 0)

Description: Adjusts image color in the perceptually uniform CIE Lab space.

Syntax: result = Action.CIELab([lightnessShift], [aAxisShift], [bAxisShift]).

Return Value: Boolean

Return Description: True if the adjustment was applied; otherwise False.

Example:

Dim success = Action.CIELab(0, 0, 0)

Description: Applies color deconvolution to separate stains in the active workspace image.

Syntax: result = Action.ColorDeconvolution(stainType, showColor).

Return Value: Boolean

Return Description: True if the deconvolution process succeeded; otherwise False.

Example:

Dim success = Action.ColorDeconvolution(0, True)

Description: Selects or isolates image pixels matching the specified target RGB color within a given tolerance.

Syntax: result = Action.ColorRangeSelection([targetColorRed], [targetColorGreen], [targetColorBlue], [colorSpaceType], [algorithmType], [tolerance], [keepOriginalColor]).

Return Value: Boolean

Return Description: True if the color range selection was applied; otherwise False.

Example:

Dim success = Action.ColorRangeSelection(0, 255, 0, 3, 1, 40, True)

Description: Converts the image to RG chromaticity coordinates.

Syntax: result = Action.ConvertToRgChrom().

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

Dim success = Action.ConvertToRgChrom()

Description: Corrects uneven image illumination using a rolling-ball algorithm.

Syntax: result = Action.CorrectUnevenIllumination([illuminationGridSize]).

Return Value: Boolean

Return Description: True if illumination correction succeeded; otherwise False.

Example:

Dim success = Action.CorrectUnevenIllumination(8)

Description: Removes the specified color channel from the image.

Syntax: result = Action.DeleteChannel([channelToDeleteType]).

Return Value: Boolean

Return Description: True if the channel was removed; otherwise False.

Example:

Dim success = Action.DeleteChannel(0)

Description: Creates a grayscale image from the selected color channel.

Syntax: result = Action.GrayFrom([sourceChannelType]).

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

Dim success = Action.GrayFrom(0)

Description: Converts the image to grayscale.

Syntax: result = Action.GrayScaling().

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

Dim success = Action.GrayScaling()

Description: Applies a color map to a grayscale image.

Syntax: result = Action.GrayToColor([mapType], [isReversed]).

Return Value: Boolean

Return Description: True if the color map was applied; otherwise False.

Example:

Dim success = Action.GrayToColor(0, False)

Description: Adjusts hue, saturation, and intensity independently.

Syntax: result = Action.HueSaturationIntensity([hue], [saturation], [intensity]).

Return Value: Boolean

Return Description: True if the adjustment was applied; otherwise False.

Example:

Dim success = Action.HueSaturationIntensity(0, 0, 0)

Description: Inverts all image colors to create a negative.

Syntax: result = Action.Invert().

Return Value: Boolean

Return Description: True if colors were inverted; otherwise False.

Example:

Dim success = Action.Invert()

Description: Merges three image sources as channels in the selected color space.

Syntax: result = Action.MergeChannels([colorSpaceType], [image1Source], [image2Source], [image3Source]).

Return Value: Boolean

Return Description: True if the channels were merged; otherwise False.

Example:

Dim success = Action.MergeChannels(0, 0, 1, 2)

Description: Adjusts saturation and intensity for red, yellow, green, cyan, blue, and magenta bands.

Syntax: result = Action.MultibandColor([rSat], [rInt], [ySat], [yInt], [gSat], [gInt], [cyanSat], [cyanInt], [bSat], [bInt], [mSat], [mInt]).

Return Value: Boolean

Return Description: True if the adjustment was applied; otherwise False.

Example:

Dim success = Action.MultibandColor(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

Description: Removes background using rolling-ball subtraction.

Syntax: result = Action.RollingBallBackgroundSubtraction([rollingBallBoxSize], [isObjectColorAutomatic], [manualObjectColorType]).

Return Value: Boolean

Return Description: True if background subtraction succeeded; otherwise False.

Example:

Dim success = Action.RollingBallBackgroundSubtraction(50, True, 0)

Description: Splits the image into the selected RGB channel.

Syntax: result = Action.SplitRGB([rgbSplitChannelType]).

Return Value: Boolean

Return Description: True if the channel was extracted; otherwise False.

Example:

Dim success = Action.SplitRGB(0)

Description: Extracts the average value of the selected color channel.

Syntax: result = Action.AverageColorValue([analysisTargetChannelType]).

Return Value: String

Return Description: String containing the extracted value, or an empty string if extraction fails.

Example:

Dim average = Action.AverageColorValue(0)

Description: Exports individual regions identified by a binary mask image.

Syntax: result = Action.CropExportRegions([maskSourceLocation], [connectivityType], [marginPixels], [outputModeType], [transparentBackground], [backgroundColorRed], [backgroundColorGreen], [backgroundColorBlue], [destinationFolder], [filePrefix], [imageFormatType]).

Return Value: Boolean

Return Description: True if region export succeeded; otherwise False.

Example:

Dim success = Action.CropExportRegions(1, 0, 0, 1, True, 0, 0, 0, "C:\\ExportedRegions", "Region\_", 0)

Description: Analyzes cells in a grid and extracts per-cell statistics.

Syntax: result = Action.MultiCellAnalysis([gridColumnsX], [gridRowsY], [cellShapeType], [cellDiameterPixels], [analysisModeType], [analysisTargetChannelType], [targetColorPresetName]).

Return Value: String

Return Description: String containing analysis data, or an empty string if analysis fails.

Example:

Dim data = Action.MultiCellAnalysis(5, 5, 1, 20, 0, 0, "White")

Description: Extracts text from the workspace image using OCR.

Syntax: result = Action.OCRTextExtraction().

Return Value: String

Return Description: Extracted text, an empty string when no text is found, or an error message.

Example:

Dim text = Action.OCRTextExtraction()

Description: Counts pixels matching the specified RGB color.

Syntax: result = Action.PixelCounter([targetColorRed], [targetColorGreen], [targetColorBlue], [resultOutputFormatType]).

Return Value: String

Return Description: String containing the count results, or an empty string if extraction fails.

Example:

Dim counts = Action.PixelCounter(255, 255, 255, 0)

Description: Adds a binary image mask to the current selection using logical OR.

Syntax: result = Action.AddSelectionFromBinaryImage([sourceImageLocation]).

Return Value: Boolean

Return Description: True if the selection was updated; otherwise False.

Example:

Dim success = Action.AddSelectionFromBinaryImage(1)

Description: Copies the current image to the clipboard.

Syntax: result = Action.Copy().

Return Value: Boolean

Return Description: True if the image was copied; otherwise False.

Example:

Dim success = Action.Copy()

Description: Creates a selection mask from a binary workspace or buffer image.

Syntax: result = Action.CreateSelectionFromBinaryImage([sourceImageLocation]).

Return Value: Boolean

Return Description: True if the selection was created; otherwise False.

Example:

Dim success = Action.CreateSelectionFromBinaryImage(1)

Description: Expands the current selection by a specified number of pixels.

Syntax: result = Action.ExpandSelection([expandByPixels]).

Return Value: Boolean

Return Description: True if the selection changed; otherwise False.

Example:

Dim success = Action.ExpandSelection(8)

Description: Loads an image from an image-buffer location into the workspace.

Syntax: result = Action.GetFromImageBuffer([sourceLocation]).

Return Value: Boolean

Return Description: True if the image was loaded; otherwise False.

Example:

Dim success = Action.GetFromImageBuffer(1)

Description: Pastes an image from the clipboard into the workspace.

Syntax: result = Action.Paste().

Return Value: Boolean

Return Description: True if an image was pasted; otherwise False.

Example:

Dim success = Action.Paste()

Description: Pastes an image from the clipboard and fits it to the current rectangle.

Syntax: result = Action.PasteAndFitToRectangle().

Return Value: Boolean

Return Description: True if an image was pasted; otherwise False.

Example:

Dim success = Action.PasteAndFitToRectangle()

Description: Exports the current selection mask as a binary image to a buffer.

Syntax: result = Action.PasteSelectionAsBinaryToBuffer([targetBufferIndex]).

Return Value: Boolean

Return Description: True if the mask was written; otherwise False.

Example:

Dim success = Action.PasteSelectionAsBinaryToBuffer(1)

Description: Copies the current image to an image-buffer location.

Syntax: result = Action.PutToImageBuffer([targetLocation]).

Return Value: Boolean

Return Description: True if the image was stored; otherwise False.

Example:

Dim success = Action.PutToImageBuffer(1)

Description: Inverts the current selection mask.

Syntax: result = Action.ReverseSelection().

Return Value: Boolean

Return Description: True if the selection was reversed; otherwise False.

Example:

Dim success = Action.ReverseSelection()

Description: Shrinks the current selection by a specified number of pixels.

Syntax: result = Action.ShrinkSelection([shrinkByPixels]).

Return Value: Boolean

Return Description: True if the selection changed; otherwise False.

Example:

Dim success = Action.ShrinkSelection(3)

Description: Subtracts a binary image mask from the current selection using logical AND NOT.

Syntax: result = Action.SubtractSelectionFromBinaryImage([sourceImageLocation]).

Return Value: Boolean

Return Description: True if the selection was updated; otherwise False.

Example:

Dim success = Action.SubtractSelectionFromBinaryImage(1)

Description: Clears the current selection.

Syntax: result = Action.Unselect().

Return Value: Boolean

Return Description: True if the selection was cleared; otherwise False.

Example:

Dim success = Action.Unselect()

Description: Acquires an image from a scanner.

Syntax: result = Action.AcquireImagefromScanner([useSilentMode]).

Return Value: Boolean

Return Description: True if acquisition succeeded; otherwise False.

Example:

Dim success = Action.AcquireImagefromScanner(True)

Description: Captures an image from a connected camera or scanner.

Syntax: result = Action.Capture().

Return Value: Boolean

Return Description: True if capture succeeded; otherwise False.

Example:

Dim success = Action.Capture()

Description: Sharpens the image using the advanced sharpening filter.

Syntax: result = Action.AdvancedSharpening([sharpenAmountPercentage]).

Return Value: Boolean

Return Description: True if sharpening was applied; otherwise False.

Example:

Dim success = Action.AdvancedSharpening(125)

Description: Smooths the image using a box-averaging filter.

Syntax: result = Action.BoxAveraging([kernelSize]).

Return Value: Boolean

Return Description: True if the filter was applied; otherwise False.

Example:

Dim success = Action.BoxAveraging(5)

Description: Overlays an image while making the selected chroma-key color transparent.

Syntax: result = Action.ChromaKeyOverlay([sourceLocation1], [targetColorRed], [targetColorGreen], [targetColorBlue], [sourceLocation2], [opacity], [enableFeathering], [featheringRadius], [tolerance], [softness]).

Return Value: Boolean

Return Description: True if the overlay was applied; otherwise False.

Example:

Dim success = Action.ChromaKeyOverlay(1, 0, 255, 0, 0, 100, False, 30, 35, 20)

Description: Crops a rectangular area from the image.

Syntax: result = Action.Crop([cropWidthPixels], [cropHeightPixels], [startXCoordinate], [startYCoordinate]).

Return Value: Boolean

Return Description: True if cropping was applied; otherwise False.

Example:

Dim success = Action.Crop(500, 500, 0, 0)

Description: Applies a dithering algorithm to reduce image color depth.

Syntax: result = Action.Dithering([ditheringAlgorithmType]).

Return Value: Boolean

Return Description: True if dithering was applied; otherwise False.

Example:

Dim success = Action.Dithering(0)

Description: Creates an embossed relief effect.

Syntax: result = Action.Emboss([angle], [distance], [strength], [bias]).

Return Value: Boolean

Return Description: True if the effect was applied; otherwise False.

Example:

Dim success = Action.Emboss(135.0F, 1, 100, 128)

Description: Transforms the image into the frequency domain using FFT.

Syntax: result = Action.FFT().

Return Value: Boolean

Return Description: True if the transform was applied; otherwise False.

Example:

Dim success = Action.FFT()

Description: Flips the image horizontally.

Syntax: result = Action.FlipHorizontally().

Return Value: Boolean

Return Description: True if the image was transformed; otherwise False.

Example:

Dim success = Action.FlipHorizontally()

Description: Flips the image vertically.

Syntax: result = Action.FlipVertically().

Return Value: Boolean

Return Description: True if the image was transformed; otherwise False.

Example:

Dim success = Action.FlipVertically()

Description: Adjusts image brightness using gamma correction.

Syntax: result = Action.GammaAdjustment([gammaValue]).

Return Value: Boolean

Return Description: True if the adjustment was applied; otherwise False.

Example:

Dim success = Action.GammaAdjustment(0.8)

Description: Blurs the image using a Gaussian filter.

Syntax: result = Action.GaussianFilter([kernelSize]).

Return Value: Boolean

Return Description: True if the filter was applied; otherwise False.

Example:

Dim success = Action.GaussianFilter(5)

Description: Places and transforms a buffer image stamp over the current image.

Syntax: result = Action.ImageStamp([stampImageSource], [locationX], [locationY], [scaleX], [scaleY], [angle], [opacity], [enableTransparentColor], [transparentColorArgb], [enableGradualAlpha], [tolerance], [enableFeather], [featherRadius]).

Return Value: Boolean

Return Description: True if the stamp was applied; otherwise False.

Example:

Dim success = Action.ImageStamp(1, 0, 0, 100, 100, 0.0F, 100, False, -1, False, 30, False, 10)

Description: Reconstructs a spatial image from frequency-domain data using inverse FFT.

Syntax: result = Action.InverseFFT().

Return Value: Boolean

Return Description: True if the inverse transform was applied; otherwise False.

Example:

Dim success = Action.InverseFFT()

Description: Applies a mosaic or pixelation effect.

Syntax: result = Action.MosaicFilter([mosaicModeType], [value]).

Return Value: Boolean

Return Description: True if the effect was applied; otherwise False.

Example:

Dim success = Action.MosaicFilter(0, 10)

Description: Overlays two workspace or buffer images with opacity, blending, and feathering options.

Syntax: result = Action.OverlayImage([sourceLocation1], [sourceLocation2], [targetColorRed], [targetColorGreen], [targetColorBlue], [opacity], [enableFeathering], [featheringRadius], [tolerance], [gradientAlpha]).

Return Value: Boolean

Return Description: True if the overlay was applied; otherwise False.

Example:

Dim success = Action.OverlayImage(1, 0, 0, 0, 0, 100, False, 30, 0, False)

Description: Resizes the image to the requested dimensions using the selected interpolation.

Syntax: result = Action.Resize([resizeUnitType], [maintainAspectRatio], [baseDimensionType], [targetWidth], [targetHeight], [interpolationAlgorithmType]).

Return Value: Boolean

Return Description: True if the image was resized; otherwise False.

Example:

Dim success = Action.Resize(0, True, 0, 800, 600, 4)

Description: Resizes the canvas around the image with alignment and fill-color options.

Syntax: result = Action.ResizeCanvas([resizeUnitType], [maintainAspectRatio], [baseDimensionType], [targetWidth], [targetHeight], [canvasAlignmentType], [backgroundColorRed], [backgroundColorGreen], [backgroundColorBlue]).

Return Value: Boolean

Return Description: True if the canvas was resized; otherwise False.

Example:

Dim success = Action.ResizeCanvas(0, True, 0, 800, 600, 0, 255, 255, 255)

Description: Rotates the image by the requested angle and fills uncovered areas.

Syntax: result = Action.Rotate([rotationAngleDegrees], [rotationDirectionType], [backgroundColorRed], [backgroundColorGreen], [backgroundColorBlue]).

Return Value: Boolean

Return Description: True if rotation was applied; otherwise False.

Example:

Dim success = Action.Rotate(90.0F, 1, 255, 255, 255)

Description: Rotates the image to align it with a detected line.

Syntax: result = Action.RotationalAlignmentByLine([backgroundColorRed], [backgroundColorGreen], [backgroundColorBlue]).

Return Value: Boolean

Return Description: True if alignment was applied; otherwise False.

Example:

Dim success = Action.RotationalAlignmentByLine(255, 255, 255)

Description: Sharpens image details using a 3×3 convolution filter.

Syntax: result = Action.Sharpen3x3().

Return Value: Boolean

Return Description: True if sharpening was applied; otherwise False.

Example:

Dim success = Action.Sharpen3x3()

Description: Sharpens the image using a high-quality 5×5 filter.

Syntax: result = Action.Sharpen5x5HighQuality([sharpenStrengthPercentage]).

Return Value: Boolean

Return Description: True if sharpening was applied; otherwise False.

Example:

Dim success = Action.Sharpen5x5HighQuality(20)

Description: Reduces image noise while preserving edges.

Syntax: result = Action.SmartDenoise([radius], [threshold]).

Return Value: Boolean

Return Description: True if denoising was applied; otherwise False.

Example:

Dim success = Action.SmartDenoise(5, 30)

Description: Blurs the image using a high-speed Stack Blur algorithm.

Syntax: result = Action.StackBlur([kernelSize]).

Return Value: Boolean

Return Description: True if the filter was applied; otherwise False.

Example:

Dim success = Action.StackBlur(5)

Description: Adds a styled text annotation or watermark to the image.

Syntax: result = Action.TextAnnotation([textString], [locationX], [locationY], [fontName], [fontSize], [fontStyleInt], [innerColorArgb], [outerColorArgb], [opacity], [outlineThickness], [angle], [isAntiAlias]).

Return Value: Boolean

Return Description: True if the annotation was drawn; otherwise False.

Example:

Dim success = Action.TextAnnotation("Sample", 20, 20, "Arial", 12.0F, 0, -256, -16777216, 100, 1.0F, 0.0F, True)

Description: Automatically selects the main subject in a general image.

Syntax: result = Action.AIAutoSubjectSelectionGeneral().

Return Value: Boolean

Return Description: True if subject selection succeeded; otherwise False.

Example:

Dim success = Action.AIAutoSubjectSelectionGeneral()

Description: Automatically selects the subject in a portrait image.

Syntax: result = Action.AIAutoSubjectSelectionPortrait().

Return Value: Boolean

Return Description: True if subject selection succeeded; otherwise False.

Example:

Dim success = Action.AIAutoSubjectSelectionPortrait()

Description: Removes the background from a general image and fills it with a color.

Syntax: result = Action.AIBackgroundRemovalGeneral([virtualBackgroundColorRed], [virtualBackgroundColorGreen], [virtualBackgroundColorBlue]).

Return Value: Boolean

Return Description: True if background removal succeeded; otherwise False.

Example:

Dim success = Action.AIBackgroundRemovalGeneral(255, 255, 255)

Description: Removes the background from a portrait image and fills it with a color.

Syntax: result = Action.AIBackgroundRemovalPortrait([virtualBackgroundColorRed], [virtualBackgroundColorGreen], [virtualBackgroundColorBlue]).

Return Value: Boolean

Return Description: True if background removal succeeded; otherwise False.

Example:

Dim success = Action.AIBackgroundRemovalPortrait(255, 255, 255)

Description: Removes the background from a selfie and fills it with a color.

Syntax: result = Action.AIBackgroundRemovalSelfie([virtualBackgroundColorRed], [virtualBackgroundColorGreen], [virtualBackgroundColorBlue]).

Return Value: Boolean

Return Description: True if background removal succeeded; otherwise False.

Example:

Dim success = Action.AIBackgroundRemovalSelfie(255, 255, 255)

Description: Segments a document image and binarizes it using an AI model.

Syntax: result = Action.AIBinarizationSegmentation().

Return Value: Boolean

Return Description: True if segmentation and binarization succeeded; otherwise False.

Example:

Dim success = Action.AIBinarizationSegmentation()

Description: Binarizes the image using a selected custom ONNX model.

Syntax: result = Action.AICustomBinarization([targetModelName]).

Return Value: Boolean

Return Description: True if binarization succeeded; otherwise False.

Example:

Dim success = Action.AICustomBinarization("")

Description: Estimates an image depth map using an AI model.

Syntax: result = Action.AIDepthEstimation([autoResizeLargeImages]).

Return Value: Boolean

Return Description: True if depth estimation succeeded; otherwise False.

Example:

Dim success = Action.AIDepthEstimation(True)

Description: Straightens and unwarps a perspective-distorted document image.

Syntax: result = Action.AIDocumentUnwarping().

Return Value: Boolean

Return Description: True if document unwarping succeeded; otherwise False.

Example:

Dim success = Action.AIDocumentUnwarping()

Description: Restores a low-quality image using the fast AI model.

Syntax: result = Action.AIImageQualityRestorationFast([restorationBoostFactor]).

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

Dim success = Action.AIImageQualityRestorationFast(1.0F)

Description: Restores a low-quality image using the fastest AI preview model.

Syntax: result = Action.AIImageQualityRestorationFastest().

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

Dim success = Action.AIImageQualityRestorationFastest()

Description: Restores a low-quality image using the slower, more accurate AI model.

Syntax: result = Action.AIImageQualityRestorationSlow().

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

Dim success = Action.AIImageQualityRestorationSlow()

Description: Restores a low-quality image using the highest-quality AI model.

Syntax: result = Action.AIImageQualityRestorationSlowest().

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

Dim success = Action.AIImageQualityRestorationSlowest()

Description: Sharpens the image using AI enhancement.

Syntax: result = Action.AIImageSharpening([sharpenBoostFactor]).

Return Value: Boolean

Return Description: True if sharpening succeeded; otherwise False.

Example:

Dim success = Action.AIImageSharpening(2.5F)

Description: Upscales the image using the fast RealESRGAN model variant.

Syntax: result = Action.AIImageUpscaleRealESRFast().

Return Value: Boolean

Return Description: True if upscaling succeeded; otherwise False.

Example:

Dim success = Action.AIImageUpscaleRealESRFast()

Description: Upscales the image using the RealESRGAN AI model.

Syntax: result = Action.AIImageUpscaleRealESRGAN([upscaleMagnificationType]).

Return Value: Boolean

Return Description: True if upscaling succeeded; otherwise False.

Example:

Dim success = Action.AIImageUpscaleRealESRGAN(4)

Description: Removes unwanted image content using AI inpainting.

Syntax: result = Action.AIInpainting().

Return Value: Boolean

Return Description: True if inpainting succeeded; otherwise False.

Example:

Dim success = Action.AIInpainting()

Description: Detects objects with YOLOv3 and optionally draws boxes or exports a CSV.

Syntax: result = Action.AIObjectDetection([confidenceThreshold], [nmsThreshold], [enableTiling], [targetClasses], [drawBoundingBoxes], [showConfidence], [boxColorRed], [boxColorGreen], [boxColorBlue], [exportCSV], [csvExportDirectory]).

Return Value: Boolean

Return Description: True if detection completed; otherwise False.

Example:

Dim success = Action.AIObjectDetection(0.5F, 0.4F, False, "", True, True, 255, 0, 0, False, "")

Description: Restores details in an overexposed image using an AI model.

Syntax: result = Action.AIOverExposureCorrection().

Return Value: Boolean

Return Description: True if correction succeeded; otherwise False.

Example:

Dim success = Action.AIOverExposureCorrection()

Description: Creates an intelligent selection using image content analysis.

Syntax: result = Action.AISmartSelection().

Return Value: Boolean

Return Description: True if the selection was created; otherwise False.

Example:

Dim success = Action.AISmartSelection()

Description: Restores details in an underexposed image using an AI model.

Syntax: result = Action.AIUnderExposureCorrection().

Return Value: Boolean

Return Description: True if correction succeeded; otherwise False.

Example:

Dim success = Action.AIUnderExposureCorrection()

Description: Applies adaptive thresholding to images with varying illumination.

Syntax: result = Action.AdaptiveThresholding([adaptiveBoxSize], [adaptiveThresholdLevel], [isObjectColorAutomatic], [manualObjectColorType]).

Return Value: Boolean

Return Description: True if thresholding succeeded; otherwise False.

Example:

Dim success = Action.AdaptiveThresholding(100, 90, False, 1)

Description: Performs a logical operation between two workspace or buffer images.

Syntax: result = Action.BinaryOperation([logicalOperationType], [firstImageSourceLocation], [secondImageSourceLocation]).

Return Value: Boolean

Return Description: True if the operation succeeded; otherwise False.

Example:

Dim success = Action.BinaryOperation(0, 0, 1)

Description: Detects object boundaries using the selected overlay mode.

Syntax: result = Action.BoundaryDetection([boundaryOverlayModeType]).

Return Value: Boolean

Return Description: True if boundary detection succeeded; otherwise False.

Example:

Dim success = Action.BoundaryDetection(0)

Description: Detects edges using the Canny algorithm.

Syntax: result = Action.CannyEdge([cannyHighThreshold]).

Return Value: Boolean

Return Description: True if detection succeeded; otherwise False.

Example:

Dim success = Action.CannyEdge(100)

Description: Converts every non-black pixel to white.

Syntax: result = Action.ChangeNonBlackToWhite().

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

Dim success = Action.ChangeNonBlackToWhite()

Description: Computes the difference between two workspace or buffer images.

Syntax: result = Action.DifferentialImage([firstImageSourceLocation], [secondImageSourceLocation]).

Return Value: Boolean

Return Description: True if the difference image was created; otherwise False.

Example:

Dim success = Action.DifferentialImage(0, 1)

Description: Applies morphological dilation to expand foreground objects.

Syntax: result = Action.Dilate([morphologyKernelSize]).

Return Value: Boolean

Return Description: True if dilation was applied; otherwise False.

Example:

Dim success = Action.Dilate(3)

Description: Dilates traced outlines to make them thicker.

Syntax: result = Action.DilateOutline().

Return Value: Boolean

Return Description: True if outlines were dilated; otherwise False.

Example:

Dim success = Action.DilateOutline()

Description: Draws a colored border around the selected region or ROIs.

Syntax: result = Action.DrawSelectionBorder([borderColorRed], [borderColorGreen], [borderColorBlue], [borderThicknessPixels], [borderOpacityPercentage], [applyToMultipleROIs]).

Return Value: Boolean

Return Description: True if the border was drawn; otherwise False.

Example:

Dim success = Action.DrawSelectionBorder(0, 0, 0, 1, 100, False)

Description: Detects image edges using the selected algorithm.

Syntax: result = Action.EdgeDetection([edgeDetectionAlgorithmType]).

Return Value: Boolean

Return Description: True if detection succeeded; otherwise False.

Example:

Dim success = Action.EdgeDetection(0)

Description: Applies morphological erosion to shrink foreground objects.

Syntax: result = Action.Erode([morphologyKernelSize]).

Return Value: Boolean

Return Description: True if erosion was applied; otherwise False.

Example:

Dim success = Action.Erode(3)

Description: Erodes traced outlines to make them thinner.

Syntax: result = Action.ErodeOutline().

Return Value: Boolean

Return Description: True if outlines were eroded; otherwise False.

Example:

Dim success = Action.ErodeOutline()

Description: Fills the selected region or ROI with a color and opacity.

Syntax: result = Action.FillRegion([fillRegionType], [fillColorRed], [fillColorGreen], [fillColorBlue], [fillOpacityPercentage]).

Return Value: Boolean

Return Description: True if the region was filled; otherwise False.

Example:

Dim success = Action.FillRegion(0, 0, 0, 0, 100)

Description: Hides object outlines using a specified or most frequent color.

Syntax: result = Action.HideOutlines([targetColorRed], [targetColorGreen], [targetColorBlue], [useMostFrequentColor]).

Return Value: Boolean

Return Description: True if outlines were hidden; otherwise False.

Example:

Dim success = Action.HideOutlines(255, 255, 255, True)

Description: Converts the image to binary using a manual intensity threshold.

Syntax: result = Action.ManualThresholding([binarizationThresholdValue]).

Return Value: Boolean

Return Description: True if binarization succeeded; otherwise False.

Example:

Dim success = Action.ManualThresholding(128)

Description: Applies multilevel thresholding independently to RGB channels.

Syntax: result = Action.MultiStepThresholding([redChannelLevels], [greenChannelLevels], [blueChannelLevels]).

Return Value: Boolean

Return Description: True if thresholding succeeded; otherwise False.

Example:

Dim success = Action.MultiStepThresholding(5, 5, 5)

Description: Traces object outlines while always preserving the original pixel colors on the extracted outlines.

Syntax: result = Action.Outline([isInverted], [applyBinarization]).

Return Value: Boolean

Return Description: True if outlines were traced; otherwise False.

Example:

Dim success = Action.Outline(False, False)

Description: Colors connected image regions to distinguish them.

Syntax: result = Action.RegionColoring([connectivity]).

Return Value: Boolean

Return Description: True if the regions were colored; otherwise False.

Example:

Dim success = Action.RegionColoring(8)

Description: Removes small connected components from a binary image.

Syntax: result = Action.RemoveDots(dotMode, maxDotSize, [connectivity]).

Return Value: Boolean

Return Description: True if dot removal succeeded; otherwise False.

Example:

Dim success = Action.RemoveDots(2, 20, 8)

Description: Reduces binary objects to one-pixel-wide skeletons.

Syntax: result = Action.Skeletonize([isExtended], [isInverted], [minBranchLength], [tailLength]).

Return Value: Boolean

Return Description: True if skeletonization succeeded; otherwise False.

Example:

Dim success = Action.Skeletonize(True, False, 15, 10)

Description: Segments the image into superpixels.

Syntax: result = Action.SuperPixelSegmentation([numSuperpixels], [compactness], [fillWithWhite]).

Return Value: Boolean

Return Description: True if segmentation succeeded; otherwise False.

Example:

Dim success = Action.SuperPixelSegmentation(400, 30.0F, False)

Description: Segments touching objects using watershed separation.

Syntax: result = Action.WatershedSegmentation([minDistanceThreshold], [smoothingRadius], [boundaryThickness], [boundaryColorRed], [boundaryColorGreen], [boundaryColorBlue]).

Return Value: Boolean

Return Description: True if segmentation succeeded; otherwise False.

Example:

Dim success = Action.WatershedSegmentation(10, 3, 1, 255, 0, 0)

Description: Activates undo tracking for workspace operations.

Syntax: Action.ActivateUndoEngine().

Return Value: Void

Return Description: Void.

Example:

Call Action.ActivateUndoEngine()

Description: Deactivates undo tracking for workspace operations.

Syntax: Action.DeactivateUndoEngine().

Return Value: Void

Return Description: Void.

Example:

Call Action.DeactivateUndoEngine()

Description: Returns a clone of the workspace image or an image-buffer image.

Syntax: result = Action.GetImage([sourceLocation]).

Return Value: Bitmap

Return Description: Bitmap clone, or Nothing when unavailable or export is not allowed.

Example:

Dim bitmap = Action.GetImage(0)

Description: Saves a bitmap image to the specified file path.

Syntax: result = Action.SaveImage(sourceBitmap, destFileName, [jpegQuality]).

Return Value: String

Return Description: String containing the save result or an error message.

Example:

Dim message = Action.SaveImage(bitmap, "C:\Images\result.jpg", 90)

Description: Opens a dialog to save an image with the selected format and quality.

Syntax: Action.SaveImageDialog(targetBitmap, selectedExtension, selectedQuality).

Return Value: Void

Return Description: Void. Throws an exception if export is not allowed.

Example:

Call Action.SaveImageDialog(bitmap, ".jpg", 90)

Description: Saves the current workspace with a new name.

Syntax: Action.SaveWorkspaceAs().

Return Value: Void

Return Description: Void. Throws an exception if export is not allowed.

Example:

Call Action.SaveWorkspaceAs()

Description: Saves the current workspace selection as a new file.

Syntax: Action.SaveWorkspaceSelectionAs().

Return Value: Void

Return Description: Void. Throws an exception if export is not allowed.

Example:

Call Action.SaveWorkspaceSelectionAs()

Description: Sets the workspace image or an image-buffer image from a bitmap clone.

Syntax: result = Action.SetImage(newImage, [targetLocation]).

Return Value: Boolean

Return Description: True when the image is assigned; otherwise False.

Example:

Dim success = Action.SetImage(bitmap, 0)

Description: Returns the most recent error message produced by the helper.

Syntax: result = classifier.GetLastError().

Return Value: String

Return Description: The last error message, or an empty string when no error is recorded.

Example:

Dim errorMessage = classifier.GetLastError()

Description: Loads an ML.NET image-classification model from the Classification Models folder.

Syntax: result = classifier.LoadModel(modelFilename, [forceReload]).

Return Value: Boolean

Return Description: True when the model is loaded or already loaded; otherwise False.

Example:

Dim loaded = classifier.LoadModel("model.zip", True)

Description: Predicts the class label for the supplied bitmap image.

Syntax: result = classifier.Predict(img).

Return Value: String

Return Description: Predicted class label, or an empty string if prediction fails.

Example:

Dim label = classifier.Predict(bitmap)

Description: Converts ARGB values to integer.

Syntax: result = imgproc.ARGBToARGBInteger(alpha, red, green, blue).

Return Value: Integer

Return Description: ARGB color as integer, or 0 if conversion fails.

Example:

Dim color = imgproc.ARGBToARGBInteger(255, 255, 0, 0)

Description: Converts ARGB bytes to Color object.

Syntax: result = imgproc.ARGBToColor(alpha, red, green, blue).

Return Value: Color

Return Description: Color object, or default color if conversion fails.

Example:

Dim clr = imgproc.ARGBToColor(255, 255, 0, 0)

Description: Changes specified color to new color throughout image.

Syntax: result = imgproc.Change_Color(srcImage, colorRGB, newR, newG, newB, [showProgress], [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Modified image, or Nothing if operation fails.

Example:

Dim modified = imgproc.Change_Color(bitmap, RGB(255,0,0), 0, 255, 0)

Description: Changes specified RGB color to new RGB color.

Syntax: result = imgproc.Change_Color_ByRGB(srcImage, r, g, b, newR, newG, newB, [showProgress], [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Modified image, or Nothing if operation fails.

Example:

Dim modified = imgproc.Change_Color_ByRGB(bitmap, 255, 0, 0, 0, 255, 0)

Description: Validates RGB values in text boxes.

Syntax: imgproc.Check_RGBInTextBox(textR, textG, textB).

Return Value: Void

Return Description: None.

Example:

Call imgproc.Check_RGBInTextBox(txtRed, txtGreen, txtBlue)

Description: Converts image to CIELab color space with adjustable L, a, b channels.

Syntax: result = imgproc.CIELab(srcImage, lShift, aShift, bShift, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: CIELab-converted image, or Nothing if conversion fails.

Example:

Dim cielab = imgproc.CIELab(bitmap, 0, 10, -10)

Description: Applies color deconvolution to separate stains in histological images using a high-speed parallel algorithm.

Syntax: result = imgproc.ColorDeconvolution(srcImage, stainType, showColor, [showProgress], [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Deconvoluted image, or Nothing if operation fails.

Example:

Dim deconvoluted = imgproc.ColorDeconvolution(bitmap, 0, True)

Description: Converts hexadecimal color string to integer.

Syntax: result = imgproc.ColorHexToColorInteger(hexColor).

Return Value: Integer

Return Description: Integer color value, or 0 if conversion fails.

Example:

Dim colorInt = imgproc.ColorHexToColorInteger("#FF0000")

Description: Converts hexadecimal color string to RGB components.

Syntax: imgproc.ColorHexToRGB(hexColor, outR, outG, outB).

Return Value: Void

Example:

Call imgproc.ColorHexToRGB("#FF0000", r, g, b)

Description: Displays ARGB values of a color integer to console output.

Syntax: imgproc.ColorIntegerToARGB(colorInt).

Return Value: Void

Return Description: Void; prints ARGB components to console.

Example:

Call imgproc.ColorIntegerToARGB(4294967295)

Description: Displays RGB values of a color integer to console output.

Syntax: imgproc.ColorIntegerToRGB(colorInt).

Return Value: Void

Return Description: Void; prints RGB components to console.

Example:

Call imgproc.ColorIntegerToRGB(255)

Description: Decomposes color to ARGB and HSI components.

Syntax: imgproc.ColorIntegerToRGBGHSI(colorInt, outR, outG, outB, outGray, outHue, outSat, outInt).

Return Value: Void

Example:

Call imgproc.ColorIntegerToRGBGHSI(color, r, g, b, gray, hue, sat, int)

Description: Selects or isolates pixels matching the specified target RGB color within a given tolerance.

Syntax: result = imgproc.ColorRangeSelection(srcImage, targetR, targetG, targetB, [colorSpace], [isFastAlgorithm], [tolerance], [maintainOrgColor], [isShowProgress], [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Processed Bitmap with color range selection applied, or Nothing if processing fails.

Example:

Dim selected = imgproc.ColorRangeSelection(bitmap, 0, 255, 0, "Chroma", False, 40, True)

Description: Converts RGB Color object to hexadecimal string representation.

Syntax: result = imgproc.ColorToColorHEX(color).

Return Value: String

Return Description: Hexadecimal color string (e.g., "#FF0000"), or empty string if conversion fails.

Example:

Dim hex = imgproc.ColorToColorHEX(Color.Red)

Description: Converts 24-bit grayscale to 8-bit indexed image format.

Syntax: result = imgproc.Convert_Gray24Bit_To_8bppIndexed(srcImage).

Return Value: Bitmap

Return Description: 8-bit indexed image, or Nothing if conversion fails.

Example:

Dim indexed = imgproc.Convert_Gray24Bit_To_8bppIndexed(bitmap)

Description: Converts RGB to rg chromaticity coordinates.

Syntax: result = imgproc.Convert_To_rgChromaticity(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: rg chromaticity image, or Nothing if conversion fails.

Example:

Dim rgChromaticity = imgproc.Convert_To_rgChromaticity(bitmap)

Description: Converts RGB to rg chromaticity with parallel processing.

Syntax: result = imgproc.Convert_To_rgChromaticity_Parallel(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: rg chromaticity image, or Nothing if conversion fails.

Example:

Dim rgChromaticity = imgproc.Convert_To_rgChromaticity_Parallel(bitmap)

Description: Removes blue channel from image.

Syntax: result = imgproc.Delete_BlueChannel(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Image with blue channel removed, or Nothing if operation fails.

Example:

Dim noBlue = imgproc.Delete_BlueChannel(bitmap)

Description: Removes green channel from image.

Syntax: result = imgproc.Delete_GreenChannel(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Image with green channel removed, or Nothing if operation fails.

Example:

Dim noGreen = imgproc.Delete_GreenChannel(bitmap)

Description: Removes red channel from image.

Syntax: result = imgproc.Delete_RedChannel(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Image with red channel removed, or Nothing if operation fails.

Example:

Dim noRed = imgproc.Delete_RedChannel(bitmap)

Description: Quantizes color channel value to discrete levels.

Syntax: result = imgproc.Digitalize(colorValue, levelCount).

Return Value: Byte

Return Description: Quantized color value.

Example:

Dim quantized = imgproc.Digitalize(128.5, 8)

Description: Extracts blue channel as grayscale image.

Syntax: result = imgproc.GrayFrom_Blue(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Blue channel as grayscale, or Nothing if extraction fails.

Example:

Dim grayBlue = imgproc.GrayFrom_Blue(bitmap)

Description: Extracts green channel as grayscale.

Syntax: result = imgproc.GrayFrom_Green(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Green channel as grayscale, or Nothing if extraction fails.

Example:

Dim grayGreen = imgproc.GrayFrom_Green(bitmap)

Description: Extracts red channel as grayscale image.

Syntax: result = imgproc.GrayFrom_Red(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Red channel as grayscale, or Nothing if extraction fails.

Example:

Dim grayRed = imgproc.GrayFrom_Red(bitmap)

Description: Converts colored image to grayscale using luminosity method.

Syntax: result = imgproc.GrayScaling(srcImage, [showProgress], [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Grayscale image, or Nothing if conversion fails.

Example:

Dim gray = imgproc.GrayScaling(bitmap, True)

Description: Applies color map to grayscale image for visualization.

Syntax: result = imgproc.GrayToColor(srcImage, mapType, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Colorized image, or Nothing if mapping fails.

Example:

Dim colored = imgproc.GrayToColor(grayBitmap, ImgProcessing.ColorMapType.Jet)

Description: Converts hexadecimal color string to RGB byte values.

Syntax: imgproc.HexToRGB(hexString, red, green, blue).

Return Value: Void

Return Description: Void; returns RGB values through ByRef parameters.

Example:

Dim r, g, b As Byte; imgproc.HexToRGB("#FF0000", r, g, b)

Description: Removes or hides outlines of specified color from image.

Syntax: result = imgproc.Hide_Outlines(srcImage, r, g, b, [useMostFrequent], [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Modified image with hidden outlines, or Nothing if operation fails.

Example:

Dim hidden = imgproc.Hide_Outlines(bitmap, 0, 0, 0)

Description: Converts HSI to RGB color space.

Syntax: imgproc.HSITORGB(hue, sat255, int255, outR, outG, outB).

Return Value: Void

Example:

Call imgproc.HSITORGB(180, 128, 200, red, green, blue)

Description: Converts HSV to RGB color space.

Syntax: imgproc.HSVtoRGB(hue, saturation, value, outR, outG, outB).

Return Value: Void

Example:

Call imgproc.HSVtoRGB(180, 0.5, 0.75, r, g, b)

Description: Adjusts hue, saturation, and intensity values of the image.

Syntax: result = imgproc.HueSaturationIntensity(srcImage, hueShift, satShift, intShift, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Hue-saturation-intensity adjusted image, or Nothing if processing fails.

Example:

Dim hsi = imgproc.HueSaturationIntensity(bitmap, 30, 20, -10)

Description: Checks if image is binary (contains only black and white pixels).

Syntax: result = imgproc.IsBinaryImage(srcImage).

Return Value: Boolean

Return Description: True if image is binary, False otherwise.

Example:

Dim isBinary = imgproc.IsBinaryImage(bitmap)

Description: Checks if RGB pixel values represent black or white.

Syntax: result = imgproc.IsBWPixel(red, green, blue).

Return Value: Boolean

Return Description: True if pixel is black or white, False otherwise.

Example:

Dim isBW = imgproc.IsBWPixel(0, 0, 0)

Description: Checks if image is grayscale (all color channels equal).

Syntax: result = imgproc.IsGrayImage(srcImage).

Return Value: Boolean

Return Description: True if image is grayscale, False otherwise.

Example:

Dim isGray = imgproc.IsGrayImage(bitmap)

Description: Returns maximum value among three color components.

Syntax: result = imgproc.Maximum(red, green, blue).

Return Value: Single

Return Description: Maximum value among the three components.

Example:

Dim max = imgproc.Maximum(255.0, 128.0, 200.0)

Description: Merges three channel images using specified color space.

Syntax: result = imgproc.MergeChannels(srcImage, colorSpace, image1, image2, image3, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Merged image in specified color space, or Nothing if merging fails.

Example:

Dim merged = imgproc.MergeChannels(bitmap, "RGB", ch1, ch2, ch3)

Description: Returns minimum value among three color components.

Syntax: result = imgproc.Minimum(red, green, blue).

Return Value: Single

Return Description: Minimum value among the three components.

Example:

Dim min = imgproc.Minimum(255.0, 128.0, 200.0)

Description: Applies multi-step thresholding to separate color channels into quantized levels.

Syntax: result = imgproc.MultiStepThresholding(srcImage, redLevels, greenLevels, blueLevels, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Thresholded image, or Nothing if processing fails.

Example:

Dim thresholded = imgproc.MultiStepThresholding(bitmap, 3, 3, 3)

Description: Removes alpha channel transparency from image.

Syntax: result = imgproc.RemoveTransparency(srcImage).

Return Value: Bitmap

Return Description: Image without transparency, or Nothing if removal fails.

Example:

Dim noAlpha = imgproc.RemoveTransparency(bitmap)

Description: Converts RGB byte values to ARGB integer format with full alpha.

Syntax: result = imgproc.RGBToARGBInteger(red, green, blue).

Return Value: Integer

Return Description: ARGB integer value, or 0 if conversion fails.

Example:

Dim argb = imgproc.RGBToARGBInteger(255, 128, 64)

Description: Converts RGB to CMYK color space.

Syntax: imgproc.RGBToCMYK(red, green, blue, computeCyan, computeMagenta, computeYellow).

Return Value: Void

Example:

Call imgproc.RGBToCMYK(255, 128, 64, True, True, True)

Description: Converts RGB byte values to Color object.

Syntax: result = imgproc.RGBToColor(red, green, blue).

Return Value: Color

Return Description: Color object, or Color.Black if conversion fails.

Example:

Dim color = imgproc.RGBToColor(255, 100, 50)

Description: Converts RGB values to hexadecimal color string.

Syntax: result = imgproc.RGBToColorHex(red, green, blue).

Return Value: String

Return Description: Hexadecimal color string, or empty string if conversion fails.

Example:

Dim hexColor = imgproc.RGBToColorHex(255, 0, 0)

Description: Converts RGB to green chromaticity coordinate.

Syntax: imgproc.RGBToGChromaticity(redValue, greenValue, blueValue).

Return Value: Void

Return Description: None.

Example:

Call imgproc.RGBToGChromaticity(255, 128, 0)

Description: Converts RGB to rg chromaticity values (shared version).

Syntax: imgproc.RGBToGChromaticity_Shared(redValue, greenValue, blueValue, outR, outG, outB).

Return Value: Void

Return Description: None.

Example:

Call imgproc.RGBToGChromaticity_Shared(255, 128, 0, outR, outG, outB)

Description: Converts RGB to grayscale byte value using standard formula.

Syntax: result = imgproc.RGBToGray(red, green, blue).

Return Value: Byte

Return Description: Grayscale byte value (0-255), or 0 if conversion fails.

Example:

Dim grayByte = imgproc.RGBToGray(255, 100, 50)

Description: Converts RGB to grayscale using precise luminosity calculation.

Syntax: result = imgproc.RGBToGray_ByRealCalc(red, green, blue).

Return Value: Integer

Return Description: Grayscale value (0-255), or 0 if conversion fails.

Example:

Dim grayValue = imgproc.RGBToGray_ByRealCalc(255, 100, 50)

Description: Converts RGB to HSI color space.

Syntax: imgproc.RGBToHSI(red, green, blue).

Return Value: Void

Example:

Call imgproc.RGBToHSI(255, 128, 64)

Description: Converts RGB to HSI using parallel method.

Syntax: imgproc.RGBToHSI_Parallel(red, green, blue, outHue, outSat, outInt).

Return Value: Void

Example:

Call imgproc.RGBToHSI_Parallel(255, 128, 64, hue, sat, int)

Description: Converts RGB to CIELab color space.

Syntax: imgproc.RGBToLab(red, green, blue).

Return Value: Void

Example:

Call imgproc.RGBToLab(255, 128, 64)

Description: Converts RGB to CIELab with original value output.

Syntax: imgproc.RGBToLab_OriginalValue(red, green, blue, outL, outA, outB).

Return Value: Void

Example:

Call imgproc.RGBToLab_OriginalValue(255, 128, 64, labL, labA, labB)

Description: Converts RGB to CIELab using parallel method.

Syntax: imgproc.RGBToLab_Parallel(red, green, blue, outL, outA, outB).

Return Value: Void

Example:

Call imgproc.RGBToLab_Parallel(255, 128, 64, outL, outA, outB)

Description: Splits a (color opponent) channel in Lab color space.

Syntax: result = imgproc.Split_a(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: a channel image, or Nothing if decomposition fails.

Example:

Dim aChannel = imgproc.Split_a(bitmap)

Description: Splits b (color opponent) channel in Lab color space.

Syntax: result = imgproc.Split_b(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: b channel image, or Nothing if decomposition fails.

Example:

Dim bChannel = imgproc.Split_b(bitmap)

Description: Extracts blue channel from color image as grayscale.

Syntax: result = imgproc.Split_Blue(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Blue channel as grayscale image, or Nothing if extraction fails.

Example:

Dim blueChannel = imgproc.Split_Blue(bitmap)

Description: Splits C (cyan) channel in CMYK decomposition.

Syntax: result = imgproc.Split_Cyan(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: C channel image, or Nothing if decomposition fails.

Example:

Dim cChannel = imgproc.Split_Cyan(bitmap)

Description: Extracts green channel from color image as grayscale.

Syntax: result = imgproc.Split_Green(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Green channel as grayscale image, or Nothing if extraction fails.

Example:

Dim greenChannel = imgproc.Split_Green(bitmap)

Description: Extracts hue channel from HSI color space.

Syntax: result = imgproc.Split_Hue(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Hue channel as image, or Nothing if extraction fails.

Example:

Dim hueChannel = imgproc.Split_Hue(bitmap)

Description: Extracts intensity channel from HSI color space.

Syntax: result = imgproc.Split_Intensity(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Intensity channel as image, or Nothing if extraction fails.

Example:

Dim intensity = imgproc.Split_Intensity(bitmap)

Description: Splits K (black) channel in CMYK decomposition.

Syntax: result = imgproc.Split_KBlack(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: K channel image, or Nothing if decomposition fails.

Example:

Dim kChannel = imgproc.Split_KBlack(bitmap)

Description: Splits L (lightness) channel in Lab color space.

Syntax: result = imgproc.Split_L(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: L channel image, or Nothing if decomposition fails.

Example:

Dim lChannel = imgproc.Split_L(bitmap)

Description: Splits M (magenta) channel in CMYK decomposition.

Syntax: result = imgproc.Split_Magenta(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: M channel image, or Nothing if decomposition fails.

Example:

Dim mChannel = imgproc.Split_Magenta(bitmap)

Description: Extracts red channel from color image as grayscale.

Syntax: result = imgproc.Split_Red(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Red channel as grayscale image, or Nothing if extraction fails.

Example:

Dim redChannel = imgproc.Split_Red(bitmap)

Description: Splits rg chromaticity blue channel.

Syntax: result = imgproc.Split_rgChromaticityBlue(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: rg chromaticity blue channel image, or Nothing if splitting fails.

Example:

Dim rgBlue = imgproc.Split_rgChromaticityBlue(bitmap)

Description: Splits rg chromaticity green channel.

Syntax: result = imgproc.Split_rgChromaticityGreen(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: rg chromaticity green channel image, or Nothing if splitting fails.

Example:

Dim rgGreen = imgproc.Split_rgChromaticityGreen(bitmap)

Description: Splits rg chromaticity red channel.

Syntax: result = imgproc.Split_rgChromaticityRed(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: rg chromaticity red channel image, or Nothing if splitting fails.

Example:

Dim rgRed = imgproc.Split_rgChromaticityRed(bitmap)

Description: Extracts saturation channel from HSI color space.

Syntax: result = imgproc.Split_Saturation(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Saturation channel as image, or Nothing if extraction fails.

Example:

Dim saturation = imgproc.Split_Saturation(bitmap)

Description: Splits Y (yellow) channel in CMYK decomposition.

Syntax: result = imgproc.Split_Yellow(srcImage, [maskImage], [boundary], [allSelected]).

Return Value: Bitmap

Return Description: Y channel image, or Nothing if decomposition fails.

Example:

Dim yChannel = imgproc.Split_Yellow(bitmap)

Description: Checks if two images are identical.

Syntax: result = imgproc.AreImagesIdentical(img1, img2).

Return Value: Boolean

Return Description: True if images are identical, False otherwise.

Example:

Dim identical = imgproc.AreImagesIdentical(bitmap1, bitmap2)

Description: Calculates average color value of specified channel.

Syntax: result = imgproc.Calculate_AverageColorValue(srcImage, totalPixels, interval, channel, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average color value of the specified channel, or 0 if calculation fails.

Example:

Dim avgRed = imgproc.Calculate_AverageColorValue(bitmap, totPix, 1, "R")

Description: Calculates average a (green-red) value in CIELab.

Syntax: result = imgproc.Calculate_AverageColorValue_a(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average a (green-red) value, or 0 if calculation fails.

Example:

Dim avgA = imgproc.Calculate_AverageColorValue_a(bitmap, totPix, 1)

Description: Calculates average b (blue-yellow) value in CIELab.

Syntax: result = imgproc.Calculate_AverageColorValue_b(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average b (blue-yellow) value, or 0 if calculation fails.

Example:

Dim avgB = imgproc.Calculate_AverageColorValue_b(bitmap, totPix, 1)

Description: Calculates average blue channel value.

Syntax: result = imgproc.Calculate_AverageColorValue_Blue(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average blue channel value, or 0 if calculation fails.

Example:

Dim avgBlue = imgproc.Calculate_AverageColorValue_Blue(bitmap, totPix, 1)

Description: Calculates average cyan channel value.

Syntax: result = imgproc.Calculate_AverageColorValue_Cyan(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average cyan value, or 0 if calculation fails.

Example:

Dim avgCyan = imgproc.Calculate_AverageColorValue_Cyan(bitmap, totPix, 1)

Description: Calculates average grayscale value.

Syntax: result = imgproc.Calculate_AverageColorValue_Gray(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average grayscale value, or 0 if calculation fails.

Example:

Dim avgGray = imgproc.Calculate_AverageColorValue_Gray(bitmap, totPix, 1)

Description: Calculates average green channel value.

Syntax: result = imgproc.Calculate_AverageColorValue_Green(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).

Return Value: Single

Return Description: Average green channel value, or 0 if calculation fails.

Example:

Dim avgGreen = imgproc.Calculate_AverageColorValue_Green(bitmap, totPix, 1)

Description: Calculates average hue value.

Syntax: result = imgproc.Calculate_AverageColorValue_Hue(srcImage, totalPixels, interval, [maskImage], [boundary], [allSelected]).