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

Syntax: await action.activateundoengine();

Parameters: None

Return Value: None

JavaScript (Node.js / Browser) Example:

action.activateundoengine();

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

Syntax: await action.deactivateundoengine();

Parameters: None

Return Value: None

JavaScript (Node.js / Browser) Example:

action.deactivateundoengine();

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

Syntax: await action.saveworkspaceas();

Parameters: None

Return Value: None

JavaScript (Node.js / Browser) Example:

action.saveworkspaceas();

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

Syntax: await action.saveworkspaceselectionas();

Parameters: None

Return Value: None

JavaScript (Node.js / Browser) Example:

action.saveworkspaceselectionas();

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

Syntax: const result = await action.saveimage(sourceBitmap, destFileName, jpegQuality);

Return Value: String

JavaScript (Node.js / Browser) Example:

let img;, errStr;
img = action.getimage();
errStr = action.saveimage();

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

Syntax: await action.saveimagedialog(targetBitmap, selectedExtension, selectedQuality);

Return Value: None

JavaScript (Node.js / Browser) Example:

action.saveimagedialog();

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

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.saveimageaction();

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

Syntax: const result = await action.expandselection(expandByPixels);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.expandselection();

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

Syntax: const result = await action.shrinkselection(shrinkByPixels);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.shrinkselection();

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

Syntax: const result = await action.puttoimagebuffer(targetLocation);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.puttoimagebuffer();

Description: Retrieves an image from a specified buffer location.

Syntax: const result = await action.getfromimagebuffer(sourceLocation);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.getfromimagebuffer();

Description: Copies the current selection to the clipboard.

Syntax: const result = await action.copy();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.copy();

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

Syntax: const result = await action.paste();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.paste();

Description: Clears the active selection.

Syntax: const result = await action.unselect();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.unselect();

Description: Applies a box averaging blur filter.

Syntax: const result = await action.boxaveraging(kernelSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.boxaveraging();

Description: Applies a Gaussian blur filter.

Syntax: const result = await action.gaussianfilter(kernelSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.gaussianfilter();

Description: Flips the image vertically.

Syntax: const result = await action.flipvertically();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.flipvertically();

Description: Flips the image horizontally.

Syntax: const result = await action.fliphorizontally();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.fliphorizontally();

Description: Applies a basic 3×3 sharpening filter.

Syntax: const result = await action.sharpen3x3();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.sharpen3x3();

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

Syntax: const result = await action.sharpen5x5highquality(sharpenStrengthPercentage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.sharpen5x5highquality();

Description: Applies an advanced sharpening algorithm.

Syntax: const result = await action.advancedsharpening(sharpenAmountPercentage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.advancedsharpening();

Description: Reduces noise in the image while preserving edges.

Syntax: const result = await action.smartdenoise(radius, threshold);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.smartdenoise();

Description: Applies an embossing effect to the image.

Syntax: const result = await action.emboss(angle, distance, strength, bias);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.emboss();

Description: Applies a dithering algorithm to reduce color banding.

Syntax: const result = await action.dithering(ditheringAlgorithmType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.dithering();

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

Syntax: const result = await action.mosaicfilter(mosaicModeType, value);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.mosaicfilter();

Description: Automatically aligns rotation based on detected lines.

Syntax: const result = await action.rotationalalignmentbyline(backgroundColorRed, backgroundColorGreen, backgroundColorBlue);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.rotationalalignmentbyline();

Description: Resizes the image using specified dimensions and interpolation.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.resize();

Description: Rotates the image by a specific angle.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.rotate();

Description: Crops the image to a defined rectangle.

Syntax: const result = await action.crop(cropWidthPixels, cropHeightPixels, startXCoordinate, startYCoordinate);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.crop();

Description: Resizes the canvas without scaling the image content.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.resizecanvas();

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

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.overlayimage();

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

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.chromakeyoverlay();

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

Syntax: const result = await action.splitrgb(rgbSplitChannelType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.splitrgb();

Description: Removes a specific color channel from the image.

Syntax: const result = await action.deletechannel(channelToDeleteType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.deletechannel();

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

Syntax: const result = await action.grayfrom(sourceChannelType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.grayfrom();

Description: Inverts the colors of the image.

Syntax: const result = await action.invert();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.invert();

Description: Converts the image to standard grayscale.

Syntax: const result = await action.grayscaling();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.grayscaling();

Description: Converts the image to rg chromaticity space.

Syntax: const result = await action.converttorgchrom();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.converttorgchrom();

Description: Applies a pseudocolor map to a grayscale image.

Syntax: const result = await action.graytocolor(mapType, isReversed);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.graytocolor();

Description: Automatically adjusts the tonal range of the image.

Syntax: const result = await action.autotone(clipPercentage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.autotone();

Description: Automatically adjusts the contrast of the image.

Syntax: const result = await action.autocontrast(clipPercentage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.autocontrast();

Description: Applies automatic histogram equalization.

Syntax: const result = await action.autoequalize();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.autoequalize();

Description: Automatically corrects the gamma curve of the image.

Syntax: const result = await action.autogamma();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.autogamma();

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

Syntax: const result = await action.autowhitebalance();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.autowhitebalance();

Description: Adjusts shadow and highlight details automatically.

Syntax: const result = await action.autoshadowshighlights(shadowCorrectionStrengthPercentage, highlightCorrectionStrengthPercentage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.autoshadowshighlights();

Description: Applies local adaptive contrast enhancement.

Syntax: const result = await action.adaptivecontrast(contrastStrengthPercentage, gridTilesX, gridTilesY, contrastClipLimit);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.adaptivecontrast();

Description: Corrects uneven background illumination.

Syntax: const result = await action.correctunevenillumination(illuminationGridSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.correctunevenillumination();

Description: Subtracts background using a rolling ball algorithm.

Syntax: const result = await action.rollingballbackgroundsubtraction(rollingBallBoxSize, isObjectColorAutomatic, manualObjectColorType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.rollingballbackgroundsubtraction();

Description: Adjusts brightness and contrast levels manually or automatically.

Syntax: const result = await action.brightcontrast(brightnessLevel, contrastLevel, autoBrightness);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.brightcontrast();

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

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.changecolor();

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

Syntax: const result = await action.cielab(lightnessShift, aAxisShift, bAxisShift);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.cielab();

Description: Adjusts saturation and intensity across multiple color bands.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.multibandcolor();

Description: Adjusts global hue, saturation, and intensity.

Syntax: const result = await action.huesaturationintensity(hue, saturation, intensity);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.huesaturationintensity();

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

Syntax: const result = await action.mergechannels(colorSpaceType, image1Source, image2Source, image3Source);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.mergechannels();

Description: Fills a specified region with color and opacity.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.fillregion();

Description: Draws a border around the current selection.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.drawselectionborder();

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

Syntax: const result = await action.hideoutlines(targetColorRed, targetColorGreen, targetColorBlue, useMostFrequentColor);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.hideoutlines();

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

Syntax: const result = await action.changenonblacktowhite();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.changenonblacktowhite();

Description: Applies morphological erosion.

Syntax: const result = await action.erode(morphologyKernelSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.erode();

Description: Applies morphological dilation.

Syntax: const result = await action.dilate(morphologyKernelSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.dilate();

Description: Detects edges using specified standard algorithms.

Syntax: const result = await action.edgedetection(edgeDetectionAlgorithmType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.edgedetection();

Description: Detects edges using the Canny edge detection method.

Syntax: const result = await action.cannyedge(cannyHighThreshold);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.cannyedge();

Description: Applies morphological skeletonization (thinning).

Syntax: const result = await action.skeletonize();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.skeletonize();

Description: Applies extended morphological skeletonization.

Syntax: const result = await action.skeletonizeextended();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.skeletonizeextended();

Description: Detects boundaries of objects based on overlay modes.

Syntax: const result = await action.boundarydetection(boundaryOverlayModeType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.boundarydetection();

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

Syntax: const result = await action.removeblackdots(maxDotSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.removeblackdots();

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

Syntax: const result = await action.removewhitedots(maxDotSize);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.removewhitedots();

Description: Extracts the outlines of binary objects.

Syntax: const result = await action.outline();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.outline();

Description: Erodes only the outlined regions.

Syntax: const result = await action.erodeoutline();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.erodeoutline();

Description: Dilates only the outlined regions.

Syntax: const result = await action.dilateoutline();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.dilateoutline();

Description: Applies binarization using a manually defined threshold.

Syntax: const result = await action.manualthresholding(binarizationThresholdValue);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.manualthresholding();

Description: Applies multi-level thresholding across RGB channels.

Syntax: const result = await action.multistepthresholding(redChannelLevels, greenChannelLevels, blueChannelLevels);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.multistepthresholding();

Description: Calculates the difference between two images.

Syntax: const result = await action.differentialimage(firstImageSourceLocation, secondImageSourceLocation);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.differentialimage();

Description: Applies watershed segmentation algorithm.

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

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.watershedsegmentation();

Description: Performs logical operations between two binary images.

Syntax: const result = await action.binaryoperation(logicalOperationType, firstImageSourceLocation, secondImageSourceLocation);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.binaryoperation();

Description: Applies local adaptive thresholding for binarization.

Syntax: const result = await action.adaptivethresholding(adaptiveBoxSize, adaptiveThresholdLevel, isObjectColorAutomatic, manualObjectColorType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.adaptivethresholding();

Description: Colors separated contiguous regions differently.

Syntax: const result = await action.regioncoloring(connectivity);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.regioncoloring();

Description: Segments the image into superpixels.

Syntax: const result = await action.superpixelsegmentation(numSuperpixels, compactness, fillWithWhite);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.superpixelsegmentation();

Description: Triggers hardware capture mechanism.

Syntax: const result = await action.capture();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.capture();

Description: Acquires an image from a connected scanner hardware.

Syntax: const result = await action.acquireimagefromscanner(useSilentMode);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.acquireimagefromscanner();

Description: Estimates depth maps using AI.

Syntax: const result = await action.aidepthestimation(autoResizeLargeImages);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aidepthestimation();

Description: Unwarps distorted document images using AI.

Syntax: const result = await action.aidocumentunwarping();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aidocumentunwarping();

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

Syntax: const result = await action.aibinarizationsegmentation();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aibinarizationsegmentation();

Description: Inpaints missing or masked areas via AI.

Syntax: const result = await action.aiinpainting();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiinpainting();

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

Syntax: const result = await action.aibackgroundremovalselfie(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aibackgroundremovalselfie();

Description: Sharpens images utilizing an AI model.

Syntax: const result = await action.aiimagesharpening(sharpenBoostFactor);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimagesharpening();

Description: Fast AI-based image quality restoration.

Syntax: const result = await action.aiimagequalityrestorationfast(restorationBoostFactor);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimagequalityrestorationfast();

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

Syntax: const result = await action.aiimagequalityrestorationslow();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimagequalityrestorationslow();

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

Syntax: const result = await action.aiimagequalityrestorationslowest();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimagequalityrestorationslowest();

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

Syntax: const result = await action.aiimagequalityrestorationfastest();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimagequalityrestorationfastest();

Description: General purpose AI background removal.

Syntax: const result = await action.aibackgroundremovalgeneral(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aibackgroundremovalgeneral();

Description: Portrait-optimized AI background removal.

Syntax: const result = await action.aibackgroundremovalportrait(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aibackgroundremovalportrait();

Description: Selects main subjects intelligently using AI.

Syntax: const result = await action.aismartselection();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aismartselection();

Description: Automatically outlines general subjects.

Syntax: const result = await action.aiautosubjectselectiongeneral();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiautosubjectselectiongeneral();

Description: Automatically outlines portrait subjects.

Syntax: const result = await action.aiautosubjectselectionportrait();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiautosubjectselectionportrait();

Description: Upscales images using Real-ESRGAN.

Syntax: const result = await action.aiimageupscalerealesrgan(upscaleMagnificationType);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimageupscalerealesrgan();

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

Syntax: const result = await action.aiimageupscalerealesrfast();

Parameters: None

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.aiimageupscalerealesrfast();

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

Syntax: const result = await action.averagecolorvalue(analysisTargetChannelType);

Return Value: String

JavaScript (Node.js / Browser) Example:

let val; = action.averagecolorvalue();

Description: Counts pixels matching a specific color threshold.

Syntax: const result = await action.pixelcounter(targetColorRed, targetColorGreen, targetColorBlue, resultOutputFormatType);

Return Value: String

JavaScript (Node.js / Browser) Example:

let result; = action.pixelcounter();

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

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

Return Value: String

JavaScript (Node.js / Browser) Example:

let result; = action.multicellanalysis();

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

Syntax: const result = await action.ocrtextextraction();

Parameters: None

Return Value: String

JavaScript (Node.js / Browser) Example:

let textData; = action.ocrtextextraction();

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

Syntax: const result = await action.getimage(sourceLocation);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let myImg; = action.getimage();

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

Syntax: const result = await action.setimage(newImage, targetLocation);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let success; = action.setimage();

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

Syntax: const result = await imgproc.cloneimage(SourceImage);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let copyBmp; As Bitmap = imgproc.cloneimage();

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

Syntax: const result = await imgproc.removetransparency(SourceImage);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let nonTransBmp; As Bitmap = imgproc.removetransparency();

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

Syntax: const result = await imgproc.generateCanvas(nWidth, nHeight, BackColor);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let canvas; As Bitmap = imgproc.generateCanvas();

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

Syntax: const result = await imgproc.superpixelsegmentation(SourceImage, numSuperpixels, compactness, fillWithWhite, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let spImg; As Bitmap = imgproc.superpixelsegmentation();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let idMap;(,) As Integer;
let colorTable;(,) As Byte;
let resBmp; = imgproc.regionextractFloodfill4();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let idMap;(,) As Integer;
let colorTable;(,) As Byte;
let resBmp; = imgproc.regionextractFloodfill8();

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

Syntax: const result = await imgproc.regionextractColorfloodfill4(SourceImage, LabelIDMap, RegionColorTable, BoundaryColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resBmp; = imgproc.regionextractColorfloodfill4();

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

Syntax: const result = await imgproc.regionextractColorfloodfill8(SourceImage, LabelIDMap, RegionColorTable, BoundaryColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resBmp; = imgproc.regionextractColorfloodfill8();

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

Syntax: const result = await imgproc.shadowshighlights(original, shadowAmt, highlightAmt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.shadowshighlights();

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

Syntax: const result = await imgproc.multibandcolor(original, rSat, rInt, ySat, yInt, gSat, gInt, cSat, cyanInt, bSat, bInt, mSat, mInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.multibandcolor();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.cielab();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.huesaturationintensity();

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

Syntax: const result = await imgproc.colorrangeselection(SourceImage, ColorCode, IsFastAlgorithm, Tolerance, MaintainOrgColor, ColorSpaceName, IsShowProgressBar, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.colorrangeselection();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let grayBmp; As Bitmap = imgproc.grayscaling();

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

Syntax: const result = await imgproc.emboss(SourceImage, Angle, Distance, Strength, Bias, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let embBmp; As Bitmap = imgproc.emboss();

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

Syntax: const result = await imgproc.outline(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let outlineBmp; As Bitmap = imgproc.outline();

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

Syntax: const result = await imgproc.changenonblacktowhite(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.changenonblacktowhite();

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

Syntax: const result = await imgproc.colortocolorhex(SourceColor);

Return Value: String

JavaScript (Node.js / Browser) Example:

let hexVal; As String = imgproc.colortocolorhex();

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

Syntax: await imgproc.colorintegertorgb(PixelValue);

Return Value: None

JavaScript (Node.js / Browser) Example:

imgproc.colorintegertorgb();

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

Syntax: await imgproc.colorintegertoargb(PixelValue);

Return Value: None

JavaScript (Node.js / Browser) Example:

imgproc.colorintegertoargb();

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

Syntax: const result = await imgproc.rgbtoargbinteger(red, green, blue);

Return Value: Integer

JavaScript (Node.js / Browser) Example:

let colorInt; As Integer = imgproc.rgbtoargbinteger();

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

Syntax: const result = await imgproc.rgbtocolor(RedInByte, GreenInByte, BlueInByte);

Return Value: Color

JavaScript (Node.js / Browser) Example:

let myColor; As Color = imgproc.rgbtocolor();

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

Syntax: const result = await imgproc.isbwpixel(red, green, blue);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let isMonochrome; As Boolean = imgproc.isbwpixel();

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

Syntax: const result = await imgproc.isgrayimage(SourceImage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let isGray; As Boolean = imgproc.isgrayimage();

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

Syntax: const result = await imgproc.isbinaryimage(SourceImage);

Return Value: Boolean

JavaScript (Node.js / Browser) Example:

let isBinary; As Boolean = imgproc.isbinaryimage();

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

Syntax: const result = await imgproc.bwDitheringFs(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let ditherBmp; As Bitmap = imgproc.bwDitheringFs();

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

Syntax: const result = await imgproc.bwDitheringOrdereddither(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let ordDitherBmp; As Bitmap = imgproc.bwDitheringOrdereddither();

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

Syntax: const result = await imgproc.convertGraybytearrayToRgbimage(SrcByteArray);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let myBmp; As Bitmap = imgproc.convertGraybytearrayToRgbimage();

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

Syntax: const result = await imgproc.convertGraybytearrayToRgbimageInt(SrcByteArray);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let myBmp; As Bitmap = imgproc.convertGraybytearrayToRgbimageInt();

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

Syntax: const result = await imgproc.convertRgbbytearrayToRgbimage(SrcByteArray);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let myBmp; As Bitmap = imgproc.convertRgbbytearrayToRgbimage();

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

Syntax: const result = await imgproc.convertGrayimageToGraybytearray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Byte(,)

JavaScript (Node.js / Browser) Example:

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

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

Syntax: const result = await imgproc.convertRgbimageToRgbbytearray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Byte(,,)

JavaScript (Node.js / Browser) Example:

let rgbMatrix;(,,) As Byte = imgproc.convertRgbimageToRgbbytearray();

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

Syntax: const result = await imgproc.convertRgbimageToGraybytearray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Byte(,)

JavaScript (Node.js / Browser) Example:

let grayMatrix;(,) As Byte = imgproc.convertRgbimageToGraybytearray();

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

Syntax: const result = await imgproc.convertRgbimageToGrayintegerarray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Integer(,)

JavaScript (Node.js / Browser) Example:

let intMatrix;(,) As Integer = imgproc.convertRgbimageToGrayintegerarray();

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

Syntax: const result = await imgproc.grayscalingPutto2dbyte(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Byte(,)

JavaScript (Node.js / Browser) Example:

let resMatrix;(,) As Byte = imgproc.grayscalingPutto2dbyte();

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

Syntax: const result = await imgproc.grayscalingPutto2dint(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Integer(,)

JavaScript (Node.js / Browser) Example:

let resIntMatrix;(,) As Integer = imgproc.grayscalingPutto2dint();

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

Syntax: const result = await imgproc.grayscalingReturnimgFrom2dint(SourceImage, Gray2DInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resBmp; As Bitmap = imgproc.grayscalingReturnimgFrom2dint();

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

Syntax: const result = await imgproc.overlayGrayintarrayOnImage(SourceImage, Gray2DInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resBmp; = imgproc.overlayGrayintarrayOnImage();

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

Syntax: const result = await imgproc.resizebyzoomfactor(SourceImage, ZoomFactor, InterpolationMode);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let zoomedBmp; As Bitmap = imgproc.resizebyzoomfactor();

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

Syntax: const result = await imgproc.resize(SourceImage, nWidth, nHeight, InterpolationMode);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resizedBmp; As Bitmap = imgproc.resize();

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

Syntax: const result = await imgproc.crop(SourceImage, nWidth, nHeight, TargetX, TargetY);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let subBmp; As Bitmap = imgproc.crop();

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

Syntax: const result = await imgproc.rotate(SourceImage, CenterX, CenterY, AngleDegree, BackgroundColor);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let rotBmp; As Bitmap = imgproc.rotate();

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

Syntax: const result = await imgproc.rotateatcenter(SourceImage, AngleDegree);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let rotBmp; As Bitmap = imgproc.rotateatcenter();

Description: Flips bitmap vertically along the horizontal axis.

Syntax: const result = await imgproc.flipVertical(SourceImage);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let flippedBmp; As Bitmap = imgproc.flipVertical();

Description: Flips bitmap horizontally along the vertical axis.

Syntax: const result = await imgproc.flipHorizontal(SourceImage);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let flippedBmp; As Bitmap = imgproc.flipHorizontal();

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

Syntax: const result = await imgproc.rotateflip(SourceImage, RotateFlipOption);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resBmp; As Bitmap = imgproc.rotateflip();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let blurBmp; As Bitmap = imgproc.boxaveraging();

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

Syntax: const result = await imgproc.gaussianfilter(SourceImage, FilterSize, WeightFactor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let gImg; As Bitmap = imgproc.gaussianfilter();

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

Syntax: const result = await imgproc.sharpen3x3(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.sharpen3x3();

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

Syntax: const result = await imgproc.sharpen3x3Improved(SourceImage, Strength, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.sharpen3x3Improved();

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

Syntax: const result = await imgproc.sharpen5x5HighqualityFixed(SourceImage, Strength, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.sharpen5x5HighqualityFixed();

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

Syntax: const result = await imgproc.mosaicfilter(SourceImage, isPixelMode, value, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let mosaicBmp; As Bitmap = imgproc.mosaicfilter();

Description: Applies morphological erosion filter using square box neighborhood.

Syntax: const result = await imgproc.erode(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected, IsDoGrayScaling);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.erode();

Description: Applies morphological dilation filter using square box neighborhood.

Syntax: const result = await imgproc.dilate(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected, IsDoGrayScaling);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.dilate();

Description: Detects image edges using Sobel operator masks.

Syntax: const result = await imgproc.edgedetectBySobel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let edgeImg; As Bitmap = imgproc.edgedetectBySobel();

Description: Detects edges based on regional homogenity differential calculation.

Syntax: const result = await imgproc.edgedetectByHomogenity(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let edgeImg; As Bitmap = imgproc.edgedetectByHomogenity();

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

Syntax: const result = await imgproc.erodeoutlines(SourceGrayImage, BackgroundGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.erodeoutlines();

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

Syntax: const result = await imgproc.dilateoutlines(SourceGrayImage, BackgroundGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.dilateoutlines();

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

Syntax: const result = await imgproc.splitRed(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let redCh; = imgproc.splitRed();

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

Syntax: const result = await imgproc.splitGreen(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let greenCh; = imgproc.splitGreen();

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

Syntax: const result = await imgproc.splitBlue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let blueCh; = imgproc.splitBlue();

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

Syntax: const result = await imgproc.grayfromRed(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let redGrayBmp; = imgproc.grayfromRed();

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

Syntax: const result = await imgproc.grayfromGreen(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let greenGrayBmp; = imgproc.grayfromGreen();

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

Syntax: const result = await imgproc.grayfromBlue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let blueGrayBmp; = imgproc.grayfromBlue();

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

Syntax: const result = await imgproc.splitHue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let hueBmp; = imgproc.splitHue();

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

Syntax: const result = await imgproc.splitSaturation(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let satBmp; = imgproc.splitSaturation();

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

Syntax: const result = await imgproc.splitIntensity(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let intBmp; = imgproc.splitIntensity();

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

Syntax: await imgproc.rgbtocmyk(r, g, b, IsCompute_Cyan, IsCompute_Magenta, IsCompute_Yellow);

Return Value: None

JavaScript (Node.js / Browser) Example:

imgproc.rgbtocmyk();

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

Syntax: await imgproc.rgbtolab(r, g, b);

Return Value: None

JavaScript (Node.js / Browser) Example:

imgproc.rgbtolab();

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

Syntax: await imgproc.rgbtolabOriginalvalue(r, g, b, LabL, Laba, Labb);

Return Value: None

JavaScript (Node.js / Browser) Example:

let L; As Double, a As Double, b As Double;
imgproc.rgbtolabOriginalvalue();

Description: Converts RGB byte values to HSI space components.

Syntax: await imgproc.rgbtohsi(r, g, b);

Return Value: None

JavaScript (Node.js / Browser) Example:

imgproc.rgbtohsi();

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

Syntax: await imgproc.hsvtorgb(h, s, v, r, g, b);

Return Value: None

JavaScript (Node.js / Browser) Example:

let r; As Byte, g As Byte, b As Byte;
imgproc.hsvtorgb();

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

Syntax: await imgproc.hsitorgb(Hue, Saturation255, Intensity255, Red, Green, Blue);

Return Value: None

JavaScript (Node.js / Browser) Example:

let r; As Integer, g As Integer, b As Integer;
imgproc.hsitorgb();

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

Syntax: const result = await imgproc.fillregion(SourceImage, FillColorStr, IsFillInside, Opacity, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.fillregion();

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

Syntax: const result = await imgproc.chromakey(TargetCanvas, OverlayImage, ChromaR, ChromaG, ChromaB, Opacity, IsFeather, FeatherRadius, MaskImage, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.chromakey();

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

Syntax: const result = await imgproc.floodfill(SourceImage, CenterX, CenterY, FillColorR, FillColorG, FillColorB, ToleranceR, ToleranceG, ToleranceB, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.floodfill();

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

Syntax: const result = await imgproc.invert(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let negBmp; = imgproc.invert();

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

Syntax: const result = await imgproc.manualbinarization(SourceImage, ThresholdValue, SkipGrayScaling, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let binBmp; = imgproc.manualbinarization();

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

Syntax: const result = await imgproc.adaptivebinarization(SourceImage, LocalBoxSizeValue, IsObjectWhite, ThresholdLevel, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.adaptivebinarization();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.multistepthresholding();

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

Syntax: const result = await imgproc.drawLine(Pic_Target, X1, Y1, X2, Y2, LineColor);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.drawLine();

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

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

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let fnt; As New Font("Arial", 12.0F);
let res; = imgproc.drawTextOutlinedBitmap();

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

Syntax: const result = await imgproc.drawRectangles(Pic_Target, SourceRectangles, LineColor);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let rects;() As Rectangle = { New Rectangle(10,10,50,50) };
let res; = imgproc.drawRectangles();

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

Syntax: const result = await imgproc.getHistogram(SourceImage, TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Single(,)

JavaScript (Node.js / Browser) Example:

let totCount; As Integer;
let hist;(,) As Single = imgproc.getHistogram();

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

Syntax: const result = await imgproc.getLineprofile(SourceImage, StartAt, EndAt, LineThickness, IsNormalizeBy255);

Return Value: Single(,)

JavaScript (Node.js / Browser) Example:

let profile;(,) As Single = imgproc.getLineprofile(), New Point(100,100), 3);

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

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

Return Value: Single

JavaScript (Node.js / Browser) Example:

let pxCount; As Long;
let avgRed; As Single = imgproc.calculateAveragecolorvalue();

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

Syntax: const result = await imgproc.distance(X1, Y1, X2, Y2);

Return Value: Double

JavaScript (Node.js / Browser) Example:

let d; As Double = imgproc.distance();

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

Syntax: const result = await imgproc.countColorpixelofinterest(SourceImage, ColorOfInterest_RGBInt, TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Integer

JavaScript (Node.js / Browser) Example:

let totPx; As Integer;
let redCount; As Integer = imgproc.countColorpixelofinterest();

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

Syntax: const result = await imgproc.rollingboxbackgroundsubtraction(SourceImage, Radius, IsAutomatic, IsObjectWhite, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let resBmp; = imgproc.rollingboxbackgroundsubtraction();

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

Syntax: const result = await imgproc.correctunevenillumination(SourceImage, GridRows, GridCols, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let flatImg; = imgproc.correctunevenillumination();

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

Syntax: const result = await imgproc.smartdenoise(SourceImage, Radius, Threshold, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let cleanImg; = imgproc.smartdenoise();

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

Syntax: const result = await imgproc.adaptivecontrast(SourceImage, Strength, TilesX, TilesY, ClipLimit, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let claheBmp; = imgproc.adaptivecontrast();

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

Syntax: const result = await imgproc.autotone(SourceImage, ClipPercent, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.autotone();

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

Syntax: const result = await imgproc.autowhitebalance(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let awbBmp; = imgproc.autowhitebalance();

Description: Automatically computes and applies optimal gamma correction curves.

Syntax: const result = await imgproc.autogamma(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let gammaBmp; = imgproc.autogamma();

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

Syntax: const result = await imgproc.sharpenUnsharpmask(SourceImage, FilterSize, AmountPercent, Threshold, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let usmBmp; = imgproc.sharpenUnsharpmask();

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

Syntax: const result = await imgproc.removebackground(SourceImage, MatteImage, MaskRegionBoundary, IsMaskAllRegionSelected, BgColor, NewBackgroundImage);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let cutBmp; = imgproc.removebackground();

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

Syntax: const result = await imgproc.watershedsegmentation(SourceImage, MinDistanceThreshold, SmoothRadius, BoundaryThickness, BoundR, BoundG, BoundB, ReturnOnlyBoundaries, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let wsBmp; = imgproc.watershedsegmentation();

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

Syntax: const result = await imgproc.splitobjectsConvexitydefects(SourceImage, MinDefectDepth, MaxCutLength, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let splitBmp; = imgproc.splitobjectsConvexitydefects();

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

Syntax: const result = await imgproc.skeletonize(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let skelBmp; = imgproc.skeletonize();

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

Syntax: const result = await imgproc.skeletonizeextended(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let extSkel; = imgproc.skeletonizeextended();

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

Syntax: const result = await imgproc.extractSkeletonpoints(SkeletonArray, foreground);

Return Value: Point()

JavaScript (Node.js / Browser) Example:

let pts;() As Point = imgproc.extractSkeletonpoints();

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

Syntax: const result = await imgproc.getTrueskeletonlength(SkeletonArray, foreground, umPerPixels, SplineVertexCount);

Return Value: Single

JavaScript (Node.js / Browser) Example:

let realLen; As Single = imgproc.getTrueskeletonlength();

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

Syntax: const result = await imgproc.savedepthmaptostlGaussianfilter(SourceImage, FilePath, MaxSTLHeight, BaseThickness, SmoothingPasses, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: String

JavaScript (Node.js / Browser) Example:

let outPath; = imgproc.savedepthmaptostlGaussianfilter();

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

Syntax: const result = await imgproc.mergechannels(ColorSpace, Image1, Image2, Image3, maskImage, maskRegionBoundary, isMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let rgbBmp; = imgproc.mergechannels();

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

Syntax: const result = await imgproc.convertToRgchromaticity(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let chromBmp; = imgproc.convertToRgchromaticity();

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

Syntax: const result = await imgproc.binaryoperationAnd(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.binaryoperationAnd();

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

Syntax: const result = await imgproc.binaryoperationOr(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.binaryoperationOr();

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

Syntax: const result = await imgproc.binaryoperationXor(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let res; = imgproc.binaryoperationXor();

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

Syntax: const result = await imgproc.computeDifferentialimage(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example:

let diff; = imgproc.computeDifferentialimage();

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

Syntax: const result = await imgproc.removeblackdots(SourceImage, MaxDotSize, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected);

Return Value: Bitmap

JavaScript (Node.js / Browser) Example: