Description: Enhances local contrast using CLAHE.

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

Return Value: Boolean

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

Example:

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

Description: Automatically adjusts image contrast.

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

Return Value: Boolean

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

Example:

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

Description: Equalizes the image histogram across the tonal range.

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

Return Value: Boolean

Return Description: True if equalization succeeded; otherwise False.

Example:

let success ;= Action.AutoEqualize();

Description: Automatically adjusts image gamma.

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

Return Value: Boolean

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

Example:

let success ;= Action.AutoGamma();

Description: Corrects shadow and highlight regions.

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

Return Value: Boolean

Return Description: True if correction succeeded; otherwise False.

Example:

let success ;= Action.AutoShadowsHighlights(50.0F, 10.0F);

Description: Automatically adjusts the image tonal range.

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

Return Value: Boolean

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

Example:

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

Description: Automatically corrects white balance and color casts.

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

Return Value: Boolean

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

Example:

let success ;= Action.AutoWhiteBalance();

Description: Adjusts image brightness and contrast.

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

Return Value: Boolean

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

Example:

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

Description: Replaces one RGB color with another.

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

Return Value: Boolean

Return Description: True if replacement succeeded; otherwise False.

Example:

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

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.ColorDeconvolution(0, true);

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

Syntax: const result = await Action.ColorRangeSelection(targetColorRed, targetColorGreen, targetColorBlue, colorSpaceType, algorithmType, tolerance, keepOriginalColor);

Return Value: Boolean

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

Example:

let success ;= Action.ColorRangeSelection(0, 255, 0, 3, 1, 40, true);

Description: Converts the image to RG chromaticity coordinates.

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

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

let success ;= Action.ConvertToRgChrom();

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

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

Return Value: Boolean

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

Example:

let success ;= Action.CorrectUnevenIllumination(8);

Description: Removes the specified color channel from the image.

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

Return Value: Boolean

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

Example:

let success ;= Action.DeleteChannel(0);

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

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

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

let success ;= Action.GrayFrom(0);

Description: Converts the image to grayscale.

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

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

let success ;= Action.GrayScaling();

Description: Applies a color map to a grayscale image.

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

Return Value: Boolean

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

Example:

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

Description: Adjusts hue, saturation, and intensity independently.

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

Return Value: Boolean

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

Example:

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

Description: Inverts all image colors to create a negative.

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

Return Value: Boolean

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

Example:

let success ;= Action.Invert();

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

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

Description: Removes background using rolling-ball subtraction.

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

Return Value: Boolean

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

Example:

let success ;= Action.RollingBallBackgroundSubtraction(50, true, 0);

Description: Splits the image into the selected RGB channel.

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

Return Value: Boolean

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

Example:

let success ;= Action.SplitRGB(0);

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

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

Return Value: String

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

Example:

let average ;= Action.AverageColorValue(0);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.CropExportRegions(1, 0, 0, 1, true, 0, 0, 0, "C:\\ExportedRegions", "Region\_", 0);

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

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

Return Value: String

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

Example:

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

Description: Extracts text from the workspace image using OCR.

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

Return Value: String

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

Example:

let text ;= Action.OCRTextExtraction();

Description: Counts pixels matching the specified RGB color.

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

Return Value: String

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

Example:

let counts ;= Action.PixelCounter(255, 255, 255, 0);

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

Syntax: const result = await Action.AddSelectionFromBinaryImage(sourceImageLocation);

Return Value: Boolean

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

Example:

let success ;= Action.AddSelectionFromBinaryImage(1);

Description: Copies the current image to the clipboard.

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

Return Value: Boolean

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

Example:

let success ;= Action.Copy();

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

Syntax: const result = await Action.CreateSelectionFromBinaryImage(sourceImageLocation);

Return Value: Boolean

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

Example:

let success ;= Action.CreateSelectionFromBinaryImage(1);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.ExpandSelection(8);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.GetFromImageBuffer(1);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.Paste();

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

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

Return Value: Boolean

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

Example:

let success ;= Action.PasteAndFitToRectangle();

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

Syntax: const result = await Action.PasteSelectionAsBinaryToBuffer(targetBufferIndex);

Return Value: Boolean

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

Example:

let success ;= Action.PasteSelectionAsBinaryToBuffer(1);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.PutToImageBuffer(1);

Description: Inverts the current selection mask.

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

Return Value: Boolean

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

Example:

let success ;= Action.ReverseSelection();

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

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

Return Value: Boolean

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

Example:

let success ;= Action.ShrinkSelection(3);

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

Syntax: const result = await Action.SubtractSelectionFromBinaryImage(sourceImageLocation);

Return Value: Boolean

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

Example:

let success ;= Action.SubtractSelectionFromBinaryImage(1);

Description: Clears the current selection.

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

Return Value: Boolean

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

Example:

let success ;= Action.Unselect();

Description: Acquires an image from a scanner.

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

Return Value: Boolean

Return Description: True if acquisition succeeded; otherwise False.

Example:

let success ;= Action.AcquireImagefromScanner(true);

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

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

Return Value: Boolean

Return Description: True if capture succeeded; otherwise False.

Example:

let success ;= Action.Capture();

Description: Sharpens the image using the advanced sharpening filter.

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

Return Value: Boolean

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

Example:

let success ;= Action.AdvancedSharpening(125);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.BoxAveraging(5);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.ChromaKeyOverlay(1, 0, 255, 0, 0, 100, false, 30, 35, 20);

Description: Crops a rectangular area from the image.

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

Return Value: Boolean

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

Example:

let success ;= Action.Crop(500, 500, 0, 0);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.Dithering(0);

Description: Creates an embossed relief effect.

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.FFT();

Description: Flips the image horizontally.

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

Return Value: Boolean

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

Example:

let success ;= Action.FlipHorizontally();

Description: Flips the image vertically.

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

Return Value: Boolean

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

Example:

let success ;= Action.FlipVertically();

Description: Adjusts image brightness using gamma correction.

Syntax: const result = await Action.GammaAdjustment(gammaValue);

Return Value: Boolean

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

Example:

let success ;= Action.GammaAdjustment(0.8);

Description: Blurs the image using a Gaussian filter.

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

Return Value: Boolean

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

Example:

let success ;= Action.GaussianFilter(5);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.ImageStamp(1, 0, 0, 100, 100, 0.0F, 100, false, -1, false, 30, false, 10);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.InverseFFT();

Description: Applies a mosaic or pixelation effect.

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.OverlayImage(1, 0, 0, 0, 0, 100, false, 30, 0, false);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.Resize(0, true, 0, 800, 600, 4);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.ResizeCanvas(0, true, 0, 800, 600, 0, 255, 255, 255);

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.Sharpen3x3();

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

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

Return Value: Boolean

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

Example:

let success ;= Action.Sharpen5x5HighQuality(20);

Description: Reduces image noise while preserving edges.

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

Return Value: Boolean

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

Example:

let success ;= Action.SmartDenoise(5, 30);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.StackBlur(5);

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.AIAutoSubjectSelectionGeneral();

Description: Automatically selects the subject in a portrait image.

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

Return Value: Boolean

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

Example:

let success ;= Action.AIAutoSubjectSelectionPortrait();

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.AIBinarizationSegmentation();

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

Syntax: const result = await Action.AICustomBinarization(targetModelName);

Return Value: Boolean

Return Description: True if binarization succeeded; otherwise False.

Example:

let success ;= Action.AICustomBinarization("");

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

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

Return Value: Boolean

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

Example:

let success ;= Action.AIDepthEstimation(true);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.AIDocumentUnwarping();

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

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

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

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

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

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

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

let success ;= Action.AIImageQualityRestorationFastest();

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

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

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

let success ;= Action.AIImageQualityRestorationSlow();

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

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

Return Value: Boolean

Return Description: True if restoration succeeded; otherwise False.

Example:

let success ;= Action.AIImageQualityRestorationSlowest();

Description: Sharpens the image using AI enhancement.

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

Return Value: Boolean

Return Description: True if sharpening succeeded; otherwise False.

Example:

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

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

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

Return Value: Boolean

Return Description: True if upscaling succeeded; otherwise False.

Example:

let success ;= Action.AIImageUpscaleRealESRFast();

Description: Upscales the image using the RealESRGAN AI model.

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

Return Value: Boolean

Return Description: True if upscaling succeeded; otherwise False.

Example:

let success ;= Action.AIImageUpscaleRealESRGAN(4);

Description: Removes unwanted image content using AI inpainting.

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

Return Value: Boolean

Return Description: True if inpainting succeeded; otherwise False.

Example:

let success ;= Action.AIInpainting();

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

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

Return Value: Boolean

Return Description: True if detection completed; otherwise False.

Example:

let success ;= Action.AIObjectDetection(0.5F, 0.4F, false, "", true, true, 255, 0, 0, false, "");

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

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

Return Value: Boolean

Return Description: True if correction succeeded; otherwise False.

Example:

let success ;= Action.AIOverExposureCorrection();

Description: Creates an intelligent selection using image content analysis.

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

Return Value: Boolean

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

Example:

let success ;= Action.AISmartSelection();

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

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

Return Value: Boolean

Return Description: True if correction succeeded; otherwise False.

Example:

let success ;= Action.AIUnderExposureCorrection();

Description: Applies adaptive thresholding to images with varying illumination.

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

Return Value: Boolean

Return Description: True if thresholding succeeded; otherwise False.

Example:

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

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

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

Return Value: Boolean

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

Example:

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

Description: Detects object boundaries using the selected overlay mode.

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

Return Value: Boolean

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

Example:

let success ;= Action.BoundaryDetection(0);

Description: Detects edges using the Canny algorithm.

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

Return Value: Boolean

Return Description: True if detection succeeded; otherwise False.

Example:

let success ;= Action.CannyEdge(100);

Description: Converts every non-black pixel to white.

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

Return Value: Boolean

Return Description: True if conversion succeeded; otherwise False.

Example:

let success ;= Action.ChangeNonBlackToWhite();

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

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

Return Value: Boolean

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

Example:

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

Description: Applies morphological dilation to expand foreground objects.

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

Return Value: Boolean

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

Example:

let success ;= Action.Dilate(3);

Description: Dilates traced outlines to make them thicker.

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

Return Value: Boolean

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

Example:

let success ;= Action.DilateOutline();

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

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

Return Value: Boolean

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

Example:

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

Description: Detects image edges using the selected algorithm.

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

Return Value: Boolean

Return Description: True if detection succeeded; otherwise False.

Example:

let success ;= Action.EdgeDetection(0);

Description: Applies morphological erosion to shrink foreground objects.

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

Return Value: Boolean

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

Example:

let success ;= Action.Erode(3);

Description: Erodes traced outlines to make them thinner.

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

Return Value: Boolean

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

Example:

let success ;= Action.ErodeOutline();

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

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

Return Value: Boolean

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

Example:

let success ;= Action.FillRegion(0, 0, 0, 0, 100);

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

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

Return Value: Boolean

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

Example:

let success ;= Action.HideOutlines(255, 255, 255, true);

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

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

Return Value: Boolean

Return Description: True if binarization succeeded; otherwise False.

Example:

let success ;= Action.ManualThresholding(128);

Description: Applies multilevel thresholding independently to RGB channels.

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

Return Value: Boolean

Return Description: True if thresholding succeeded; otherwise False.

Example:

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

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

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

Return Value: Boolean

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

Example:

let success ;= Action.Outline(false, false);

Description: Colors connected image regions to distinguish them.

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

Return Value: Boolean

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

Example:

let success ;= Action.RegionColoring(8);

Description: Removes small connected components from a binary image.

Syntax: const result = await Action.RemoveDots(dotMode, maxDotSize, connectivity);

Return Value: Boolean

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

Example:

let success ;= Action.RemoveDots(2, 20, 8);

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

Syntax: const result = await Action.Skeletonize(isExtended, isInverted, minBranchLength, tailLength);

Return Value: Boolean

Return Description: True if skeletonization succeeded; otherwise False.

Example:

let success ;= Action.Skeletonize(true, false, 15, 10);

Description: Segments the image into superpixels.

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

Return Value: Boolean

Return Description: True if segmentation succeeded; otherwise False.

Example:

let success ;= Action.SuperPixelSegmentation(400, 30.0F, false);

Description: Segments touching objects using watershed separation.

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

Return Value: Boolean

Return Description: True if segmentation succeeded; otherwise False.

Example:

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

Description: Activates undo tracking for workspace operations.

Syntax: await Action.ActivateUndoEngine();

Return Value: Void

Return Description: Void.

Example:

Action.ActivateUndoEngine();

Description: Deactivates undo tracking for workspace operations.

Syntax: await Action.DeactivateUndoEngine();

Return Value: Void

Return Description: Void.

Example:

Action.DeactivateUndoEngine();

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

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

Return Value: Bitmap

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

Example:

let bitmap ;= Action.GetImage(0);

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

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

Return Value: String

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

Example:

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

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

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

Return Value: Void

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

Example:

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

Description: Saves the current workspace with a new name.

Syntax: await Action.SaveWorkspaceAs();

Return Value: Void

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

Example:

Action.SaveWorkspaceAs();

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

Syntax: await Action.SaveWorkspaceSelectionAs();

Return Value: Void

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

Example:

Action.SaveWorkspaceSelectionAs();

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

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

Return Value: Boolean

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

Example:

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

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

Syntax: const result = await DNNClassifier.GetLastError();

Return Value: String

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

Example:

let errorMessage ;= classifier.GetLastError();

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

Syntax: const result = await DNNClassifier.LoadModel(modelFilename, forceReload);

Return Value: Boolean

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

Example:

let loaded ;= classifier.LoadModel("model.zip", true);

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

Syntax: const result = await DNNClassifier.Predict(img);

Return Value: String

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

Example:

let label ;= classifier.Predict(bitmap);

Description: Converts ARGB values to integer.

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

Return Value: Integer

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

Example:

let color ;= imgproc.ARGBToARGBInteger(255, 255, 0, 0);

Description: Converts ARGB bytes to Color object.

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

Return Value: Color

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

Example:

let clr ;= imgproc.ARGBToColor(255, 255, 0, 0);

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

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

Example:

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

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

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

Example:

let modified ;= imgproc.Change_Color_ByRGB(bitmap, 255, 0, 0, 0, 255, 0);

Description: Validates RGB values in text boxes.

Syntax: await ImgProc.Check_RGBInTextBox(Text_R, Text_G, Text_B);

Return Value: Void

Return Description: None.

Example:

imgproc.Check_RGBInTextBox(txtRed, txtGreen, txtBlue);

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

Syntax: const result = await ImgProc.CIELab(original, lShift, aShift, bShift, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

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

Example:

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

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

Syntax: const result = await ImgProc.ColorDeconvolution(SourceImage, StainType, ShowColor, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

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

Example:

let deconvoluted ;= imgproc.ColorDeconvolution(bitmap, 0, true);

Description: Converts hexadecimal color string to integer.

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

Return Value: Integer

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

Example:

let colorInt ;= imgproc.ColorHexToColorInteger("#FF0000");

Description: Converts hexadecimal color string to RGB components.

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

Return Value: Void

Example:

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

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

Syntax: await ImgProc.ColorIntegerToARGB(PixelValue);

Return Value: Void

Return Description: Void; prints ARGB components to console.

Example:

imgproc.ColorIntegerToARGB(4294967295);

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

Syntax: await ImgProc.ColorIntegerToRGB(PixelValue);

Return Value: Void

Return Description: Void; prints RGB components to console.

Example:

imgproc.ColorIntegerToRGB(255);

Description: Decomposes color to ARGB and HSI components.

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

Return Value: Void

Example:

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

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

Syntax: const result = await ImgProc.ColorRangeSelection(SourceImage, targetR, targetG, targetB, colorSpace, isFastAlgorithm, tolerance, maintainOrgColor, isShowProgress, maskImage, maskRegionBoundary, isMaskAllRegionSelected);

Return Value: Bitmap

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

Example:

let selected ;= imgproc.ColorRangeSelection(bitmap, 0, 255, 0, "Chroma", false, 40, true);

Description: Converts RGB Color object to hexadecimal string representation.

Syntax: const result = await ImgProc.ColorToColorHEX(SourceColor);

Return Value: String

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

Example:

let hex ;= imgproc.ColorToColorHEX(Color.Red);

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

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

Return Value: Bitmap

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

Example:

let indexed ;= imgproc.Convert_Gray24Bit_To_8bppIndexed(bitmap);

Description: Converts RGB to rg chromaticity coordinates.

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

Return Value: Bitmap

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

Example:

let rgChromaticity ;= imgproc.Convert_To_rgChromaticity(bitmap);

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

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

Example:

let rgChromaticity ;= imgproc.Convert_To_rgChromaticity_Parallel(bitmap);

Description: Removes blue channel from image.

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

Return Value: Bitmap

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

Example:

let noBlue ;= imgproc.Delete_BlueChannel(bitmap);

Description: Removes green channel from image.

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

Return Value: Bitmap

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

Example:

let noGreen ;= imgproc.Delete_GreenChannel(bitmap);

Description: Removes red channel from image.

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

Return Value: Bitmap

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

Example:

let noRed ;= imgproc.Delete_RedChannel(bitmap);

Description: Quantizes color channel value to discrete levels.

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

Return Value: Byte

Return Description: Quantized color value.

Example:

let quantized ;= imgproc.Digitalize(128.5, 8);

Description: Extracts blue channel as grayscale image.

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

Return Value: Bitmap

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

Example:

let grayBlue ;= imgproc.GrayFrom_Blue(bitmap);

Description: Extracts green channel as grayscale.

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

Return Value: Bitmap

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

Example:

let grayGreen ;= imgproc.GrayFrom_Green(bitmap);

Description: Extracts red channel as grayscale image.

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

Return Value: Bitmap

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

Example:

let grayRed ;= imgproc.GrayFrom_Red(bitmap);

Description: Converts colored image to grayscale using luminosity method.

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

Return Value: Bitmap

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

Example:

let gray ;= imgproc.GrayScaling(bitmap, true);

Description: Applies color map to grayscale image for visualization.

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

Return Value: Bitmap

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

Example:

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

Description: Converts hexadecimal color string to RGB byte values.

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

Return Value: Void

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

Example:

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

Description: Removes or 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

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

Example:

let hidden ;= imgproc.Hide_Outlines(bitmap, 0, 0, 0);

Description: Converts HSI to RGB color space.

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

Return Value: Void

Example:

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

Description: Converts HSV to RGB color space.

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

Return Value: Void

Example:

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

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

Syntax: const result = await ImgProc.HueSaturationIntensity(original, hueShift, satShift, intShift, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

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

Example:

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

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

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

Return Value: Boolean

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

Example:

let isBinary ;= imgproc.IsBinaryImage(bitmap);

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

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

Return Value: Boolean

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

Example:

let isBW ;= imgproc.IsBWPixel(0, 0, 0);

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

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

Return Value: Boolean

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

Example:

let isGray ;= imgproc.IsGrayImage(bitmap);

Description: Returns maximum value among three color components.

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

Return Value: Single

Return Description: Maximum value among the three components.

Example:

let max ;= imgproc.Maximum(255.0, 128.0, 200.0);

Description: Merges three channel images using specified color space.

Syntax: const result = await ImgProc.MergeChannels(SourceImage, ColorSpace, Image1, Image2, Image3, maskImage, maskRegionBoundary, isMaskAllRegionSelected);

Return Value: Bitmap

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

Example:

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

Description: Returns minimum value among three color components.

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

Return Value: Single

Return Description: Minimum value among the three components.

Example:

let min ;= imgproc.Minimum(255.0, 128.0, 200.0);

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

Syntax: const result = await ImgProc.MultiStepThresholding(SourceImage, LevelCount_Red, LevelCount_Green, LevelCount_Blue, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

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

Example:

let thresholded ;= imgproc.MultiStepThresholding(bitmap, 3, 3, 3);

Description: Removes alpha channel transparency from image.

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

Return Value: Bitmap

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

Example:

let noAlpha ;= imgproc.RemoveTransparency(bitmap);

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

Syntax: const result = await ImgProc.RGBToARGBInteger(red, green, blue);

Return Value: Integer

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

Example:

let argb ;= imgproc.RGBToARGBInteger(255, 128, 64);

Description: Converts RGB to CMYK color space.

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

Return Value: Void

Example:

imgproc.RGBToCMYK(255, 128, 64, true, true, true);

Description: Converts RGB byte values to Color object.

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

Return Value: Color

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

Example:

let color ;= imgproc.RGBToColor(255, 100, 50);

Description: Converts RGB values to hexadecimal color string.

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

Return Value: String

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

Example:

let hexColor ;= imgproc.RGBToColorHex(255, 0, 0);

Description: Converts RGB to green chromaticity coordinate.

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

Return Value: Void

Return Description: None.

Example:

imgproc.RGBToGChromaticity(255, 128, 0);

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: Void

Return Description: None.

Example:

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

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

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

Return Value: Byte

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

Example:

let grayByte ;= imgproc.RGBToGray(255, 100, 50);

Description: Converts RGB to grayscale using precise luminosity calculation.

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

Return Value: Integer

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

Example:

let grayValue ;= imgproc.RGBToGray_ByRealCalc(255, 100, 50);

Description: Converts RGB to HSI color space.

Syntax: await ImgProc.RGBToHSI(r, g, b);

Return Value: Void

Example:

imgproc.RGBToHSI(255, 128, 64);

Description: Converts RGB to HSI using parallel method.

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

Return Value: Void

Example:

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

Description: Converts RGB to CIELab color space.

Syntax: await ImgProc.RGBToLab(r, g, b);

Return Value: Void

Example:

imgproc.RGBToLab(255, 128, 64);

Description: Converts RGB to CIELab with original value output.

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

Return Value: Void

Example:

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

Description: Converts RGB to CIELab using parallel method.

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

Return Value: Void

Example:

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

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

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

Return Value: Bitmap

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

Example:

let aChannel ;= imgproc.Split_a(bitmap);

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

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

Return Value: Bitmap

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

Example:

let bChannel ;= imgproc.Split_b(bitmap);

Description: Extracts blue channel from color image as grayscale.

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

Return Value: Bitmap

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

Example:

let blueChannel ;= imgproc.Split_Blue(bitmap);

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

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

Return Value: Bitmap

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

Example:

let cChannel ;= imgproc.Split_Cyan(bitmap);

Description: Extracts green channel from color image as grayscale.

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

Return Value: Bitmap

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

Example:

let greenChannel ;= imgproc.Split_Green(bitmap);

Description: Extracts hue channel from HSI color space.

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

Return Value: Bitmap

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

Example:

let hueChannel ;= imgproc.Split_Hue(bitmap);

Description: Extracts intensity channel from HSI color space.

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

Return Value: Bitmap

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

Example:

let intensity ;= imgproc.Split_Intensity(bitmap);

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

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

Return Value: Bitmap

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

Example:

let kChannel ;= imgproc.Split_KBlack(bitmap);

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

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

Return Value: Bitmap

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

Example:

let lChannel ;= imgproc.Split_L(bitmap);

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

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

Return Value: Bitmap

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

Example:

let mChannel ;= imgproc.Split_Magenta(bitmap);

Description: Extracts red channel from color image as grayscale.

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

Return Value: Bitmap

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

Example:

let redChannel ;= imgproc.Split_Red(bitmap);

Description: Splits rg chromaticity blue channel.

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

Return Value: Bitmap

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

Example:

let rgBlue ;= imgproc.Split_rgChromaticityBlue(bitmap);

Description: Splits rg chromaticity green channel.

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

Return Value: Bitmap

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

Example:

let rgGreen ;= imgproc.Split_rgChromaticityGreen(bitmap);

Description: Splits rg chromaticity red channel.

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

Return Value: Bitmap

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

Example:

let rgRed ;= imgproc.Split_rgChromaticityRed(bitmap);

Description: Extracts saturation channel from HSI color space.

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

Return Value: Bitmap

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

Example:

let saturation ;= imgproc.Split_Saturation(bitmap);

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

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

Return Value: Bitmap

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

Example:

let yChannel ;= imgproc.Split_Yellow(bitmap);

Description: Checks if two images are identical.

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

Return Value: Boolean

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

Example:

let identical ;= imgproc.AreImagesIdentical(bitmap1, bitmap2);

Description: Calculates average color value of specified channel.

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

Return Value: Single

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

Example:

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

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

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

Example:

let avgA ;= imgproc.Calculate_AverageColorValue_a(bitmap, totPix, 1);

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

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

Example:

let avgB ;= imgproc.Calculate_AverageColorValue_b(bitmap, totPix, 1);

Description: Calculates average blue channel value.

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

Return Value: Single

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

Example:

let avgBlue ;= imgproc.Calculate_AverageColorValue_Blue(bitmap, totPix, 1);

Description: Calculates average cyan channel value.

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

Return Value: Single

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

Example:

let avgCyan ;= imgproc.Calculate_AverageColorValue_Cyan(bitmap, totPix, 1);

Description: Calculates average grayscale value.

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

Return Value: Single

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

Example:

let avgGray ;= imgproc.Calculate_AverageColorValue_Gray(bitmap, totPix, 1);

Description: Calculates average green channel value.

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

Return Value: Single

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

Example:

let avgGreen ;= imgproc.Calculate_AverageColorValue_Green(bitmap, totPix, 1);

Description: Calculates average hue value.

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