Description: Activates the undo history engine on the active workspace canvas.

Syntax: Call Action.ActivateUndoEngine()

Parameters: None

Return Value: None

VBScript / Visual Basic Example:

Call Action.ActivateUndoEngine()

Description: Deactivates the undo history engine on the active workspace canvas.

Syntax: Call Action.DeactivateUndoEngine()

Parameters: None

Return Value: None

VBScript / Visual Basic Example:

Call Action.DeactivateUndoEngine()

Description: Opens a dialog to save the entire current workspace.

Syntax: Call Action.SaveWorkspaceAs()

Parameters: None

Return Value: None

VBScript / Visual Basic Example:

Call Action.SaveWorkspaceAs()

Description: Opens a dialog to save the currently selected area of the workspace.

Syntax: Call Action.SaveWorkspaceSelectionAs()

Parameters: None

Return Value: None

VBScript / Visual Basic Example:

Call Action.SaveWorkspaceSelectionAs()

Description: Writes a GDI+ bitmap object directly to a specified file path on disk with custom JPEG quality settings.

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

Return Value: String

VBScript / Visual Basic Example:

Dim img, errStr
img = Action.GetImage(0)
errStr = Action.SaveImage(img, "C:\Output\Result.jpg", 95)

Description: Opens a save image dialog with the specified bitmap, extension, and quality.

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

Return Value: None

VBScript / Visual Basic Example:

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

Description: Executes a save image action based on specified folder, prefix, suffix, and formatting options.

Syntax: result = Action.SaveImageAction([outputFolder], [prefix], [suffix], [formatType], [quality])

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.SaveImageAction("C:\Data", "Exp1_", "_Out", 2, 100)

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

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ExpandSelection(10)

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

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ShrinkSelection(10)

Description: Puts the current image to a specified buffer location.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.PutToImageBuffer(2)

Description: Retrieves an image from a specified buffer location.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.GetFromImageBuffer(2)

Description: Copies the current selection to the clipboard.

Syntax: result = Action.Copy()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Copy()

Description: Pastes the contents of the clipboard into the workspace.

Syntax: result = Action.Paste()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Paste()

Description: Clears the active selection.

Syntax: result = Action.Unselect()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Unselect()

Description: Applies a box averaging blur filter.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.BoxAveraging(5)

Description: Applies a Gaussian blur filter.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.GaussianFilter(5)

Description: Flips the image vertically.

Syntax: result = Action.FlipVertically()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.FlipVertically()

Description: Flips the image horizontally.

Syntax: result = Action.FlipHorizontally()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.FlipHorizontally()

Description: Applies a basic 3×3 sharpening filter.

Syntax: result = Action.Sharpen3x3()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Sharpen3x3()

Description: Applies a high-quality 5×5 sharpening filter.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Sharpen5x5HighQuality(20)

Description: Applies an advanced sharpening algorithm.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AdvancedSharpening(150)

Description: Reduces noise in the image while preserving edges.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.SmartDenoise(7, 40)

Description: Applies an embossing effect to the image.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Emboss(45.0F, 2, 150, 128)

Description: Applies a dithering algorithm to reduce color banding.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Dithering(1)

Description: Applies a mosaic/pixelation filter to the image.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.MosaicFilter(0, 15)

Description: Automatically aligns rotation based on detected lines.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Resizes the image using specified dimensions and interpolation.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Resize(0, True, 0, 1024, 768, 4)

Description: Rotates the image by a specific angle.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Crops the image to a defined rectangle.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Crop(200, 200, 50, 50)

Description: Resizes the canvas without scaling the image content.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ResizeCanvas(0, False, 0, 1920, 1080, 4, 0, 0, 0)

Description: Overlays one image on top of another with opacity and feathering controls.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.OverlayImage(1, 0, 255, 255, 255, 50, True, 15)

Description: Applies a chroma key effect to blend two images based on a target color.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ChromaKeyOverlay(1, 0, 255, 0, 0, 100, True, 20)

Description: Splits the image and keeps the specified RGB channel.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.SplitRGB(1)

Description: Removes a specific color channel from the image.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.DeleteChannel(2)

Description: Creates a grayscale image based on a specific color channel.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.GrayFrom(1)

Description: Inverts the colors of the image.

Syntax: result = Action.Invert()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Invert()

Description: Converts the image to standard grayscale.

Syntax: result = Action.GrayScaling()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.GrayScaling()

Description: Converts the image to rg chromaticity space.

Syntax: result = Action.ConvertToRgChrom()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ConvertToRgChrom()

Description: Applies a pseudocolor map to a grayscale image.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.GrayToColor(3, True)

Description: Automatically adjusts the tonal range of the image.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AutoTone(0.1F)

Description: Automatically adjusts the contrast of the image.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AutoContrast(0.2F)

Description: Applies automatic histogram equalization.

Syntax: result = Action.AutoEqualize()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AutoEqualize()

Description: Automatically corrects the gamma curve of the image.

Syntax: result = Action.AutoGamma()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AutoGamma()

Description: Automatically adjusts the white balance to correct color casts.

Syntax: result = Action.AutoWhiteBalance()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AutoWhiteBalance()

Description: Adjusts shadow and highlight details automatically.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AutoShadowsHighlights(60.0F, 20.0F)

Description: Applies local adaptive contrast enhancement.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AdaptiveContrast(30, 4, 4, 2.0F)

Description: Corrects uneven background illumination.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.CorrectUnevenIllumination(16)

Description: Subtracts background using a rolling ball algorithm.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.RollingBallBackgroundSubtraction(100, False, 1)

Description: Adjusts brightness and contrast levels manually or automatically.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.BrightContrast(10, 20, False)

Description: Replaces a specific source color with a target color.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Adjusts colors in the CIE L*a*b* color space.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.CIELab(10, -5, 5)

Description: Adjusts saturation and intensity across multiple color bands.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Adjusts global hue, saturation, and intensity.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.HueSaturationIntensity(15, 20, 10)

Description: Merges separate image sources into a single color space representation.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Fills a specified region with color and opacity.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.FillRegion(1, 255, 0, 0, 50)

Description: Draws a border around the current selection.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.DrawSelectionBorder(255, 255, 0, 2, 100, True)

Description: Hides drawn outlines by blending them with a target color or most frequent color.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Converts all non-black pixels in the image to white.

Syntax: result = Action.ChangeNonBlackToWhite()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ChangeNonBlackToWhite()

Description: Applies morphological erosion.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Erode(5)

Description: Applies morphological dilation.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Dilate(5)

Description: Detects edges using specified standard algorithms.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.EdgeDetection(1)

Description: Detects edges using the Canny edge detection method.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.CannyEdge(150)

Description: Applies morphological skeletonization (thinning).

Syntax: result = Action.Skeletonize()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Skeletonize()

Description: Applies extended morphological skeletonization.

Syntax: result = Action.SkeletonizeExtended()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.SkeletonizeExtended()

Description: Detects boundaries of objects based on overlay modes.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.BoundaryDetection(1)

Description: Removes isolated black dots (noise) below a certain size.

Syntax: result = Action.RemoveBlackDots([maxDotSize])

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.RemoveBlackDots(3)

Description: Removes isolated white dots (noise) below a certain size.

Syntax: result = Action.RemoveWhiteDots([maxDotSize])

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.RemoveWhiteDots(3)

Description: Extracts the outlines of binary objects.

Syntax: result = Action.Outline()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Outline()

Description: Erodes only the outlined regions.

Syntax: result = Action.ErodeOutline()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ErodeOutline()

Description: Dilates only the outlined regions.

Syntax: result = Action.DilateOutline()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.DilateOutline()

Description: Applies binarization using a manually defined threshold.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.ManualThresholding(150)

Description: Applies multi-level thresholding across RGB channels.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Calculates the difference between two images.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.DifferentialImage(1, 2)

Description: Applies watershed segmentation algorithm.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.WatershedSegmentation(15, 5, 2, 0, 255, 0)

Description: Performs logical operations between two binary images.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Applies local adaptive thresholding for binarization.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Colors separated contiguous regions differently.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.RegionColoring(4)

Description: Segments the image into superpixels.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.SuperPixelSegmentation(500, 20.0F, True)

Description: Triggers hardware capture mechanism.

Syntax: result = Action.Capture()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.Capture()

Description: Acquires an image from a connected scanner hardware.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AcquireImagefromScanner(False)

Description: Estimates depth maps using AI.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIDepthEstimation(False)

Description: Unwarps distorted document images using AI.

Syntax: result = Action.AIDocumentUnwarping()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIDocumentUnwarping()

Description: Segments text or structures via AI-based binarization.

Syntax: result = Action.AIBinarizationSegmentation()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIBinarizationSegmentation()

Description: Inpaints missing or masked areas via AI.

Syntax: result = Action.AIInpainting()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIInpainting()

Description: Removes backgrounds in selfie images and replaces with a color.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Sharpens images utilizing an AI model.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageSharpening(3.0F)

Description: Fast AI-based image quality restoration.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageQualityRestorationFast(1.5F)

Description: Standard AI-based image quality restoration (slower).

Syntax: result = Action.AIImageQualityRestorationSlow()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageQualityRestorationSlow()

Description: High-quality, very slow AI-based restoration.

Syntax: result = Action.AIImageQualityRestorationSlowest()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageQualityRestorationSlowest()

Description: Lowest-quality, extremely fast AI-based restoration.

Syntax: result = Action.AIImageQualityRestorationFastest()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageQualityRestorationFastest()

Description: General purpose AI background removal.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Portrait-optimized AI background removal.

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

Return Value: Boolean

VBScript / Visual Basic Example:

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

Description: Selects main subjects intelligently using AI.

Syntax: result = Action.AISmartSelection()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AISmartSelection()

Description: Automatically outlines general subjects.

Syntax: result = Action.AIAutoSubjectSelectionGeneral()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIAutoSubjectSelectionGeneral()

Description: Automatically outlines portrait subjects.

Syntax: result = Action.AIAutoSubjectSelectionPortrait()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIAutoSubjectSelectionPortrait()

Description: Upscales images using Real-ESRGAN.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageUpscaleRealESRGAN(2)

Description: Upscales images rapidly using a faster Real-ESR model.

Syntax: result = Action.AIImageUpscaleRealESRFast()

Parameters: None

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.AIImageUpscaleRealESRFast()

Description: Calculates and returns the average color data from a specific channel.

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

Return Value: String

VBScript / Visual Basic Example:

Dim val = Action.AverageColorValue(1)

Description: Counts pixels matching a specific color threshold.

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

Return Value: String

VBScript / Visual Basic Example:

Dim result = Action.PixelCounter(0, 0, 0, 1)

Description: Performs grid-based cell counting or intensity analysis.

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

Return Value: String

VBScript / Visual Basic Example:

Dim result = Action.MultiCellAnalysis(10, 10, 1, 15, 0, 0, "Black")

Description: Extracts text from the image using OCR (Optical Character Recognition).

Syntax: extractedText = Action.OCRTextExtraction()

Parameters: None

Return Value: String

VBScript / Visual Basic Example:

Dim textData = Action.OCRTextExtraction()

Description: Retrieves an image from the workspace or buffer array to the script engine.

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

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim myImg = Action.GetImage(0)

Description: Sends an image from the script engine to the workspace or buffer array.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim success = Action.SetImage(myImg, 0)

Description: Creates a deep copy duplicate of the source bitmap image.

Syntax: clonedImg = ImgProc.CloneImage(SourceImage)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim copyBmp As Bitmap = ImgProc.CloneImage(srcBmp)

Description: Removes alpha transparency channel from a bitmap, rendering it fully opaque.

Syntax: opaqueImg = ImgProc.RemoveTransparency(SourceImage)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim nonTransBmp As Bitmap = ImgProc.RemoveTransparency(srcBmp)

Description: Creates a blank canvas bitmap of specified dimensions filled with a background color.

Syntax: canvasImg = ImgProc.Generate_Canvas(nWidth, nHeight, BackColor)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim canvas As Bitmap = ImgProc.Generate_Canvas(800, 600, Color.White)

Description: Executes parallel superpixel segmentation (SLIC algorithm) on the source image.

Syntax: segmentedImg = ImgProc.SuperPixelSegmentation(SourceImage, [numSuperpixels], [compactness], [fillWithWhite], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim spImg As Bitmap = ImgProc.SuperPixelSegmentation(srcBmp, 500, 50.0F)

Description: Extracts connected regions using 4-connectivity flood fill algorithm and builds label ID maps.

Syntax: labeledImg = ImgProc.RegionExtract_FloodFill4(SourceImage, LabelIDMap, RegionColorTable, [BkColor], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim idMap(,) As Integer
Dim colorTable(,) As Byte
Dim resBmp = ImgProc.RegionExtract_FloodFill4(srcBmp, idMap, colorTable)

Description: Extracts connected regions using 8-connectivity flood fill algorithm and builds label ID maps.

Syntax: labeledImg = ImgProc.RegionExtract_FloodFill8(SourceImage, LabelIDMap, RegionColorTable, [BkColor], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim idMap(,) As Integer
Dim colorTable(,) As Byte
Dim resBmp = ImgProc.RegionExtract_FloodFill8(srcBmp, idMap, colorTable)

Description: Extracts regions based on color boundaries using 4-connectivity flood fill.

Syntax: labeledImg = ImgProc.RegionExtract_ColorFloodFill4(SourceImage, LabelIDMap, RegionColorTable, [BoundaryColor], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resBmp = ImgProc.RegionExtract_ColorFloodFill4(srcBmp, idMap, colorTable, 16776960)

Description: Extracts regions based on color boundaries using 8-connectivity flood fill.

Syntax: labeledImg = ImgProc.RegionExtract_ColorFloodFill8(SourceImage, LabelIDMap, RegionColorTable, [BoundaryColor], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resBmp = ImgProc.RegionExtract_ColorFloodFill8(srcBmp, idMap, colorTable, 16776960)

Description: Adjusts shadow and highlight exposure levels independently using multi-threaded parallel execution.

Syntax: adjustedImg = ImgProc.ShadowsHighlights(original, shadowAmt, highlightAmt, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.ShadowsHighlights(srcBmp, 30.0F, 10.0F)

Description: Performs multi-band selective color adjustment across 6 primary color bands (RGB, CMY).

Syntax: adjustedImg = ImgProc.MultibandColor(original, rSat, rInt, ySat, yInt, gSat, gInt, cSat, cyanInt, bSat, bInt, mSat, mInt, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.MultibandColor(srcBmp, 10, 0, 0, 0, 20, 5, 0, 0, 0, 0, 0, 0)

Description: Adjusts Lightness (L) and chromaticity channels (a, b) in CIELAB color space.

Syntax: labImg = ImgProc.CIELab(original, lShift, aShift, bShift, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.CIELab(srcBmp, 15, -10, 5)

Description: Shifts Hue, Saturation, and Intensity channels in HSI color space.

Syntax: hsiImg = ImgProc.HueSaturationIntensity(original, hueShift, satShift, intShift, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.HueSaturationIntensity(srcBmp, 30, 20, -10)

Description: Selects and filters specific color ranges across configured color spaces with tolerance parameters.

Syntax: selectedImg = ImgProc.ColorRangeSelection(SourceImage, ColorCode, IsFastAlgorithm, Tolerance, MaintainOrgColor, ColorSpaceName, [IsShowProgressBar], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.ColorRangeSelection(srcBmp, 255, True, 15, True, "RGB")

Description: Converts RGB color image to 24-bit grayscale image using parallel processing.

Syntax: grayImg = ImgProc.GrayScaling(SourceImage, [IsShowProgress], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim grayBmp As Bitmap = ImgProc.GrayScaling(srcBmp)

Description: Applies a fast parallel 3D embossed filter effect with configurable lighting angle, distance, strength, and bias.

Syntax: embossedImg = ImgProc.Emboss(SourceImage, [Angle], [Distance], [Strength], [Bias], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim embBmp As Bitmap = ImgProc.Emboss(srcBmp, 45.0F, 2, 1.5F, 128)

Description: Generates outline boundary contours of image objects in parallel.

Syntax: outlinedImg = ImgProc.Outline(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim outlineBmp As Bitmap = ImgProc.Outline(srcBmp)

Description: Converts all non-black pixels in the image to pure white.

Syntax: bwImg = ImgProc.ChangeNonBlackToWhite(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.ChangeNonBlackToWhite(srcBmp)

Description: Converts System.Drawing.Color structure into a standard HEX color string (e.g. "#FF0000").

Syntax: hexStr = ImgProc.ColorToColorHEX(SourceColor)

Return Value: String

VBScript / Visual Basic Example:

Dim hexVal As String = ImgProc.ColorToColorHEX(Color.Red)

Description: Parses an integer color value into internal RGB components.

Syntax: Call ImgProc.ColorIntegerToRGB(PixelValue)

Return Value: None

VBScript / Visual Basic Example:

Call ImgProc.ColorIntegerToRGB(16711680)

Description: Parses an integer color value into internal ARGB components.

Syntax: Call ImgProc.ColorIntegerToARGB(PixelValue)

Return Value: None

VBScript / Visual Basic Example:

Call ImgProc.ColorIntegerToARGB(-65536)

Description: Combines Red, Green, and Blue component bytes into a single packed ARGB 32-bit integer.

Syntax: argbInt = ImgProc.RGBToARGBInteger(red, green, blue)

Return Value: Integer

VBScript / Visual Basic Example:

Dim colorInt As Integer = ImgProc.RGBToARGBInteger(255, 0, 0)

Description: Constructs a System.Drawing.Color object from individual Red, Green, and Blue integer channel values.

Syntax: clrObj = ImgProc.RGBToColor(RedInByte, GreenInByte, BlueInByte)

Return Value: Color

VBScript / Visual Basic Example:

Dim myColor As Color = ImgProc.RGBToColor(100, 150, 200)

Description: Evaluates whether given RGB byte channels represent a pure black or white pixel.

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

Return Value: Boolean

VBScript / Visual Basic Example:

Dim isMonochrome As Boolean = ImgProc.IsBWPixel(255, 255, 255)

Description: Inspects source bitmap to verify if all pixels have uniform RGB values (grayscale).

Syntax: result = ImgProc.IsGrayImage(SourceImage)

Return Value: Boolean

VBScript / Visual Basic Example:

Dim isGray As Boolean = ImgProc.IsGrayImage(srcBmp)

Description: Inspects source bitmap to determine if it contains strictly binary (0 or 255) pixel values.

Syntax: result = ImgProc.IsBinaryImage(SourceImage)

Return Value: Boolean

VBScript / Visual Basic Example:

Dim isBinary As Boolean = ImgProc.IsBinaryImage(srcBmp)

Description: Applies Floyd-Steinberg error diffusion dithering algorithm to produce a high-quality binary image.

Syntax: ditheredImg = ImgProc.BW_Dithering_FS(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim ditherBmp As Bitmap = ImgProc.BW_Dithering_FS(srcBmp)

Description: Applies matrix-based ordered dithering pattern to generate halftone binary images.

Syntax: ditheredImg = ImgProc.BW_Dithering_OrderedDither(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim ordDitherBmp As Bitmap = ImgProc.BW_Dithering_OrderedDither(srcBmp)

Description: Converts a 2D Byte array representing grayscale intensities into an RGB24 Bitmap image.

Syntax: bmpImg = ImgProc.Convert_GrayByteArray_To_RGBImage(SrcByteArray)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim myBmp As Bitmap = ImgProc.Convert_GrayByteArray_To_RGBImage(grayByteMatrix)

Description: Converts a 2D Integer array representing grayscale intensities into an RGB24 Bitmap image.

Syntax: bmpImg = ImgProc.Convert_GrayByteArray_To_RGBImage_Int(SrcByteArray)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim myBmp As Bitmap = ImgProc.Convert_GrayByteArray_To_RGBImage_Int(grayIntMatrix)

Description: Converts a 3D Byte array [height, width, channel] into a 24-bit RGB Bitmap image.

Syntax: bmpImg = ImgProc.Convert_RGBByteArray_To_RGBImage(SrcByteArray)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim myBmp As Bitmap = ImgProc.Convert_RGBByteArray_To_RGBImage(rgb3DMatrix)

Description: Extracts grayscale bitmap pixel values directly into a 2D Byte array [height, width].

Syntax: grayBytes = ImgProc.Convert_GrayImage_To_GrayByteArray(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Byte(,)

VBScript / Visual Basic Example:

Dim byteMatrix(,) As Byte = ImgProc.[...](asc_slot://start-slot-1)Convert_GrayImage_To_GrayByteArray(srcBmp)

Description: Extracts RGB color bitmap pixel values directly into a 3D Byte array.

Syntax: rgbBytes = ImgProc.Convert_RGBImage_To_RGBByteArray(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Byte(,,)

VBScript / Visual Basic Example:

Dim rgbMatrix(,,) As Byte = ImgProc.Convert_RGBImage_To_RGBByteArray(srcBmp)

Description: Converts RGB image to grayscale and outputs pixel values to a 2D Byte matrix.

Syntax: grayBytes = ImgProc.Convert_RGBImage_To_GrayByteArray(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Byte(,)

VBScript / Visual Basic Example:

Dim grayMatrix(,) As Byte = ImgProc.Convert_RGBImage_To_GrayByteArray(srcBmp)

Description: Converts RGB image to grayscale and outputs pixel values to a 2D Integer matrix.

Syntax: grayInts = ImgProc.Convert_RGBImage_To_GrayIntegerArray(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Integer(,)

VBScript / Visual Basic Example:

Dim intMatrix(,) As Integer = ImgProc.Convert_RGBImage_To_GrayIntegerArray(srcBmp)

Description: Performs grayscale conversion and fills output directly to 2D Byte matrix array.

Syntax: grayBytes = ImgProc.GrayScaling_PutTo_2DByte(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Byte(,)

VBScript / Visual Basic Example:

Dim resMatrix(,) As Byte = ImgProc.GrayScaling_PutTo_2DByte(srcBmp)

Description: Performs grayscale conversion and fills output directly to 2D Integer matrix array.

Syntax: grayInts = ImgProc.GrayScaling_PutTo_2DInt(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Integer(,)

VBScript / Visual Basic Example:

Dim resIntMatrix(,) As Integer = ImgProc.GrayScaling_PutTo_2DInt(srcBmp)

Description: Reconstructs Bitmap image from 2D Integer grayscale matrix data.

Syntax: resBmp = ImgProc.GrayScaling_ReturnImg_From_2DInt(SourceImage, Gray2DInt, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resBmp As Bitmap = ImgProc.GrayScaling_ReturnImg_From_2DInt(srcBmp, grayIntMatrix)

Description: Overlays a 2D Integer grayscale intensity matrix onto an existing image within masked ROI boundaries.

Syntax: overlayBmp = ImgProc.Overlay_GrayIntArray_On_Image(SourceImage, Gray2DInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resBmp = ImgProc.Overlay_GrayIntArray_On_Image(srcBmp, grayMatrix, maskBmp, roiRect, False)

Description: Resizes image relative to current dimensions using zoom scale factor.

Syntax: resizedImg = ImgProc.ResizeByZoomFactor(SourceImage, ZoomFactor, [InterpolationMode])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim zoomedBmp As Bitmap = ImgProc.ResizeByZoomFactor(srcBmp, 2.0F)

Description: Resizes bitmap to target explicit width and height dimensions in pixels.

Syntax: resizedImg = ImgProc.Resize(SourceImage, nWidth, nHeight, [InterpolationMode])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resizedBmp As Bitmap = ImgProc.Resize(srcBmp, 1024, 768)

Description: Crops a sub-region rectangle from source bitmap given origin coordinates and size.

Syntax: croppedImg = ImgProc.Crop(SourceImage, nWidth, nHeight, TargetX, TargetY)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim subBmp As Bitmap = ImgProc.Crop(srcBmp, 200, 200, 50, 50)

Description: Rotates image around a custom pivot center coordinate (CenterX, CenterY) by angle degrees.

Syntax: rotatedImg = ImgProc.Rotate(SourceImage, CenterX, CenterY, AngleDegree, BackgroundColor)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim rotBmp As Bitmap = ImgProc.Rotate(srcBmp, 100, 100, 45.0F, Color.Black)

Description: Rotates image centered on its exact geometric midpoint by angle degrees.

Syntax: rotatedImg = ImgProc.RotateAtCenter(SourceImage, AngleDegree)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim rotBmp As Bitmap = ImgProc.RotateAtCenter(srcBmp, 90.0F)

Description: Flips bitmap vertically along the horizontal axis.

Syntax: flippedImg = ImgProc.Flip_Vertical(SourceImage)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim flippedBmp As Bitmap = ImgProc.Flip_Vertical(srcBmp)

Description: Flips bitmap horizontally along the vertical axis.

Syntax: flippedImg = ImgProc.Flip_Horizontal(SourceImage)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim flippedBmp As Bitmap = ImgProc.Flip_Horizontal(srcBmp)

Description: Performs combined rotation and flip transformation using System.Drawing.RotateFlipType options.

Syntax: transImg = ImgProc.RotateFlip(SourceImage, RotateFlipOption)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resBmp As Bitmap = ImgProc.RotateFlip(srcBmp, RotateFlipType.Rotate90FlipX)

Description: Applies a fast parallel box averaging blur filter using a square neighborhood kernel.

Syntax: blurredImg = ImgProc.BoxAveraging(SourceImage, BoxSizeHalf, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim blurBmp As Bitmap = ImgProc.BoxAveraging(srcBmp, 3)

Description: Applies parallel Gaussian smoothing filter to reduce image noise and detail.

Syntax: smoothImg = ImgProc.GaussianFilter(SourceImage, FilterSize, [WeightFactor], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim gImg As Bitmap = ImgProc.GaussianFilter(srcBmp, 5, 0)

Description: Applies standard 3×3 kernel sharpening filter in parallel.

Syntax: sharpImg = ImgProc.Sharpen_3x3(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.Sharpen_3x3(srcBmp)

Description: Applies improved 3×3 parallel sharpening filter with adjustable strength multiplier.

Syntax: sharpImg = ImgProc.Sharpen_3x3_Improved(SourceImage, [Strength], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.Sharpen_3x3_Improved(srcBmp, 1.5F)

Description: Applies high-quality 5×5 fixed kernel sharpening filter with strength control.

Syntax: sharpImg = ImgProc.Sharpen_5x5_HighQuality_Fixed(SourceImage, [Strength], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.Sharpen_5x5_HighQuality_Fixed(srcBmp, 2.0F)

Description: Applies pixelation or block mosaic effect over the image or selected ROI.

Syntax: mosaicImg = ImgProc.MosaicFilter(SourceImage, isPixelMode, value, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim mosaicBmp As Bitmap = ImgProc.MosaicFilter(srcBmp, True, 10)

Description: Applies morphological erosion filter using square box neighborhood.

Syntax: erodedImg = ImgProc.Erode(SourceImage, BoxSizeHalf, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected], [IsDoGrayScaling])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.Erode(srcBmp, 2)

Description: Applies morphological dilation filter using square box neighborhood.

Syntax: dilatedImg = ImgProc.Dilate(SourceImage, BoxSizeHalf, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected], [IsDoGrayScaling])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.Dilate(srcBmp, 2)

Description: Detects image edges using Sobel operator masks.

Syntax: sobelImg = ImgProc.EdgeDetect_by_Sobel(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim edgeImg As Bitmap = ImgProc.EdgeDetect_by_Sobel(srcBmp)

Description: Detects edges based on regional homogenity differential calculation.

Syntax: edgeImg = ImgProc.EdgeDetect_by_Homogenity(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim edgeImg As Bitmap = ImgProc.EdgeDetect_by_Homogenity(srcBmp)

Description: Erodes region object boundaries in grayscale image by applying background gray adjustments.

Syntax: resImg = ImgProc.ErodeOutlines(SourceGrayImage, BackgroundGray, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.ErodeOutlines(grayBmp, 255)

Description: Dilates region object boundaries in grayscale image by applying foreground gray adjustments.

Syntax: resImg = ImgProc.DilateOutlines(SourceGrayImage, BackgroundGray, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.DilateOutlines(grayBmp, 0)

Description: Extracts Red color channel into a color image with Green/Blue suppressed.

Syntax: redImg = ImgProc.Split_Red(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim redCh = ImgProc.Split_Red(srcBmp)

Description: Extracts Green color channel into a color image with Red/Blue suppressed.

Syntax: greenImg = ImgProc.Split_Green(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim greenCh = ImgProc.Split_Green(srcBmp)

Description: Extracts Blue color channel into a color image with Red/Green suppressed.

Syntax: blueImg = ImgProc.Split_Blue(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim blueCh = ImgProc.Split_Blue(srcBmp)

Description: Extracts Red channel intensity directly into a 24-bit grayscale bitmap.

Syntax: grayRed = ImgProc.GrayFrom_Red(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim redGrayBmp = ImgProc.GrayFrom_Red(srcBmp)

Description: Extracts Green channel intensity directly into a 24-bit grayscale bitmap.

Syntax: grayGreen = ImgProc.GrayFrom_Green(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim greenGrayBmp = ImgProc.GrayFrom_Green(srcBmp)

Description: Extracts Blue channel intensity directly into a 24-bit grayscale bitmap.

Syntax: grayBlue = ImgProc.GrayFrom_Blue(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim blueGrayBmp = ImgProc.GrayFrom_Blue(srcBmp)

Description: Extracts Hue channel component from HSI color space into a grayscale image.

Syntax: hueImg = ImgProc.Split_Hue(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim hueBmp = ImgProc.Split_Hue(srcBmp)

Description: Extracts Saturation channel component from HSI color space into a grayscale image.

Syntax: satImg = ImgProc.Split_Saturation(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim satBmp = ImgProc.Split_Saturation(srcBmp)

Description: Extracts Intensity channel component from HSI color space into a grayscale image.

Syntax: intImg = ImgProc.Split_Intensity(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim intBmp = ImgProc.Split_Intensity(srcBmp)

Description: Converts RGB byte values to CMYK color channel components.

Syntax: Call ImgProc.RGBToCMYK(r, g, b, IsCompute_Cyan, IsCompute_Magenta, IsCompute_Yellow)

Return Value: None

VBScript / Visual Basic Example:

Call ImgProc.RGBToCMYK(200, 100, 50, True, True, True)

Description: Converts RGB byte values to CIELAB space byte components.

Syntax: Call ImgProc.RGBToLab(r, g, b)

Return Value: None

VBScript / Visual Basic Example:

Call ImgProc.RGBToLab(128, 64, 32)

Description: Converts RGB byte values to double-precision CIELAB (L*, a*, b*) values.

Syntax: Call ImgProc.RGBToLab_OriginalValue(r, g, b, LabL, Laba, Labb)

Return Value: None

VBScript / Visual Basic Example:

Dim L As Double, a As Double, b As Double
Call ImgProc.RGBToLab_OriginalValue(255, 0, 0, L, a, b)

Description: Converts RGB byte values to HSI space components.

Syntax: Call ImgProc.RGBToHSI(r, g, b)

Return Value: None

VBScript / Visual Basic Example:

Call ImgProc.RGBToHSI(100, 200, 150)

Description: Converts HSV color components (Hue, Saturation, Value) to RGB byte components.

Syntax: Call ImgProc.HSVtoRGB(h, s, v, r, g, b)

Return Value: None

VBScript / Visual Basic Example:

Dim r As Byte, g As Byte, b As Byte
Call ImgProc.HSVtoRGB(120.0F, 0.5F, 0.8F, r, g, b)

Description: Converts HSI channel inputs to Red, Green, and Blue integer color values.

Syntax: Call ImgProc.HSITORGB(Hue, Saturation255, Intensity255, Red, Green, Blue)

Return Value: None

VBScript / Visual Basic Example:

Dim r As Integer, g As Integer, b As Integer
Call ImgProc.HSITORGB(180, 128.0F, 200.0F, r, g, b)

Description: Fills interior or exterior of ROI mask with color string and opacity.

Syntax: filledImg = ImgProc.FillRegion(SourceImage, FillColorStr, IsFillInside, Opacity, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.FillRegion(srcBmp, "#FF0000", True, 0.5F)

Description: Performs chroma key compositing overlaying image onto target canvas with alpha feathering.

Syntax: keyedImg = ImgProc.ChromaKey(TargetCanvas, OverlayImage, ChromaR, ChromaG, ChromaB, Opacity, IsFeather, FeatherRadius, [MaskImage], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.ChromaKey(bgBmp, fgBmp, 0, 255, 0, 1.0F, True, 3)

Description: Executes 4-connected flood fill starting at target coordinate with RGB color tolerance.

Syntax: filledImg = ImgProc.FloodFill(SourceImage, CenterX, CenterY, FillColorR, FillColorG, FillColorB, ToleranceR, ToleranceG, ToleranceB, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.FloodFill(srcBmp, 100, 100, 255, 0, 0, 10, 10, 10)

Description: Inverts color values (negative effect) across all image channels.

Syntax: invImg = ImgProc.Invert(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim negBmp = ImgProc.Invert(srcBmp)

Description: Converts image to binary mask using explicit cutoff threshold value.

Syntax: binImg = ImgProc.ManualBinarization(SourceImage, ThresholdValue, [SkipGrayScaling], [IsShowProgress], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim binBmp = ImgProc.ManualBinarization(srcBmp, 128)

Description: Executes local adaptive threshold binarization based on local neighborhood box averages.

Syntax: binImg = ImgProc.AdaptiveBinarization(SourceImage, LocalBoxSizeValue, IsObjectWhite, ThresholdLevel, [IsShowProgress], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.AdaptiveBinarization(srcBmp, 15, True, 5)

Description: Applies multi-level thresholding across Red, Green, and Blue color channels independently.

Syntax: threshImg = ImgProc.MultiStepThresholding(SourceImage, LevelCount_Red, LevelCount_Green, LevelCount_Blue, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.MultiStepThresholding(srcBmp, 4, 4, 4)

Description: Renders a solid colored line between two pixel coordinates onto target PictureBox image.

Syntax: resBmp = ImgProc.Draw_Line(Pic_Target, X1, Y1, X2, Y2, LineColor)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.Draw_Line(picBox, 10, 10, 200, 200, Color.Red)

Description: Renders text with inner fill and outer outline stroke onto a Bitmap canvas.

Syntax: textBmp = ImgProc.Draw_Text_Outlined_Bitmap(Pic_Target, x, y, TextString, TextFont, InnerColor, OuterColor)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim fnt As New Font("Arial", 12.0F)
Dim res = ImgProc.Draw_Text_Outlined_Bitmap(srcBmp, 20, 20, "Label", fnt, Color.Yellow, Color.Black)

Description: Draws an array of bounding rectangles onto bitmap using specified stroke color.

Syntax: resBmp = ImgProc.Draw_Rectangles(Pic_Target, SourceRectangles, LineColor)

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim rects() As Rectangle = { New Rectangle(10,10,50,50) }
Dim res = ImgProc.Draw_Rectangles(srcBmp, rects, Color.Green)

Description: Calculates pixel intensity frequency distribution histogram matrix for source image.

Syntax: histData = ImgProc.Get_Histogram(SourceImage, TotalPixelCount, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Single(,)

VBScript / Visual Basic Example:

Dim totCount As Integer
Dim hist(,) As Single = ImgProc.Get_Histogram(srcBmp, totCount)

Description: Extracts intensity or color channel profiles along a defined line segment [StartAt -> EndAt].

Syntax: profileData = ImgProc.Get_LineProfile(SourceImage, StartAt, EndAt, LineThickness, [IsNormalizeBy255])

Return Value: Single(,)

VBScript / Visual Basic Example:

Dim profile(,) As Single = ImgProc.Get_LineProfile(srcBmp, New Point(0,0), New Point(100,100), 3)

Description: Calculates average value for a specific named color channel across selected ROI.

Syntax: avgVal = ImgProc.Calculate_AverageColorValue(SourceImage, TotalPixelsCount, AnalysisInterval, ColorChannel, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Single

VBScript / Visual Basic Example:

Dim pxCount As Long
Dim avgRed As Single = ImgProc.Calculate_AverageColorValue(srcBmp, pxCount, 1, "Red")

Description: Calculates Euclidean distance between two 2D points (X1, Y1) and (X2, Y2).

Syntax: distVal = ImgProc.Distance(X1, Y1, X2, Y2)

Return Value: Double

VBScript / Visual Basic Example:

Dim d As Double = ImgProc.Distance(0.0, 0.0, 3.0, 4.0)

Description: Counts total pixels matching specified RGB color integer value within ROI.

Syntax: matchCount = ImgProc.Count_ColorPixelOfInterest(SourceImage, ColorOfInterest_RGBInt, TotalPixelCount, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Integer

VBScript / Visual Basic Example:

Dim totPx As Integer
Dim redCount As Integer = ImgProc.Count_ColorPixelOfInterest(srcBmp, 16711680, totPx)

Description: Subtractions non-uniform background illumination using parallel rolling box/ball algorithm.

Syntax: bgSubImg = ImgProc.RollingBoxBackgroundSubtraction(SourceImage, Radius, [IsAutomatic], [IsObjectWhite], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim resBmp = ImgProc.RollingBoxBackgroundSubtraction(srcBmp, 50, False, True)

Description: Corrects uneven field shading and vignetting by estimating background surface grid in parallel.

Syntax: corrImg = ImgProc.CorrectUnevenIllumination(SourceImage, [GridRows], [GridCols], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim flatImg = ImgProc.CorrectUnevenIllumination(srcBmp, 16, 16)

Description: Applies edge-preserving bilateral smart noise reduction filter.

Syntax: denoisedImg = ImgProc.SmartDenoise(SourceImage, [Radius], [Threshold], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim cleanImg = ImgProc.SmartDenoise(srcBmp, 5, 25)

Description: Applies Contrast Limited Adaptive Histogram Equalization (CLAHE) in parallel.

Syntax: claheImg = ImgProc.AdaptiveContrast(SourceImage, [Strength], [TilesX], [TilesY], [ClipLimit], [IsShowProgress], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim claheBmp = ImgProc.AdaptiveContrast(srcBmp, 0.8F, 8, 8, 2.0F)

Description: Automatically balances tonal range across individual color channels by clipping histogram tails.

Syntax: autoToneImg = ImgProc.AutoTone(SourceImage, [ClipPercent], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.AutoTone(srcBmp, 0.5F)

Description: Automatically corrects color temperature and casts using gray world assumption.

Syntax: awbImg = ImgProc.AutoWhiteBalance(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim awbBmp = ImgProc.AutoWhiteBalance(srcBmp)

Description: Automatically computes and applies optimal gamma correction curves.

Syntax: gammaImg = ImgProc.AutoGamma(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim gammaBmp = ImgProc.AutoGamma(srcBmp)

Description: Applies high-grade Unsharp Masking (USM) filter with threshold control.

Syntax: usmImg = ImgProc.Sharpen_UnsharpMask(SourceImage, [FilterSize], [AmountPercent], [Threshold], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim usmBmp = ImgProc.Sharpen_UnsharpMask(srcBmp, 11, 150, 5)

Description: Removes image background using matte alpha keying and optional new background substitution.

Syntax: nobgImg = ImgProc.RemoveBackground(SourceImage, MatteImage, [MaskRegionBoundary], [IsMaskAllRegionSelected], [BgColor], [NewBackgroundImage])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim cutBmp = ImgProc.RemoveBackground(srcBmp, matteBmp)

Description: Executes distance-transform parallel Watershed segmentation to separate overlapping object boundaries.

Syntax: watershedImg = ImgProc.WatershedSegmentation(SourceImage, [MinDistanceThreshold], [SmoothRadius], [BoundaryThickness], [BoundR], [BoundG], [BoundB], [ReturnOnlyBoundaries], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim wsBmp = ImgProc.WatershedSegmentation(srcBmp, 15, 3, 2, 255, 0, 0)

Description: Splits clustered binary objects by locating contour convexity defects.

Syntax: splitImg = ImgProc.SplitObjects_ConvexityDefects(SourceImage, [MinDefectDepth], [MaxCutLength], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim splitBmp = ImgProc.SplitObjects_ConvexityDefects(srcBmp, 5.0F, 40.0F)

Description: Reduces binary object shapes to 1-pixel thin medial axis skeleton curves in parallel.

Syntax: skelImg = ImgProc.Skeletonize(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim skelBmp = ImgProc.Skeletonize(srcBmp)

Description: Applies extended topological skeletonization preserving critical branch junction topology.

Syntax: skelImg = ImgProc.SkeletonizeExtended(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim extSkel = ImgProc.SkeletonizeExtended(srcBmp)

Description: Extracts 2D coordinate points of all foreground skeleton pixels from matrix array.

Syntax: points = ImgProc.Extract_SkeletonPoints(SkeletonArray, foreground)

Return Value: Point()

VBScript / Visual Basic Example:

Dim pts() As Point = ImgProc.Extract_SkeletonPoints(skelMatrix, 255)

Description: Calculates physical curve length of skeleton branches converted from physical pixel scale (um/pixel).

Syntax: lengthVal = ImgProc.Get_TrueSkeletonLength(SkeletonArray, foreground, umPerPixels, SplineVertexCount)

Return Value: Single

VBScript / Visual Basic Example:

Dim realLen As Single = ImgProc.Get_TrueSkeletonLength(skelMatrix, 255, 0.45F, 100)

Description: Exports image 2D depth map to a 3D printable STL mesh file utilizing Gaussian surface smoothing.

Syntax: filePathOut = ImgProc.SaveDepthMapToSTL_GaussianFilter(SourceImage, FilePath, [MaxSTLHeight], [BaseThickness], [SmoothingPasses], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: String

VBScript / Visual Basic Example:

Dim outPath = ImgProc.SaveDepthMapToSTL_GaussianFilter(srcBmp, "C:\model.stl", 20.0F, 3.0F)

Description: Merges three independent single-channel grayscale bitmaps into a single 24-bit composite image across RGB, HSI, or LAB spaces.

Syntax: mergedBmp = ImgProc.MergeChannels(ColorSpace, Image1, Image2, Image3, [maskImage], [maskRegionBoundary], [isMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim rgbBmp = ImgProc.MergeChannels("RGB", rChBmp, gChBmp, bChBmp)

Description: Converts RGB image to normalized rg-Chromaticity space image [r = R/(R+G+B), g = G/(R+G+B)].

Syntax: rgBmp = ImgProc.Convert_To_rgChromaticity(SourceImage, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim chromBmp = ImgProc.Convert_To_rgChromaticity(srcBmp)

Description: Performs bitwise boolean AND operation between two grayscale bitmaps.

Syntax: resBmp = ImgProc.BinaryOperation_AND(SourceGrayImage1, SourceGrayImage2, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.BinaryOperation_AND(img1, img2)

Description: Performs bitwise boolean OR operation between two grayscale bitmaps.

Syntax: resBmp = ImgProc.BinaryOperation_OR(SourceGrayImage1, SourceGrayImage2, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.BinaryOperation_OR(img1, img2)

Description: Performs bitwise boolean XOR operation between two grayscale bitmaps.

Syntax: resBmp = ImgProc.BinaryOperation_XOR(SourceGrayImage1, SourceGrayImage2, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim res = ImgProc.BinaryOperation_XOR(img1, img2)

Description: Calculates absolute pixel-wise difference image (|Image1 – Image2|).

Syntax: diffBmp = ImgProc.Compute_DifferentialImage(SourceGrayImage1, SourceGrayImage2, [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example:

Dim diff = ImgProc.Compute_DifferentialImage(img1, img2)

Description: Removes isolated black noise dots (speckles) up to specified maximum dot size in parallel.

Syntax: cleanBmp = ImgProc.RemoveBlackDots(SourceImage, [MaxDotSize], [MaskImage], [MaskRegionBoundary], [IsMaskAllRegionSelected])

Return Value: Bitmap

VBScript / Visual Basic Example: