Description: Activates the undo engine for workspace operations

Syntax: await Action.ActivateUndoEngine();

Return Value: None

Example:

Action.ActivateUndoEngine();

Description: Deactivates the undo engine to disable undo tracking

Syntax: await Action.DeactivateUndoEngine();

Return Value: None

Example:

Action.DeactivateUndoEngine();

Description: Saves the current workspace with a new name

Syntax: await Action.SaveWorkspaceAs();

Return Value: None

Example:

Action.SaveWorkspaceAs();

Description: Saves the current workspace selection as a new file

Syntax: await Action.SaveWorkspaceSelectionAs();

Return Value: None

Example:

Action.SaveWorkspaceSelectionAs();

Description: Saves a bitmap image to the specified file path

Syntax: const result = await Action.SaveImage(sourceBitmap, destFileName, jpegQuality);

Return Value: String

Example:

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

Description: Opens a dialog to save an image with specified options

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

Return Value: None

Example:

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

Description: Saves image with action parameters including prefix, suffix, and format

Syntax: const result = await Action.SaveImageAction(outputFolder, prefix, suffix, formatType, quality);

Return Value: Boolean

Example:

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

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

Syntax: const result = await Action.PasteAndFitToRectangle();

Return Value: Boolean

Example:

let result;
result = Action.PasteAndFitToRectangle();

Description: Expands the current selection by specified number of pixels

Syntax: const result = await Action.ExpandSelection(expandByPixels);

Return Value: Boolean

Example:

let success ;= Action.ExpandSelection(10);

Description: Shrinks the current selection by specified number of pixels

Syntax: const result = await Action.ShrinkSelection(shrinkByPixels);

Return Value: Boolean

Example:

let success ;= Action.ShrinkSelection(10);

Description: Stores the current image to a buffer location

Syntax: const result = await Action.PutToImageBuffer(targetLocation);

Return Value: Boolean

Example:

let success ;= Action.PutToImageBuffer(2);

Description: Retrieves an image from a buffer location

Syntax: const result = await Action.GetFromImageBuffer(sourceLocation);

Return Value: Boolean

Example:

let success ;= Action.GetFromImageBuffer(2);

Description: Copies the current image to clipboard

Syntax: const result = await Action.Copy();

Return Value: Boolean

Example:

let success ;= Action.Copy();

Description: Pastes an image from clipboard

Syntax: const result = await Action.Paste();

Return Value: Boolean

Example:

let success ;= Action.Paste();

Description: Clears the current selection

Syntax: const result = await Action.Unselect();

Return Value: Boolean

Example:

let success ;= Action.Unselect();

Description: Applies box averaging filter to smooth the image

Syntax: const result = await Action.BoxAveraging(kernelSize);

Return Value: Boolean

Example:

let success ;= Action.BoxAveraging(5);

Description: Applies Gaussian blur filter to the image

Syntax: const result = await Action.GaussianFilter(kernelSize);

Return Value: Boolean

Example:

let success ;= Action.GaussianFilter(5);

Description: Flips the image vertically

Syntax: const result = await Action.FlipVertically();

Return Value: Boolean

Example:

let success ;= Action.FlipVertically();

Description: Flips the image horizontally

Syntax: const result = await Action.FlipHorizontally();

Return Value: Boolean

Example:

let success ;= Action.FlipHorizontally();

Description: Applies 3×3 sharpening filter to enhance edges

Syntax: const result = await Action.Sharpen3x3();

Return Value: Boolean

Example:

let success ;= Action.Sharpen3x3();

Description: Applies high-quality 5×5 sharpening filter with adjustable strength

Syntax: const result = await Action.Sharpen5x5HighQuality(sharpenStrengthPercentage);

Return Value: Boolean

Example:

let success ;= Action.Sharpen5x5HighQuality(20);

Description: Applies advanced sharpening with customizable amount

Syntax: const result = await Action.AdvancedSharpening(sharpenAmountPercentage);

Return Value: Boolean

Example:

let success ;= Action.AdvancedSharpening(150);

Description: Reduces noise while preserving edges with smart denoising

Syntax: const result = await Action.SmartDenoise(radius, threshold);

Return Value: Boolean

Example:

let success ;= Action.SmartDenoise(7, 40);

Description: Creates an embossed effect on the image

Syntax: const result = await Action.Emboss(angle, distance, strength, bias);

Return Value: Boolean

Example:

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

Description: Applies dithering algorithm to reduce color depth

Syntax: const result = await Action.Dithering(ditheringAlgorithmType);

Return Value: Boolean

Example:

let success ;= Action.Dithering(1);

Description: Applies mosaic or pixelation filter for privacy or artistic effect

Syntax: const result = await Action.MosaicFilter(mosaicModeType, value);

Return Value: Boolean

Example:

let success ;= Action.MosaicFilter(0, 15);

Description: Rotates image to align with specified line

Syntax: const result = await Action.RotationalAlignmentByLine(backgroundColorRed, backgroundColorGreen, backgroundColorBlue);

Return Value: Boolean

Example:

let success ;= Action.RotationalAlignmentByLine(0, 0, 0);

Description: Resizes image to specified dimensions with interpolation

Syntax: const result = await Action.Resize(resizeUnitType, maintainAspectRatio, baseDimensionType, targetWidth, targetHeight, interpolationAlgorithmType);

Return Value: Boolean

Example:

let success ;= Action.Resize(0, true, 0, 1024, 768, 4);

Description: Rotates image by specified angle with background color fill

Syntax: const result = await Action.Rotate(rotationAngleDegrees, rotationDirectionType, backgroundColorRed, backgroundColorGreen, backgroundColorBlue);

Return Value: Boolean

Example:

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

Description: Crops image to specified rectangular area

Syntax: const result = await Action.Crop(cropWidthPixels, cropHeightPixels, startXCoordinate, startYCoordinate);

Return Value: Boolean

Example:

let success ;= Action.Crop(200, 200, 50, 50);

Description: Resizes canvas around image with alignment and background color options

Syntax: const result = await Action.ResizeCanvas(resizeUnitType, maintainAspectRatio, baseDimensionType, targetWidth, targetHeight, canvasAlignmentType, backgroundColorRed, backgroundColorGreen, backgroundColorBlue);

Return Value: Boolean

Example:

let success ;= Action.ResizeCanvas(0, false, 0, 1920, 1080, 4, 0, 0, 0);

Description: Overlays image with chroma key (color-based) transparency replacement

Syntax: const result = await Action.ChromaKeyOverlay(sourceLocation1, targetColorRed, targetColorGreen, targetColorBlue, sourceLocation2, opacity, enableFeathering, featheringRadius);

Return Value: Boolean

Example:

let success ;= Action.ChromaKeyOverlay(1, 0, 255, 0, 0, 100, true, 20);

Description: Adds text annotation or watermark to image with styling options: fontStyleInt: 0 = Regular, 1 = Bold, 2 = Italic, 3 = Bold+Italic, 4 = Underline, 8 = Strikeout

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

Return Value: Boolean

Example:

// VBScript Example
let success;
// Draw bold text rotated by 45 degrees with a thick outline
success = Action.TextAnnotation("Sample Label", 150, 150, "Arial", 24.0, 1, -256, -16777216, 100, 2.5, 45.0, true);

Description: Overlays one image on another with blend modes and feathering

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

Return Value: Boolean

Example:

let success ;= Action.OverlayImage(1, 0, 255, 255, 255, 50, true, 15, 30, true);

Description: Splits image into separate RGB channels

Syntax: const result = await Action.SplitRGB(rgbSplitChannelType);

Return Value: Boolean

Example:

let success ;= Action.SplitRGB(1);

Description: Removes a specific color channel from the image

Syntax: const result = await Action.DeleteChannel(channelToDeleteType);

Return Value: Boolean

Example:

let success ;= Action.DeleteChannel(2);

Description: Converts a specific channel to grayscale

Syntax: const result = await Action.GrayFrom(sourceChannelType);

Return Value: Boolean

Example:

let success ;= Action.GrayFrom(1);

Description: Inverts all colors in the image (negative)

Syntax: const result = await Action.Invert();

Return Value: Boolean

Example:

let success ;= Action.Invert();

Description: Converts image to grayscale

Syntax: const result = await Action.GrayScaling();

Return Value: Boolean

Example:

let success ;= Action.GrayScaling();

Description: Converts image to RG chromaticity coordinates

Syntax: const result = await Action.ConvertToRgChrom();

Return Value: Boolean

Example:

let success ;= Action.ConvertToRgChrom();

Description: Converts grayscale image to color using specified color map

Syntax: const result = await Action.GrayToColor(mapType, isReversed);

Return Value: Boolean

Example:

let success ;= Action.GrayToColor(3, true);

Description: Automatically adjusts tonal range for better contrast

Syntax: const result = await Action.AutoTone(clipPercentage);

Return Value: Boolean

Example:

let success ;= Action.AutoTone(0.1F);

Description: Automatically adjusts contrast to optimal levels

Syntax: const result = await Action.AutoContrast(clipPercentage);

Return Value: Boolean

Example:

let success ;= Action.AutoContrast(0.2F);

Description: Equalizes histogram to distribute tones across full range

Syntax: const result = await Action.AutoEqualize();

Return Value: Boolean

Example:

let success ;= Action.AutoEqualize();

Description: Automatically adjusts gamma for optimal brightness curve

Syntax: const result = await Action.AutoGamma();

Return Value: Boolean

Example:

let success ;= Action.AutoGamma();

Description: Automatically performs white balance to neutralize color casts

Syntax: const result = await Action.AutoWhiteBalance();

Return Value: Boolean

Example:

let success ;= Action.AutoWhiteBalance();

Description: Automatically corrects shadow and highlight areas with adjustable strength

Syntax: const result = await Action.AutoShadowsHighlights(shadowCorrectionStrengthPercentage, highlightCorrectionStrengthPercentage);

Return Value: Boolean

Example:

let success ;= Action.AutoShadowsHighlights(60.0F, 20.0F);

Description: Applies adaptive contrast enhancement with CLAHE algorithm

Syntax: const result = await Action.AdaptiveContrast(contrastStrengthPercentage, gridTilesX, gridTilesY, contrastClipLimit);

Return Value: Boolean

Example:

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

Description: Corrects uneven illumination across image using rolling ball algorithm

Syntax: const result = await Action.CorrectUnevenIllumination(illuminationGridSize);

Return Value: Boolean

Example:

let success ;= Action.CorrectUnevenIllumination(16);

Description: Removes background using rolling ball background subtraction

Syntax: const result = await Action.RollingBallBackgroundSubtraction(rollingBallBoxSize, isObjectColorAutomatic, manualObjectColorType);

Return Value: Boolean

Example:

let success ;= Action.RollingBallBackgroundSubtraction(100, false, 1);

Description: Adjusts brightness and contrast levels

Syntax: const result = await Action.BrightContrast(brightnessLevel, contrastLevel, autoBrightness);

Return Value: Boolean

Example:

let success ;= Action.BrightContrast(10, 20, false);

Description: Replaces one color with another in the image

Syntax: const result = await Action.ChangeColor(sourceColorRed, sourceColorGreen, sourceColorBlue, targetColorRed, targetColorGreen, targetColorBlue);

Return Value: Boolean

Example:

let success ;= Action.ChangeColor(255, 0, 0, 0, 255, 0);

Description: Adjusts color in CIE Lab color space for perceptually uniform color adjustments

Syntax: const result = await Action.CIELab(lightnessShift, aAxisShift, bAxisShift);

Return Value: Boolean

Example:

let success ;= Action.CIELab(10, -5, 5);

Description: Adjusts saturation and intensity for specific color bands

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

Return Value: Boolean

Example:

let success ;= Action.MultibandColor(10, 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0);

Description: Adjusts hue, saturation, and intensity channels independently

Syntax: const result = await Action.HueSaturationIntensity(hue, saturation, intensity);

Return Value: Boolean

Example:

let success ;= Action.HueSaturationIntensity(15, 20, 10);

Description: Merges multiple images as channels in specified color space

Syntax: const result = await Action.MergeChannels(colorSpaceType, image1Source, image2Source, image3Source);

Return Value: Boolean

Example:

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

Description: Fills a region (selection or ROI) with specified color

Syntax: const result = await Action.FillRegion(fillRegionType, fillColorRed, fillColorGreen, fillColorBlue, fillOpacityPercentage);

Return Value: Boolean

Example:

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

Description: Draws outline border around selected region with specified color and thickness

Syntax: const result = await Action.DrawSelectionBorder(borderColorRed, borderColorGreen, borderColorBlue, borderThicknessPixels, borderOpacityPercentage, applyToMultipleROIs);

Return Value: Boolean

Example:

let success ;= Action.DrawSelectionBorder(255, 255, 0, 2, 100, true);

Description: Hides outlines by replacing them with specified color or most frequent color

Syntax: const result = await Action.HideOutlines(targetColorRed, targetColorGreen, targetColorBlue, useMostFrequentColor);

Return Value: Boolean

Example:

let success ;= Action.HideOutlines(0, 0, 0, false);

Description: Converts all non-black pixels to white

Syntax: const result = await Action.ChangeNonBlackToWhite();

Return Value: Boolean

Example:

let success ;= Action.ChangeNonBlackToWhite();

Description: Applies morphological erosion to thin objects

Syntax: const result = await Action.Erode(morphologyKernelSize);

Return Value: Boolean

Example:

let success ;= Action.Erode(5);

Description: Applies morphological dilation to thicken objects

Syntax: const result = await Action.Dilate(morphologyKernelSize);

Return Value: Boolean

Example:

let success ;= Action.Dilate(5);

Description: Detects edges using specified algorithm

Syntax: const result = await Action.EdgeDetection(edgeDetectionAlgorithmType);

Return Value: Boolean

Example:

let success ;= Action.EdgeDetection(1);

Description: Applies Canny edge detection algorithm

Syntax: const result = await Action.CannyEdge(cannyHighThreshold);

Return Value: Boolean

Example:

let success ;= Action.CannyEdge(150);

Description: Converts object outlines to skeleton (1-pixel centerline)

Syntax: const result = await Action.Skeletonize();

Return Value: Boolean

Example:

let success ;= Action.Skeletonize();

Description: Applies extended skeletonization for more detailed centerlines

Syntax: const result = await Action.SkeletonizeExtended();

Return Value: Boolean

Example:

let success ;= Action.SkeletonizeExtended();

Description: Detects object boundaries with overlay option

Syntax: const result = await Action.BoundaryDetection(boundaryOverlayModeType);

Return Value: Boolean

Example:

let success ;= Action.BoundaryDetection(1);

Description: Removes small black dots and noise

Syntax: const result = await Action.RemoveBlackDots(maxDotSize);

Return Value: Boolean

Example:

let success ;= Action.RemoveBlackDots(3);

Description: Removes small white dots and noise

Syntax: const result = await Action.RemoveWhiteDots(maxDotSize);

Return Value: Boolean

Example:

let success ;= Action.RemoveWhiteDots(3);

Description: Traces outlines of objects in binary image

Syntax: const result = await Action.Outline();

Return Value: Boolean

Example:

let success ;= Action.Outline();

Description: Erodes the outline to make it thinner

Syntax: const result = await Action.ErodeOutline();

Return Value: Boolean

Example:

let success ;= Action.ErodeOutline();

Description: Dilates the outline to make it thicker

Syntax: const result = await Action.DilateOutline();

Return Value: Boolean

Example:

let success ;= Action.DilateOutline();

Description: Converts image to binary using manual threshold value

Syntax: const result = await Action.ManualThresholding(binarizationThresholdValue);

Return Value: Boolean

Example:

let success ;= Action.ManualThresholding(150);

Description: Applies multi-level thresholding to separate multiple intensity ranges

Syntax: const result = await Action.MultiStepThresholding(redChannelLevels, greenChannelLevels, blueChannelLevels);

Return Value: Boolean

Example:

let success ;= Action.MultiStepThresholding(3, 3, 3);

Description: Computes difference between two images

Syntax: const result = await Action.DifferentialImage(firstImageSourceLocation, secondImageSourceLocation);

Return Value: Boolean

Example:

let success ;= Action.DifferentialImage(1, 2);

Description: Segments image using watershed algorithm for object separation

Syntax: const result = await Action.WatershedSegmentation(minDistanceThreshold, smoothingRadius, boundaryThickness, boundaryColorRed, boundaryColorGreen, boundaryColorBlue);

Return Value: Boolean

Example:

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

Description: Performs binary logical operations between two images

Syntax: const result = await Action.BinaryOperation(logicalOperationType, firstImageSourceLocation, secondImageSourceLocation);

Return Value: Boolean

Example:

let success ;= Action.BinaryOperation(1, 0, 2);

Description: Applies adaptive thresholding for varying illumination conditions

Syntax: const result = await Action.AdaptiveThresholding(adaptiveBoxSize, adaptiveThresholdLevel, isObjectColorAutomatic, manualObjectColorType);

Return Value: Boolean

Example:

let success ;= Action.AdaptiveThresholding(100, 90, false, 1);

Description: Colors connected regions with different colors for identification

Syntax: const result = await Action.RegionColoring(connectivity);

Return Value: Boolean

Example:

let success ;= Action.RegionColoring(4);

Description: Segments image into superpixels for efficient processing

Syntax: const result = await Action.SuperPixelSegmentation(numSuperpixels, compactness, fillWithWhite);

Return Value: Boolean

Example:

let success ;= Action.SuperPixelSegmentation(500, 20.0F, true);

Description: Overlays a stamp image on current image with transformations

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

Return Value: Boolean

Example:

let outputImg ;= Action.ImageStamp(srcImg, stampImg, 100.0F, 100.0F, 250.0F, 250.0F, 45.0F, 80, true, -1, false, 10, true, 30);

Description: Applies Fast Fourier Transform for frequency domain analysis

Syntax: const result = await Action.FFT();

Return Value: Boolean

Example:

let success ;= Action.FFT();

Description: Applies Inverse Fast Fourier Transform to reconstruct spatial image from frequency domain

Syntax: const result = await Action.InverseFFT();

Return Value: Boolean

Example:

let success ;= Action.InverseFFT();

Description: Captures image from connected camera or scanner

Syntax: const result = await Action.Capture();

Return Value: Boolean

Example:

let success ;= Action.Capture();

Description: Acquires image from scanner with optional silent mode

Syntax: const result = await Action.AcquireImagefromScanner(useSilentMode);

Return Value: Boolean

Example:

let success ;= Action.AcquireImagefromScanner(false);

Description: Estimates depth map using AI deep learning model

Syntax: const result = await Action.AIDepthEstimation(autoResizeLargeImages);

Return Value: Boolean

Example:

let success ;= Action.AIDepthEstimation(false);

Description: Straightens and unwraps perspective-distorted document images

Syntax: const result = await Action.AIDocumentUnwarping();

Return Value: Boolean

Example:

let success ;= Action.AIDocumentUnwarping();

Description: Segments document image and binarizes using AI model

Syntax: const result = await Action.AIBinarizationSegmentation();

Return Value: Boolean

Example:

let success ;= Action.AIBinarizationSegmentation();

Description: Removes unwanted objects from image using AI inpainting

Syntax: const result = await Action.AIInpainting();

Return Value: Boolean

Example:

let success ;= Action.AIInpainting();

Description: Removes background from selfie with optional virtual background

Syntax: const result = await Action.AIBackgroundRemovalSelfie(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue);

Return Value: Boolean

Example:

let success ;= Action.AIBackgroundRemovalSelfie(0, 255, 0);

Description: Sharpens image using AI-powered enhancement

Syntax: const result = await Action.AIImageSharpening(sharpenBoostFactor);

Return Value: Boolean

Example:

let success ;= Action.AIImageSharpening(3.0F);

Description: Restores low-quality image using fast AI model

Syntax: const result = await Action.AIImageQualityRestorationFast(restorationBoostFactor);

Return Value: Boolean

Example:

let success ;= Action.AIImageQualityRestorationFast(1.5F);

Description: Restores low-quality image using slow but more accurate AI model

Syntax: const result = await Action.AIImageQualityRestorationSlow();

Return Value: Boolean

Example:

let success ;= Action.AIImageQualityRestorationSlow();

Description: Restores low-quality image using slowest but highest quality AI model

Syntax: const result = await Action.AIImageQualityRestorationSlowest();

Return Value: Boolean

Example:

let success ;= Action.AIImageQualityRestorationSlowest();

Description: Restores low-quality image using fastest AI model for quick preview

Syntax: const result = await Action.AIImageQualityRestorationFastest();

Return Value: Boolean

Example:

let success ;= Action.AIImageQualityRestorationFastest();

Description: Removes background from general images with optional virtual background

Syntax: const result = await Action.AIBackgroundRemovalGeneral(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue);

Return Value: Boolean

Example:

let success ;= Action.AIBackgroundRemovalGeneral(0, 0, 0);

Description: Removes background from portrait images with optional virtual background

Syntax: const result = await Action.AIBackgroundRemovalPortrait(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue);

Return Value: Boolean

Example:

let success ;= Action.AIBackgroundRemovalPortrait(0, 0, 0);

Description: Creates intelligent selection based on visual content

Syntax: const result = await Action.AISmartSelection();

Return Value: Boolean

Example:

let success ;= Action.AISmartSelection();

Description: Automatically selects subject in general images using AI

Syntax: const result = await Action.AIAutoSubjectSelectionGeneral();

Return Value: Boolean

Example:

let success ;= Action.AIAutoSubjectSelectionGeneral();

Description: Automatically selects subject in portrait images using AI

Syntax: const result = await Action.AIAutoSubjectSelectionPortrait();

Return Value: Boolean

Example:

let success ;= Action.AIAutoSubjectSelectionPortrait();

Description: Upscales image using RealESRGAN deep learning model

Syntax: const result = await Action.AIImageUpscaleRealESRGAN(upscaleMagnificationType);

Return Value: Boolean

Example:

let success ;= Action.AIImageUpscaleRealESRGAN(2);

Description: Upscales image using fast RealESRGAN variant for quick results

Syntax: const result = await Action.AIImageUpscaleRealESRFast();

Return Value: Boolean

Example:

let success ;= Action.AIImageUpscaleRealESRFast();

Description: Extracts and returns average color value for specified channel

Syntax: const result = await Action.AverageColorValue(analysisTargetChannelType);

Return Value: String

Example:

let val ;= Action.AverageColorValue(1);

Description: Counts pixels of specified color and returns results

Syntax: const result = await Action.PixelCounter(targetColorRed, targetColorGreen, targetColorBlue, resultOutputFormatType);

Return Value: String

Example:

let result ;= Action.PixelCounter(0, 0, 0, 1);

Description: Analyzes multiple cells in grid layout and extracts statistical data

Syntax: const result = await Action.MultiCellAnalysis(gridColumnsX, gridRowsY, cellShapeType, cellDiameterPixels, analysisModeType, analysisTargetChannelType, targetColorPresetName);

Return Value: String

Example:

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

Description: Extracts text from image using Optical Character Recognition

Syntax: const result = await Action.OCRTextExtraction();

Return Value: String

Example:

let textData ;= Action.OCRTextExtraction();

Description: Retrieves image from specified buffer location

Syntax: const result = await Action.GetImage(sourceLocation);

Return Value: Bitmap

Example:

let myImg ;= Action.GetImage(0);

Description: Sets image to specified buffer location

Syntax: const result = await Action.SetImage(newImage, targetLocation);

Return Value: Boolean

Example:

let success ;= Action.SetImage(myImg, 0);

Description: Creates a deep copy of the image

Syntax: const result = await ImgProc.CloneImage(SourceImage);

Return Value: Bitmap

Example:

let copyBmp As Bitmap ;= ImgProc.CloneImage(srcBmp);

Description: Removes alpha channel transparency from image

Syntax: const result = await ImgProc.RemoveTransparency(SourceImage);

Return Value: Bitmap

Example:

let nonTransBmp As Bitmap ;= ImgProc.RemoveTransparency(srcBmp);

Description: Creates blank canvas with specified dimensions and background color

Syntax: const result = await ImgProc.Generate_Canvas(nWidth, nHeight, BackColor);

Return Value: Bitmap

Example:

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

Description: Extracts basic region analysis statistics from label and color maps

Syntax: await ImgProc.RegionExtract_BasicAnalysis(Src_IDMap(,), Src_ColorTable(,));

Return Value: None

Example:

await ImgProc.RegionExtract_BasicAnalysis(Src_IDMap(,), Src_ColorTable(,));

Description: Extracts regions using raster scanning without mask

Syntax: const result = await ImgProc.RegionExtract_RasterScanning_NoMaskImage(SourceImage, LabelIDMap, RegionColorTable, BkColor);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_RasterScanning_NoMaskImage(SourceImage, LabelIDMap, RegionColorTable, BkColor);

Description: Extracts regions using raster scanning with optional mask support

Syntax: const result = await ImgProc.RegionExtract_RasterScanning(SourceImage, LabelIDMap, RegionColorTable, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_RasterScanning(SourceImage, LabelIDMap, RegionColorTable, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Converts label ID map values to corresponding image colors

Syntax: const result = await ImgProc.RegionExtract_Update_LabelIDMap_To_Image(SourceImage, LabelIDMap, RegionColorTable, IsOverlap, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_Update_LabelIDMap_To_Image(SourceImage, LabelIDMap, RegionColorTable, IsOverlap, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Extracts and converts specified regions from label map to byte array

Syntax: await ImgProc.RegionExtract_Crop_LabelIDMap_To_2DByte(LabelIDMap, IDInfoIndex, X1, X2, Y1, Y2);

Return Value: None

Example:

await ImgProc.RegionExtract_Crop_LabelIDMap_To_2DByte(LabelIDMap, IDInfoIndex, X1, X2, Y1, Y2);

Description: Updates label ID map to include only specified region IDs

Syntax: await ImgProc.RegionExtract_Update_LabelIDMap_ByIncluding(LabelIDMap, IDArray);

Return Value: None

Example:

await ImgProc.RegionExtract_Update_LabelIDMap_ByIncluding(LabelIDMap, IDArray);

Description: Converts label ID map to colored image representation

Syntax: const result = await ImgProc.RegionExtract_Convert_LabelIDMap_To_Image(LabelIDMap, ObjectRed, ObjectGreen, ObjectBlue);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_Convert_LabelIDMap_To_Image(LabelIDMap, ObjectRed, ObjectGreen, ObjectBlue);

Description: Creates image with region outlines overlaid on original

Syntax: const result = await ImgProc.RegionExtract_Create_OutlinedOriginalImage(SourceImage, LabelIDMap, ObjectRed, ObjectGreen, ObjectBlue);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_Create_OutlinedOriginalImage(SourceImage, LabelIDMap, ObjectRed, ObjectGreen, ObjectBlue);

Description: Creates white outlined image from label map with dilation

Syntax: const result = await ImgProc.RegionExtract_Create_WhiteObjectOutlineImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2, DilateBoxSize);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_Create_WhiteObjectOutlineImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2, DilateBoxSize);

Description: Crops white object region from label ID map

Syntax: const result = await ImgProc.RegionExtract_Crop_WhiteObjectImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_Crop_WhiteObjectImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2);

Description: Creates green outlined image from label map with dilation

Syntax: const result = await ImgProc.RegionExtract_Create_GreenObjectOutlineImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2, DilateBoxSize);

Return Value: Bitmap

Example:

let result;
result = ImgProc.RegionExtract_Create_GreenObjectOutlineImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2, DilateBoxSize);

Description: Compares two bitmaps for pixel-by-pixel equality

Syntax: const result = await ImgProc.CompareBitmapImages(b1, b2);

Return Value: Boolean

Example:

let result;
result = ImgProc.CompareBitmapImages(b1, b2);

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

Syntax: const result = await ImgProc.Convert_Gray24Bit_To_8bppIndexed(srcBitmap);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Convert_Gray24Bit_To_8bppIndexed(srcBitmap);

Description: Resizes canvas and centers/stretches image

Syntax: const result = await ImgProc.Resize_Canvas(SourceImage, nWidth, nHeight, StretchDirection, BackColor);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Resize_Canvas(SourceImage, nWidth, nHeight, StretchDirection, BackColor);

Description: Adds margins to image edges

Syntax: const result = await ImgProc.AddMargin(SourceImage, LeftMargin, RightMargin, TopMargin, BottomMargin);

Return Value: Bitmap

Example:

let result;
result = ImgProc.AddMargin(SourceImage, LeftMargin, RightMargin, TopMargin, BottomMargin);

Description: Converts RGB to grayscale using precise calculation

Syntax: const result = await ImgProc.RGBToGray_ByRealCalc(r, g, b);

Return Value: Integer

Example:

let result;
result = ImgProc.RGBToGray_ByRealCalc(r, g, b);

Description: Converts RGB to grayscale byte value

Syntax: const result = await ImgProc.RGBToGray(r, g, b);

Return Value: Byte

Example:

let result;
result = ImgProc.RGBToGray(r, g, b);

Description: Applies color map to grayscale image

Syntax: const result = await ImgProc.GrayToColor(SourceImage, MapType, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.GrayToColor(SourceImage, MapType, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Draws selection border with RGB values

Syntax: const result = await ImgProc.DrawSelectionBorder(SourceImage, cR, cG, cB, BorderThickness, Opacity);

Return Value: Bitmap

Example:

let result;
result = ImgProc.DrawSelectionBorder(SourceImage, cR, cG, cB, BorderThickness, Opacity);

Description: Converts hexadecimal color string to RGB values

Syntax: await ImgProc.HexToRGB(HexColorStr, R, G, B);

Return Value: None

Example:

await ImgProc.HexToRGB(HexColorStr, R, G, B);

Description: Box averaging using iterative addition method

Syntax: const result = await ImgProc.BoxAveraging_ByEveryAddition(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.BoxAveraging_ByEveryAddition(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Box averaging using integral image for fast processing

Syntax: const result = await ImgProc.BoxAveraging_ByIntegralMap(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.BoxAveraging_ByIntegralMap(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Applies custom convolution filter mask

Syntax: const result = await ImgProc.StandardFilter(SourceImage, FilterMask(,), WeightFactor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.StandardFilter(SourceImage, FilterMask(,), WeightFactor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Detects edges using explicit comparison method

Syntax: const result = await ImgProc.EdgeDetect_by_ExplicitComp(SourceImage, IsOverlay, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.EdgeDetect_by_ExplicitComp(SourceImage, IsOverlay, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Gets pixel locations matching specified grayscale value

Syntax: await ImgProc.Get_PixelLocationArray_Bk(SourceGrayImage, DestPixelGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: None

Example:

await ImgProc.Get_PixelLocationArray_Bk(SourceGrayImage, DestPixelGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Gets all white pixel locations in grayscale image

Syntax: await ImgProc.Get_PixelLocationArray(SourceGrayImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: None

Example:

await ImgProc.Get_PixelLocationArray(SourceGrayImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Detects edges using left-hand rule method

Syntax: const result = await ImgProc.EdgeDetect_by_LeftHand(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.EdgeDetect_by_LeftHand(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Detects edges using upper-left hand kernel

Syntax: const result = await ImgProc.EdgeDetect_by_UpperLeftHand(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.EdgeDetect_by_UpperLeftHand(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Stops the current image processing operation

Syntax: await ImgProc.Stop_Processing();

Return Value: None

Example:

await ImgProc.Stop_Processing();

Description: Returns maximum value among three color components

Syntax: const result = await ImgProc.Maximum(rR, rG, rB);

Return Value: Single

Example:

let result;
result = ImgProc.Maximum(rR, rG, rB);

Description: Returns minimum value among three color components

Syntax: const result = await ImgProc.Minimum(rR, rG, rB);

Return Value: Single

Example:

let result;
result = ImgProc.Minimum(rR, rG, rB);

Description: Converts RGB to CIELab using parallel method

Syntax: await ImgProc.RGBToLab_Parallel(r, g, b, Out_L, Out_a, Out_b);

Return Value: None

Example:

await ImgProc.RGBToLab_Parallel(r, g, b, Out_L, Out_a, Out_b);

Description: Converts RGB to HSI using parallel method

Syntax: await ImgProc.RGBToHSI_Parallel(r, g, b, Hue, Saturation, Intensity);

Return Value: None

Example:

await ImgProc.RGBToHSI_Parallel(r, g, b, Hue, Saturation, Intensity);

Description: Quantizes color channel value to discrete levels

Syntax: const result = await ImgProc.Digitalize(ColorChannelValue, LevelCount);

Return Value: Byte

Example:

let result;
result = ImgProc.Digitalize(ColorChannelValue, LevelCount);

Description: Draws color level distribution box in picture control

Syntax: await ImgProc.Draw_ColorLevelBox(ColorMode, Pic_Target, LevelCount);

Return Value: None

Example:

await ImgProc.Draw_ColorLevelBox(ColorMode, Pic_Target, LevelCount);

Description: Generates blank image in picture control

Syntax: await ImgProc.Generate_BlankImage(Pic_Target, BackColor);

Return Value: None

Example:

await ImgProc.Generate_BlankImage(Pic_Target, BackColor);

Description: Creates blank image with specified background color

Syntax: const result = await ImgProc.Create_BlankImage(SourceImage, BackColor);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Create_BlankImage(SourceImage, BackColor);

Description: Draws line profile within picture control

Syntax: const result = await ImgProc.Draw_LineProfile(ProfileData, Pic_Target, ProfileColor, IsCenterLined);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Draw_LineProfile(ProfileData, Pic_Target, ProfileColor, IsCenterLined);

Description: Draws histogram within picture control

Syntax: const result = await ImgProc.Draw_Histogram(ProfileData, TotPixelCount, Pic_Target, ProfileColor);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Draw_Histogram(ProfileData, TotPixelCount, Pic_Target, ProfileColor);

Description: Decomposes color to ARGB and HSI components

Syntax: await ImgProc.ColorIntegerToRGBGHSI(ColorValue, RedValue, GreenValue, BlueValue, GrayValue, HueValue, SaturationValue, IntensityValue);

Return Value: None

Example:

await ImgProc.ColorIntegerToRGBGHSI(ColorValue, RedValue, GreenValue, BlueValue, GrayValue, HueValue, SaturationValue, IntensityValue);

Description: Gets pixel color from screen at specified coordinates

Syntax: const result = await ImgProc.Get_PixelColor_From1PixelInScreen(TargetX, TargetY);

Return Value: Integer

Example:

let result;
result = ImgProc.Get_PixelColor_From1PixelInScreen(TargetX, TargetY);

Description: Gets pixel color from bitmap at specified coordinates

Syntax: const result = await ImgProc.Get_PixelColor(SourceBitmap, TargetX, TargetY);

Return Value: Integer

Example:

let result;
result = ImgProc.Get_PixelColor(SourceBitmap, TargetX, TargetY);

Description: Gets pixel color from screen

Syntax: const result = await ImgProc.Get_PixelColor_FromScreen(TargetX, TargetY);

Return Value: Integer

Example:

let result;
result = ImgProc.Get_PixelColor_FromScreen(TargetX, TargetY);

Description: Detects motion between two images

Syntax: const result = await ImgProc.Get_MotionDetectHits(SourceImage1, SourceImage2, StepSize, Tolerance);

Return Value: Single

Example:

let result;
result = ImgProc.Get_MotionDetectHits(SourceImage1, SourceImage2, StepSize, Tolerance);

Description: Draws text with outline in picture control

Syntax: const result = await ImgProc.Draw_Text_Outlined(Pic_Target, x, y, TextString, TextFont, InnerColor, OuterColor);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Draw_Text_Outlined(Pic_Target, x, y, TextString, TextFont, InnerColor, OuterColor);

Description: Draws outlined text on image

Syntax: const result = await ImgProc.Draw_Text_Outlined_Image(SourceImage, x, y, TextString, TextFont, InnerColor, OuterColor);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Draw_Text_Outlined_Image(SourceImage, x, y, TextString, TextFont, InnerColor, OuterColor);

Description: Draws outlined text on graphics object

Syntax: await ImgProc.Draw_Text_Outlined_Graphics(SourceGraphics, x, y, TextString, TextFont, InnerColor, OuterColor);

Return Value: None

Example:

await ImgProc.Draw_Text_Outlined_Graphics(SourceGraphics, x, y, TextString, TextFont, InnerColor, OuterColor);

Description: Returns minimum value among five values

Syntax: const result = await ImgProc.Get_MinValue(Value1, Value2, Value3, Value4, Value5);

Return Value: Single

Example:

let result;
result = ImgProc.Get_MinValue(Value1, Value2, Value3, Value4, Value5);

Description: Returns maximum value among five values

Syntax: const result = await ImgProc.Get_MaxValue(Value1, Value2, Value3, Value4, Value5);

Return Value: Single

Example:

let result;
result = ImgProc.Get_MaxValue(Value1, Value2, Value3, Value4, Value5);

Description: Counts and classifies all color pixels

Syntax: const result = await ImgProc.Quantify_ColorPixel(SourceImage, Return_ColorTable(,), TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Integer

Example:

let result;
result = ImgProc.Quantify_ColorPixel(SourceImage, Return_ColorTable(,), TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Counts grayscale pixels of specific value

Syntax: const result = await ImgProc.Count_NumberOfGrayPixel_OfInterest(SourceGrayImage, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Integer

Example:

let result;
result = ImgProc.Count_NumberOfGrayPixel_OfInterest(SourceGrayImage, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average grayscale value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Gray(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Gray(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average red channel value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Red(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Red(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average green channel value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Green(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Green(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average blue channel value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Blue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Blue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average hue value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Hue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Hue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average saturation value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Saturation(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Saturation(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average intensity value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Intensity(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Intensity(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average cyan channel value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Cyan(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Cyan(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average magenta channel value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Magenta(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Magenta(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average yellow channel value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_Yellow(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_Yellow(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average black (K) channel value in CMYK

Syntax: const result = await ImgProc.Calculate_AverageColorValue_KBlack(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_KBlack(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average L (lightness) value in CIELab

Syntax: const result = await ImgProc.Calculate_AverageColorValue_L(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_L(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

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

Syntax: const result = await ImgProc.Calculate_AverageColorValue_a(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_a(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

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

Syntax: const result = await ImgProc.Calculate_AverageColorValue_b(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_b(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average red chromaticity value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_rgChromaticityRed(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_rgChromaticityRed(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average green chromaticity value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_rgChromaticityGreen(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_rgChromaticityGreen(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average blue chromaticity value

Syntax: const result = await ImgProc.Calculate_AverageColorValue_rgChromaticityBlue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AverageColorValue_rgChromaticityBlue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates average using predefined color formula

Syntax: const result = await ImgProc.Calculate_AvgValueByPredefinedColorFormula(SourceImage, TotalPixelsCount, AnalysisInterval, FormulaMethod, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single

Example:

let result;
result = ImgProc.Calculate_AvgValueByPredefinedColorFormula(SourceImage, TotalPixelsCount, AnalysisInterval, FormulaMethod, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Calculates multiple color channel averages simultaneously

Syntax: await ImgProc.Calculate_AverageColorValue_MultipleChannels(SourceImage, ShapeMode, X1, Y1, X2, Y2, ReturnRed, ReturnGreen, ReturnBlue, ReturnGray, ReturnHue, ReturnSat, ReturnIntensity, ReturnCyan, ReturnMagenta, ReturnYellow, ReturnK, ReturnLab_L, ReturnLab_a, ReturnLab_b, ReturnRG_Red, ReturnRG_Green, ReturnRG_Blue);

Return Value: None

Example:

await ImgProc.Calculate_AverageColorValue_MultipleChannels(SourceImage, ShapeMode, X1, Y1, X2, Y2, ReturnRed, ReturnGreen, ReturnBlue, ReturnGray, ReturnHue, ReturnSat, ReturnIntensity, ReturnCyan, ReturnMagenta, ReturnYellow, ReturnK, ReturnLab_L, ReturnLab_a, ReturnLab_b, ReturnRG_Red, ReturnRG_Green, ReturnRG_Blue);

Description: Gets individual pixel color values in multiple color spaces

Syntax: await ImgProc.Get_PixelColorValues(SourceImage, X1, Y1, ReturnRed, ReturnGreen, ReturnBlue, ReturnGray, ReturnHue, ReturnSat, ReturnIntensity, ReturnCyan, ReturnMagenta, ReturnYellow, ReturnK, ReturnLab_L, ReturnLab_a, ReturnLab_b, ReturnRG_Red, ReturnRG_Green, ReturnRG_Blue);

Return Value: None

Example:

await ImgProc.Get_PixelColorValues(SourceImage, X1, Y1, ReturnRed, ReturnGreen, ReturnBlue, ReturnGray, ReturnHue, ReturnSat, ReturnIntensity, ReturnCyan, ReturnMagenta, ReturnYellow, ReturnK, ReturnLab_L, ReturnLab_a, ReturnLab_b, ReturnRG_Red, ReturnRG_Green, ReturnRG_Blue);

Description: Calculates total pixel count in selected region

Syntax: const result = await ImgProc.Calculate_TotalPixels(SourceImage, SelectShape, X1, Y1, X2, Y2, ColorBW);

Return Value: Long

Example:

let result;
result = ImgProc.Calculate_TotalPixels(SourceImage, SelectShape, X1, Y1, X2, Y2, ColorBW);

Description: Converts hexadecimal color string to integer

Syntax: const result = await ImgProc.ColorHexToColorInteger(ColorHex);

Return Value: Integer

Example:

let result;
result = ImgProc.ColorHexToColorInteger(ColorHex);

Description: Converts hexadecimal color string to RGB components

Syntax: await ImgProc.ColorHexToRGB(HexColorStr, R, G, B);

Return Value: None

Example:

await ImgProc.ColorHexToRGB(HexColorStr, R, G, B);

Description: Converts RGB values to hexadecimal color string

Syntax: const result = await ImgProc.RGBToColorHex(RedValue, GreenValue, BlueValue);

Return Value: String

Example:

let result;
result = ImgProc.RGBToColorHex(RedValue, GreenValue, BlueValue);

Description: Adjusts brightness and contrast of image

Syntax: const result = await ImgProc.BrightContrast(SourceImage, BrightLevel, ContrastLevel, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.BrightContrast(SourceImage, BrightLevel, ContrastLevel, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Loads image from file path

Syntax: const result = await ImgProc.Image_FromFile(FileName);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Image_FromFile(FileName);

Description: Calculates local grayscale average from integral map

Syntax: const result = await ImgProc.Calculate_LocalGrayAvgValue(IntegralGrayImageMap(,), LocalBoxSize, CenterX, CenterY);

Return Value: Byte

Example:

let result;
result = ImgProc.Calculate_LocalGrayAvgValue(IntegralGrayImageMap(,), LocalBoxSize, CenterX, CenterY);

Description: Gets 2D color RGB map from image

Syntax: const result = await ImgProc.Get_ColorRGB2DMap(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Object

Example:

let result;
result = ImgProc.Get_ColorRGB2DMap(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Checks if shape is closed (no gaps)

Syntax: const result = await ImgProc.Check_If_CloseShape(Src_BitMap(,), FalseTolerance);

Return Value: Boolean

Example:

let result;
result = ImgProc.Check_If_CloseShape(Src_BitMap(,), FalseTolerance);

Description: Finds optimal threshold for black-white leveling using flood fill

Syntax: const result = await ImgProc.Find_OptimalThreshold_For_BWLeveling_Using_FloodFillWithTolerance(SourceGrayImage, Return_BWGrayImage);

Return Value: Integer

Example:

let result;
result = ImgProc.Find_OptimalThreshold_For_BWLeveling_Using_FloodFillWithTolerance(SourceGrayImage, Return_BWGrayImage);

Description: Applies black-white leveling with optional auto thresholding

Syntax: const result = await ImgProc.BWLeveling_Using_FloodFillWithTolerance(SourceGrayImage, IsConductBlurring, IsFindThresholdValue, DefaultThresholdValue, Return_OptimalThresholdValue);

Return Value: Bitmap

Example:

let result;
result = ImgProc.BWLeveling_Using_FloodFillWithTolerance(SourceGrayImage, IsConductBlurring, IsFindThresholdValue, DefaultThresholdValue, Return_OptimalThresholdValue);

Description: Applies black-white leveling excluding specified gray range

Syntax: const result = await ImgProc.BWLeveling_Using_FloodFillWithTolerance_Core(SourceGrayImage, ExcludeGrayRange_Min, ExcludeGrayRange_Max);

Return Value: Bitmap

Example:

let result;
result = ImgProc.BWLeveling_Using_FloodFillWithTolerance_Core(SourceGrayImage, ExcludeGrayRange_Min, ExcludeGrayRange_Max);

Description: Removes red channel from image

Syntax: const result = await ImgProc.Delete_RedChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Delete_RedChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Removes green channel from image

Syntax: const result = await ImgProc.Delete_GreenChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Delete_GreenChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Removes blue channel from image

Syntax: const result = await ImgProc.Delete_BlueChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Delete_BlueChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Captures desktop screen to bitmap (legacy method)

Syntax: await ImgProc.CaptureDesktopScreen_Old(ReturnedImage, PrintCursor);

Return Value: None

Example:

await ImgProc.CaptureDesktopScreen_Old(ReturnedImage, PrintCursor);

Description: Gets current cursor position on screen

Syntax: await ImgProc.Get_CursorPosition(x, y);

Return Value: None

Example:

await ImgProc.Get_CursorPosition(x, y);

Description: Creates deep copy of image region

Syntax: const result = await ImgProc.DeepCopy(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.DeepCopy(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Gets actual rectangle bounds of form

Syntax: const result = await ImgProc.Get_ActualFormRect(SrcForm);

Return Value: Rectangle

Example:

let result;
result = ImgProc.Get_ActualFormRect(SrcForm);

Description: Gets bitmap snapshot of UI control

Syntax: const result = await ImgProc.GetControlBitmap(CTL);

Return Value: Bitmap

Example:

let result;
result = ImgProc.GetControlBitmap(CTL);

Description: Changes specified color to new color throughout image

Syntax: const result = await ImgProc.Change_Color(SourceImage, ColorOfInterest_RGBInt, ChangeToR, ChangeToG, ChangeToB, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Change_Color(SourceImage, ColorOfInterest_RGBInt, ChangeToR, ChangeToG, ChangeToB, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Changes specified RGB color to new RGB color

Syntax: const result = await ImgProc.Change_Color_ByRGB(SourceImage, ColorOfInterestR, ColorOfInterestG, ColorOfInterestB, ChangeToR, ChangeToG, ChangeToB, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Change_Color_ByRGB(SourceImage, ColorOfInterestR, ColorOfInterestG, ColorOfInterestB, ChangeToR, ChangeToG, ChangeToB, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Removes/hides outlines of specified color from image

Syntax: const result = await ImgProc.Hide_Outlines(SourceImage, TargetColor_R, TargetColor_G, TargetColor_B, IsMostFrequentColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Hide_Outlines(SourceImage, TargetColor_R, TargetColor_G, TargetColor_B, IsMostFrequentColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Gets average color from 3×3 box excluding target color

Syntax: const result = await ImgProc.Get_Avgerage_Color_3x3Box_ExceptOneColor(TargetX, TargetY, TargetColor_R, TargetColor_G, TargetColor_B, ColorChannelNum);

Return Value: Byte

Example:

let result;
result = ImgProc.Get_Avgerage_Color_3x3Box_ExceptOneColor(TargetX, TargetY, TargetColor_R, TargetColor_G, TargetColor_B, ColorChannelNum);

Description: Overlays 3D byte mask to image with transparency

Syntax: const result = await ImgProc.Overlay_Mask3DByte_To_Image(SourceImage, SourceMaskImage3DByte, TransparentColor, Opacity, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Overlay_Mask3DByte_To_Image(SourceImage, SourceMaskImage3DByte, TransparentColor, Opacity, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Overlays mask bitmap to image with transparency

Syntax: const result = await ImgProc.Overlay_MaskImage_To_Image(SourceImage, SourceMaskImage, TransparentColor, Opacity);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Overlay_MaskImage_To_Image(SourceImage, SourceMaskImage, TransparentColor, Opacity);

Description: Gets image format object from file extension

Syntax: const result = await ImgProc.Get_ImageFormat(FileExtension);

Return Value: Object

Example:

let result;
result = ImgProc.Get_ImageFormat(FileExtension);

Description: Converts ARGB values to integer

Syntax: const result = await ImgProc.ARGBToARGBInteger(_AlphaValue, _RedValue, _GreenValue, _BlueValue);

Return Value: Integer

Example:

let result;
result = ImgProc.ARGBToARGBInteger(_AlphaValue, _RedValue, _GreenValue, _BlueValue);

Description: Converts ARGB bytes to Color object

Syntax: const result = await ImgProc.ARGBToColor(AlphaInByte, RedInByte, GreenInByte, BlueInByte);

Return Value: Color

Example:

let result;
result = ImgProc.ARGBToColor(AlphaInByte, RedInByte, GreenInByte, BlueInByte);

Description: Splits K (black) channel in CMYK decomposition

Syntax: const result = await ImgProc.Split_KBlack(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_KBlack(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Splits C (cyan) channel in CMYK decomposition

Syntax: const result = await ImgProc.Split_Cyan(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_Cyan(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Splits M (magenta) channel in CMYK decomposition

Syntax: const result = await ImgProc.Split_Magenta(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_Magenta(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Splits Y (yellow) channel in CMYK decomposition

Syntax: const result = await ImgProc.Split_Yellow(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_Yellow(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Converts RGB to rg chromaticity with parallel processing

Syntax: const result = await ImgProc.Convert_To_rgChromaticity_Parallel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Convert_To_rgChromaticity_Parallel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Converts RGB to green chromaticity coordinate

Syntax: await ImgProc.RGBToGChromaticity(_RedValue, _GreenValue, _BlueValue);

Return Value: None

Example:

await ImgProc.RGBToGChromaticity(_RedValue, _GreenValue, _BlueValue);

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

Syntax: await ImgProc.RGBToGChromaticity_Shared(RedValue, GreenValue, BlueValue, RGChromaticity_Red, RGChromaticity_Green, RGChromaticity_Blue);

Return Value: None

Example:

await ImgProc.RGBToGChromaticity_Shared(RedValue, GreenValue, BlueValue, RGChromaticity_Red, RGChromaticity_Green, RGChromaticity_Blue);

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

Syntax: const result = await ImgProc.Split_L(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_L(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

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

Syntax: const result = await ImgProc.Split_a(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_a(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

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

Syntax: const result = await ImgProc.Split_b(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Split_b(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Extracts grayscale values from image line

Syntax: await ImgProc.Get_GrayValues(SourceImage, x1, y1, x2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: None

Example:

await ImgProc.Get_GrayValues(SourceImage, x1, y1, x2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Quick check if image is same as stored reference

Syntax: const result = await ImgProc.IsSameImage_QuickCheck(IsTheFirstImage, SourceImage, x1, y1, x2);

Return Value: Boolean

Example:

let result;
result = ImgProc.IsSameImage_QuickCheck(IsTheFirstImage, SourceImage, x1, y1, x2);

Description: Checks if image is same as stored reference

Syntax: const result = await ImgProc.IsSameImage(IsTheFirstImage, SourceImage);

Return Value: Boolean

Example:

let result;
result = ImgProc.IsSameImage(IsTheFirstImage, SourceImage);

Description: Checks if two images are identical

Syntax: const result = await ImgProc.AreImagesIdentical(img1, img2);

Return Value: Boolean

Example:

let result;
result = ImgProc.AreImagesIdentical(img1, img2);

Description: Validates image dimensions against constraints

Syntax: const result = await ImgProc.Check_ImageSize(SourceImage, MinWidth, MinHeight, MaxWidth, MaxHeight);

Return Value: String

Example:

let result;
result = ImgProc.Check_ImageSize(SourceImage, MinWidth, MinHeight, MaxWidth, MaxHeight);

Description: Extracts pixel coordinates of specified gray color

Syntax: await ImgProc.Extract_PixelLocations(SourceGrayImage, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: None

Example:

await ImgProc.Extract_PixelLocations(SourceGrayImage, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Extracts pixel coordinates from byte array

Syntax: await ImgProc.Extract_PixelLocations_FromByte(SrcByteArray, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: None

Example:

await ImgProc.Extract_PixelLocations_FromByte(SrcByteArray, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Description: Gets window height margin value

Syntax: const result = await ImgProc.Get_WindowHeightMargin(TargetForm);

Return Value: Integer

Example:

let result;
result = ImgProc.Get_WindowHeightMargin(TargetForm);

Description: Gets window width margin value

Syntax: const result = await ImgProc.Get_WindowWidthMargin(TargetForm);

Return Value: Integer

Example:

let result;
result = ImgProc.Get_WindowWidthMargin(TargetForm);

Description: Creates mask for single rectangle region

Syntax: const result = await ImgProc.Create_MaskRectangle(CanvasWidth, CanvasHeighT, MaskRect);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Create_MaskRectangle(CanvasWidth, CanvasHeighT, MaskRect);

Description: Creates mask for multiple rectangle regions

Syntax: const result = await ImgProc.Create_MaskRectangles(CanvasWidth, CanvasHeighT, MaskRects());

Return Value: Bitmap

Example:

let result;
result = ImgProc.Create_MaskRectangles(CanvasWidth, CanvasHeighT, MaskRects());

Description: Creates mask for single ellipse region

Syntax: const result = await ImgProc.Create_MaskEllipse(CanvasWidth, CanvasHeighT, MaskRect);

Return Value: Bitmap

Example:

let result;
result = ImgProc.Create_MaskEllipse(CanvasWidth, CanvasHeighT, MaskRect);

Description: Creates mask for multiple ellipse regions

Syntax: const result = await ImgProc.Create_MaskEllipses(CanvasWidth, CanvasHeighT, MaskRects());

Return Value: Bitmap

Example: