Enhances local contrast using CLAHE.
result = Action.AdaptiveContrast(contrastStrengthPercentage, gridTilesX, gridTilesY, contrastClipLimit)
| Parameter | Description | Default |
|---|---|---|
| contrastStrengthPercentageInteger, Optional | Contrast enhancement strength percentage. | 20 |
| gridTilesXInteger, Optional | Number of grid tiles horizontally. | 8 |
| gridTilesYInteger, Optional | Number of grid tiles vertically. | 8 |
| contrastClipLimitSingle, Optional | CLAHE histogram clip limit. | 1.0F |
Boolean — True if contrast enhancement succeeded; otherwise False.
success = Action.AdaptiveContrast(20, 8, 8, 1.0F)
Automatically adjusts image contrast.
result = Action.AutoContrast(clipPercentage)
| Parameter | Description | Default |
|---|---|---|
| clipPercentageSingle, Optional | Histogram clipping percentage. | 0.5F |
Boolean — True if contrast adjustment succeeded; otherwise False.
success = Action.AutoContrast(0.5F)
Equalizes the image histogram across the tonal range.
result = Action.AutoEqualize()
Boolean — True if equalization succeeded; otherwise False.
success = Action.AutoEqualize()
Automatically adjusts image gamma.
result = Action.AutoGamma()
Boolean — True if gamma adjustment succeeded; otherwise False.
success = Action.AutoGamma()
Corrects shadow and highlight regions.
result = Action.AutoShadowsHighlights(shadowCorrectionStrengthPercentage, highlightCorrectionStrengthPercentage)
| Parameter | Description | Default |
|---|---|---|
| shadowCorrectionStrengthPercentageSingle, Optional | Shadow correction strength percentage. | 50.0F |
| highlightCorrectionStrengthPercentageSingle, Optional | Highlight correction strength percentage. | 10.0F |
Boolean — True if correction succeeded; otherwise False.
success = Action.AutoShadowsHighlights(50.0F, 10.0F)
Automatically adjusts the image tonal range.
result = Action.AutoTone(clipPercentage)
| Parameter | Description | Default |
|---|---|---|
| clipPercentageSingle, Optional | Histogram clipping percentage. | 0.5F |
Boolean — True if tone adjustment succeeded; otherwise False.
success = Action.AutoTone(0.5F)
Automatically corrects white balance and color casts.
result = Action.AutoWhiteBalance()
Boolean — True if white balance succeeded; otherwise False.
success = Action.AutoWhiteBalance()
Adjusts image brightness and contrast.
result = Action.BrightContrast(brightnessLevel, contrastLevel, autoBrightness)
| Parameter | Description | Default |
|---|---|---|
| brightnessLevelInteger, Optional | Brightness adjustment. | 0 |
| contrastLevelInteger, Optional | Contrast adjustment. | 0 |
| autoBrightnessBoolean, Optional | Whether to calculate brightness automatically. | False |
Boolean — True if the adjustment was applied; otherwise False.
success = Action.BrightContrast(0, 0, False)
Replaces one RGB color with another.
result = Action.ChangeColor(sourceColorRed, sourceColorGreen, sourceColorBlue, targetColorRed, targetColorGreen, targetColorBlue)
| Parameter | Description | Default |
|---|---|---|
| sourceColorRedInteger, Optional | Source color red component (0–255). | 255 |
| sourceColorGreenInteger, Optional | Source color green component (0–255). | 255 |
| sourceColorBlueInteger, Optional | Source color blue component (0–255). | 255 |
| targetColorRedInteger, Optional | Replacement red component (0–255). | 0 |
| targetColorGreenInteger, Optional | Replacement green component (0–255). | 0 |
| targetColorBlueInteger, Optional | Replacement blue component (0–255). | 0 |
Boolean — True if replacement succeeded; otherwise False.
success = Action.ChangeColor(255, 255, 255, 0, 0, 0)
Adjusts image color in the perceptually uniform CIE Lab space.
result = Action.CIELab(lightnessShift, aAxisShift, bAxisShift)
| Parameter | Description | Default |
|---|---|---|
| lightnessShiftInteger, Optional | Change to the L lightness axis. | 0 |
| aAxisShiftInteger, Optional | Change to the a color axis. | 0 |
| bAxisShiftInteger, Optional | Change to the b color axis. | 0 |
Boolean — True if the adjustment was applied; otherwise False.
success = Action.CIELab(0, 0, 0)
Applies color deconvolution to separate stains in the active workspace image.
result = Action.ColorDeconvolution(stainType, showColor)
| Parameter | Description | Default |
|---|---|---|
| stainTypeInteger | Integer representing the biological stain to extract. Supported stainType values: 0: H&E - Hematoxylin (Nuclei) 1: H&E - Eosin (Cytoplasm) 2: H-DAB - Hematoxylin (Background) 3: H-DAB - DAB (Protein Marker) 4: Masson's Trichrome - Methyl Blue (Collagen) 5: Masson's Trichrome - Ponceau Fuchsin (Muscle) 6: H-AEC - Hematoxylin (Nuclei) 7: H-AEC - AEC (Red Marker) 8: Methyl Green-DAB - Methyl Green (Nuclei) 9: Methyl Green-DAB - DAB (Protein Marker) 10: H-PAS - Hematoxylin (Nuclei) 11: H-PAS - PAS (Glycogen / Basement Membrane) 12: Alcian Blue & H - Alcian Blue (Acid Mucins / GAG) 13: Alcian Blue & H - Hematoxylin (Nuclei) 14: Giemsa - Methylene Blue (Nuclei) 15: Giemsa - Eosin (Erythrocytes / Cytoplasm) 16: Feulgen-Light Green - Feulgen (DNA) 17: Feulgen-Light Green - Light Green (Cytoplasm) 18: Safranin-O & Fast Green - Safranin-O (Lignin / Cartilage) 19: Safranin-O & Fast Green - Fast Green (Cellulose / Cytoplasm) 20: H&E-DAB (Triple) - Hematoxylin (Nuclei) 21: H&E-DAB (Triple) - Eosin (Cytoplasm) 22: H&E-DAB (Triple) - DAB (Protein Marker) | — |
| showColorBoolean | Whether to apply pseudo-coloring to the extracted stain result. | — |
Boolean — True if the deconvolution process succeeded; otherwise False.
success = Action.ColorDeconvolution(0, True)
Selects or isolates image pixels matching the specified target RGB color within a given tolerance.
result = Action.ColorRangeSelection(targetColorRed, targetColorGreen, targetColorBlue, colorSpaceType, algorithmType, tolerance, keepOriginalColor)
| Parameter | Description | Default |
|---|---|---|
| targetColorRedInteger, Optional | Target color red component (0–255). | 0 |
| targetColorGreenInteger, Optional | Target color green component (0–255). | 255 |
| targetColorBlueInteger, Optional | Target color blue component (0–255). | 0 |
| colorSpaceTypeInteger, Optional | Integer representing the color space model. Supported colorSpaceType values: 0: RGB 1: HSI 2: Lab 3: Chroma | 0 |
| algorithmTypeInteger, Optional | Integer representing the distance calculation algorithm. Supported algorithmType values: 0: Fast - Manhattan distance 1: Standard - Euclidean distance (Ignored when colorSpaceType is 3: Chroma) | 1 |
| toleranceInteger, Optional | Color matching tolerance range (0–255). | 40 |
| keepOriginalColorBoolean, Optional | Whether to preserve original pixel colors for matched areas (False converts matched areas to white). | True |
Boolean — True if the color range selection was applied; otherwise False.
success = Action.ColorRangeSelection(0, 255, 0, 3, 1, 40, True)
Converts the image to RG chromaticity coordinates.
result = Action.ConvertToRgChrom()
Boolean — True if conversion succeeded; otherwise False.
success = Action.ConvertToRgChrom()
Corrects uneven image illumination using a rolling-ball algorithm.
result = Action.CorrectUnevenIllumination(illuminationGridSize)
| Parameter | Description | Default |
|---|---|---|
| illuminationGridSizeInteger, Optional | Grid size used for illumination estimation. | 8 |
Boolean — True if illumination correction succeeded; otherwise False.
success = Action.CorrectUnevenIllumination(8)
Removes the specified color channel from the image.
result = Action.DeleteChannel(channelToDeleteType)
| Parameter | Description | Default |
|---|---|---|
| channelToDeleteTypeInteger, Optional | Integer representing the color channel. Supported channelToDeleteType values: 0: Red 1: Green 2: Blue | 0 |
Boolean — True if the channel was removed; otherwise False.
success = Action.DeleteChannel(0)
Creates a grayscale image from the selected color channel.
result = Action.GrayFrom(sourceChannelType)
| Parameter | Description | Default |
|---|---|---|
| sourceChannelTypeInteger, Optional | Integer representing the source color channel. Supported sourceChannelType values: 0: Red 1: Green 2: Blue | 0 |
Boolean — True if conversion succeeded; otherwise False.
success = Action.GrayFrom(0)
Converts the image to grayscale.
result = Action.GrayScaling()
Boolean — True if conversion succeeded; otherwise False.
success = Action.GrayScaling()
Applies a color map to a grayscale image.
result = Action.GrayToColor(mapType, isReversed)
| Parameter | Description | Default |
|---|---|---|
| mapTypeInteger, Optional | Integer representing the color map. Supported mapType values: 0: RedBlue 1: Viridis 2: Parula 3: Plasma 4: Inferno 5: Magma 6: Cividis 7: Jet 8: Turbo 9: Rainbow 10: Spectral 11: HSV 12: Ocean 13: Seismic 14: RdBu 15: Coolwarm 16: bwr 17: BrBG 18: PiYG 19: Hot 20: Cool 21: Spring 22: Summer 23: Autumn 24: Winter 25: Bone 26: Copper 27: Pink 28: Terrain 29: Twilight 30: Rocket (Black - Blue - Red - Light Yellow) 31: Mako (Black - Deep Blue - Purple - Light Pink) 32: Cubehelix (Astronomy standard, brightness preserved in grayscale) 33: YlGnBu (Yellow - Green - Blue) 34: RdYlGn (Red - Yellow - Green) 35: PuOr (Purple - White - Orange) 36: Ironbow (Thermal: Black - Purple - Red - Yellow - White) 37: WhiteHot (Thermal: Cold Black - Hot White) 38: BlackHot (Thermal: Cold White - Hot Black) 39: Lava (Black - Dark Red - Orange - Yellow - White) 40: Arctic (Black - Dark Blue - Cyan - White) | 0 |
| isReversedBoolean, Optional | Whether to reverse the color map. | False |
Boolean — True if the color map was applied; otherwise False.
success = Action.GrayToColor(0, False)
Adjusts hue, saturation, and intensity independently.
result = Action.HueSaturationIntensity(hue, saturation, intensity)
| Parameter | Description | Default |
|---|---|---|
| hueInteger, Optional | Hue adjustment. | 0 |
| saturationInteger, Optional | Saturation adjustment. | 0 |
| intensityInteger, Optional | Intensity adjustment. | 0 |
Boolean — True if the adjustment was applied; otherwise False.
success = Action.HueSaturationIntensity(0, 0, 0)
Inverts all image colors to create a negative.
result = Action.Invert()
Boolean — True if colors were inverted; otherwise False.
success = Action.Invert()
Merges three image sources as channels in the selected color space.
result = Action.MergeChannels(colorSpaceType, image1Source, image2Source, image3Source)
| Parameter | Description | Default |
|---|---|---|
| colorSpaceTypeInteger, Optional | Integer representing the target color space. Supported colorSpaceType values: 0: RGB 1: HSI 2: LAB | 0 |
| image1SourceInteger, Optional | First source image index. | 0 |
| image2SourceInteger, Optional | Second source image index. | 1 |
| image3SourceInteger, Optional | Third source image index. | 2 |
Boolean — True if the channels were merged; otherwise False.
success = Action.MergeChannels(0, 0, 1, 2)
Adjusts saturation and intensity for red, yellow, green, cyan, blue, and magenta bands.
result = Action.MultibandColor(rSat, rInt, ySat, yInt, gSat, gInt, cyanSat, cyanInt, bSat, bInt, mSat, mInt)
| Parameter | Description | Default |
|---|---|---|
| rSatInteger, Optional | Red-band saturation adjustment. | 0 |
| rIntInteger, Optional | Red-band intensity adjustment. | 0 |
| ySatInteger, Optional | Yellow-band saturation adjustment. | 0 |
| yIntInteger, Optional | Yellow-band intensity adjustment. | 0 |
| gSatInteger, Optional | Green-band saturation adjustment. | 0 |
| gIntInteger, Optional | Green-band intensity adjustment. | 0 |
| cyanSatInteger, Optional | Cyan-band saturation adjustment. | 0 |
| cyanIntInteger, Optional | Cyan-band intensity adjustment. | 0 |
| bSatInteger, Optional | Blue-band saturation adjustment. | 0 |
| bIntInteger, Optional | Blue-band intensity adjustment. | 0 |
| mSatInteger, Optional | Magenta-band saturation adjustment. | 0 |
| mIntInteger, Optional | Magenta-band intensity adjustment. | 0 |
Boolean — True if the adjustment was applied; otherwise False.
success = Action.MultibandColor(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
Removes background using rolling-ball subtraction.
result = Action.RollingBallBackgroundSubtraction(rollingBallBoxSize, isObjectColorAutomatic, manualObjectColorType)
| Parameter | Description | Default |
|---|---|---|
| rollingBallBoxSizeInteger, Optional | Rolling-ball box size in pixels. | 50 |
| isObjectColorAutomaticBoolean, Optional | Whether to detect object color automatically. | True |
| manualObjectColorTypeInteger, Optional | Integer representing the manual object color. Supported manualObjectColorType values (used when automatic detection is disabled): 0: White 1: Black | 0 |
Boolean — True if background subtraction succeeded; otherwise False.
success = Action.RollingBallBackgroundSubtraction(50, True, 0)
Splits the image into the selected RGB channel.
result = Action.SplitRGB(rgbSplitChannelType)
| Parameter | Description | Default |
|---|---|---|
| rgbSplitChannelTypeInteger, Optional | Integer representing the target channel. Supported rgbSplitChannelType values: 0: RGB Red 1: RGB Green 2: RGB Blue 3: Hue 4: Saturation 5: Intensity 6: CMYK Cyan 7: CMYK Magenta 8: CMYK Yellow 9: CMYK Key (Black) 10: Lab L 11: Lab a 12: Lab b 13: rg chromaticity r 14: rg chromaticity g 15: rg chromaticity b | 0 |
Boolean — True if the channel was extracted; otherwise False.
success = Action.SplitRGB(0)
Applies dual-tone color grading to shadows and highlights independently using a high-speed 256-entry luminance LUT.
result = Action.SplitToning(shadowHue, highlightHue, toneStrength, tonalBalance)
| Parameter | Description | Default |
|---|---|---|
| shadowHueInteger, Optional | Color hue angle in degrees for shadows. Range: 0 to 360. | 210 |
| highlightHueInteger, Optional | Color hue angle in degrees for highlights. Range: 0 to 360. | 35 |
| toneStrengthSingle, Optional | Overall color toning intensity. Range: 0.0 to 1.0. | 0.4F |
| tonalBalanceInteger, Optional | Balance shift between shadow and highlight tints. Range: -100 to 100. | 0 |
Boolean — True if the Split Toning filter was applied; otherwise False.
success = Action.SplitToning(210, 35, 0.4F, 0)
Extracts the average value of the selected color channel.
result = Action.AverageColorValue(analysisTargetChannelType)
| Parameter | Description | Default |
|---|---|---|
| analysisTargetChannelTypeInteger, Optional | Integer representing the target channel. Supported analysisTargetChannelType values: 0: RGB Red 1: RGB Green 2: RGB Blue 3: Hue 4: Saturation 5: Intensity 6: CMYK Cyan 7: CMYK Magenta 8: CMYK Yellow 9: CMYK Key (Black) 10: Lab L 11: Lab a 12: Lab b 13: rg chromaticity r 14: rg chromaticity g 15: rg chromaticity b | 0 |
String — String containing the extracted value, or an empty string if extraction fails.
average = Action.AverageColorValue(0)
Exports individual regions identified by a binary mask image.
result = Action.CropExportRegions(maskSourceLocation, connectivityType, marginPixels, outputModeType, transparentBackground, backgroundColorRed, backgroundColorGreen, backgroundColorBlue, destinationFolder, filePrefix, imageFormatType)
| Parameter | Description | Default |
|---|---|---|
| maskSourceLocationInteger, Optional | Mask image source buffer index. | 1 |
| connectivityTypeInteger, Optional | Integer representing the connected-component connectivity. Supported connectivityType values: 0: FourWay (4-connected) 1: EightWay (8-connected) | 0 |
| marginPixelsInteger, Optional | Extra margin around each exported region. | 0 |
| outputModeTypeInteger, Optional | Integer representing the region export output mode. Supported outputModeType values: 0: ROI - rectangular region of interest 1: ExactShape - exact region shape 2: Binary - binary mask | 1 |
| transparentBackgroundBoolean, Optional | Whether exported backgrounds are transparent. | True |
| backgroundColorRedInteger, Optional | Background red component (0–255). | 0 |
| backgroundColorGreenInteger, Optional | Background green component (0–255). | 0 |
| backgroundColorBlueInteger, Optional | Background blue component (0–255). | 0 |
| destinationFolderString, Optional | Directory for exported region files. | "C:\\ExportedRegions" |
| filePrefixString, Optional | Prefix for exported file names. | "Region\_" |
| imageFormatTypeInteger, Optional | Integer representing the export image format. Supported imageFormatType values: 0: PNG 1: JPEG 2: BMP | 0 |
Boolean — True if region export succeeded; otherwise False.
success = Action.CropExportRegions(1, 0, 0, 1, True, 0, 0, 0, "C:\\ExportedRegions", "Region\_", 0)
Analyzes cells in a grid and extracts per-cell statistics.
result = Action.MultiCellAnalysis(gridColumnsX, gridRowsY, cellShapeType, cellDiameterPixels, analysisModeType, analysisTargetChannelType, targetColorPresetName)
| Parameter | Description | Default |
|---|---|---|
| gridColumnsXInteger, Optional | Number of grid columns. | 5 |
| gridRowsYInteger, Optional | Number of grid rows. | 5 |
| cellShapeTypeInteger, Optional | Integer representing the cell shape. Supported cellShapeType values: 0: Rectangle 1: Circle 2: Point | 1 |
| cellDiameterPixelsInteger, Optional | Cell diameter in pixels. | 20 |
| analysisModeTypeInteger, Optional | Integer representing the analysis mode. Supported analysisModeType values: 0: AverageColorValue 1: PixelCount | 0 |
| analysisTargetChannelTypeInteger, Optional | Integer representing the target channel. Supported analysisTargetChannelType values: 0: RGB Red 1: RGB Green 2: RGB Blue 3: Hue 4: Saturation 5: Intensity 6: CMYK Cyan 7: CMYK Magenta 8: CMYK Yellow 9: CMYK Key (Black) 10: Lab L 11: Lab a 12: Lab b 13: rg chromaticity r 14: rg chromaticity g 15: rg chromaticity b | 0 |
| targetColorPresetNameString, Optional | Target color preset name. | "White" |
String — String containing analysis data, or an empty string if analysis fails.
data = Action.MultiCellAnalysis(5, 5, 1, 20, 0, 0, "White")
Extracts text from the workspace image using OCR.
result = Action.OCRTextExtraction()
String — Extracted text, an empty string when no text is found, or an error message.
text = Action.OCRTextExtraction()
Counts pixels matching the specified RGB color.
result = Action.PixelCounter(targetColorRed, targetColorGreen, targetColorBlue, resultOutputFormatType)
| Parameter | Description | Default |
|---|---|---|
| targetColorRedInteger, Optional | Target color red component (0–255). | 255 |
| targetColorGreenInteger, Optional | Target color green component (0–255). | 255 |
| targetColorBlueInteger, Optional | Target color blue component (0–255). | 255 |
| resultOutputFormatTypeInteger, Optional | Integer representing the result output format. Supported resultOutputFormatType values: 0: TotalCount 1: Percentage | 0 |
String — String containing the count results, or an empty string if extraction fails.
counts = Action.PixelCounter(255, 255, 255, 0)
Adds a binary image mask to the current selection using logical OR.
result = Action.AddSelectionFromBinaryImage(sourceImageLocation)
| Parameter | Description | Default |
|---|---|---|
| sourceImageLocationInteger, Optional | Source buffer index from 1 to 10. | 1 |
Boolean — True if the selection was updated; otherwise False.
success = Action.AddSelectionFromBinaryImage(1)
Copies the current image to the clipboard.
result = Action.Copy()
Boolean — True if the image was copied; otherwise False.
success = Action.Copy()
Creates a selection mask from a binary workspace or buffer image.
result = Action.CreateSelectionFromBinaryImage(sourceImageLocation)
| Parameter | Description | Default |
|---|---|---|
| sourceImageLocationInteger, Optional | 0 selects the workspace; 1–10 selects a buffer. | 0 |
Boolean — True if the selection was created; otherwise False.
success = Action.CreateSelectionFromBinaryImage(1)
Expands the current selection by a specified number of pixels.
result = Action.ExpandSelection(expandByPixels)
| Parameter | Description | Default |
|---|---|---|
| expandByPixelsInteger, Optional | Expansion distance in pixels. | 5 |
Boolean — True if the selection changed; otherwise False.
success = Action.ExpandSelection(8)
Loads an image from an image-buffer location into the workspace.
result = Action.GetFromImageBuffer(sourceLocation)
| Parameter | Description | Default |
|---|---|---|
| sourceLocationInteger, Optional | Source buffer index from 1 to 10. | 1 |
Boolean — True if the image was loaded; otherwise False.
success = Action.GetFromImageBuffer(1)
Pastes an image from the clipboard into the workspace.
result = Action.Paste()
Boolean — True if an image was pasted; otherwise False.
success = Action.Paste()
Pastes an image from the clipboard and fits it to the current rectangle.
result = Action.PasteAndFitToRectangle()
Boolean — True if an image was pasted; otherwise False.
success = Action.PasteAndFitToRectangle()
Exports the current selection mask as a binary image to a buffer.
result = Action.PasteSelectionAsBinaryToBuffer(targetBufferIndex)
| Parameter | Description | Default |
|---|---|---|
| targetBufferIndexInteger, Optional | Target buffer index from 1 to 10. | 1 |
Boolean — True if the mask was written; otherwise False.
success = Action.PasteSelectionAsBinaryToBuffer(1)
Copies the current image to an image-buffer location.
result = Action.PutToImageBuffer(targetLocation)
| Parameter | Description | Default |
|---|---|---|
| targetLocationInteger, Optional | Target buffer index from 1 to 10. | 1 |
Boolean — True if the image was stored; otherwise False.
success = Action.PutToImageBuffer(1)
Inverts the current selection mask.
result = Action.ReverseSelection()
Boolean — True if the selection was reversed; otherwise False.
success = Action.ReverseSelection()
Shrinks the current selection by a specified number of pixels.
result = Action.ShrinkSelection(shrinkByPixels)
| Parameter | Description | Default |
|---|---|---|
| shrinkByPixelsInteger, Optional | Shrink distance in pixels. | 5 |
Boolean — True if the selection changed; otherwise False.
success = Action.ShrinkSelection(3)
Subtracts a binary image mask from the current selection using logical AND NOT.
result = Action.SubtractSelectionFromBinaryImage(sourceImageLocation)
| Parameter | Description | Default |
|---|---|---|
| sourceImageLocationInteger, Optional | Source buffer index from 1 to 10. | 1 |
Boolean — True if the selection was updated; otherwise False.
success = Action.SubtractSelectionFromBinaryImage(1)
Clears the current selection.
result = Action.Unselect()
Boolean — True if the selection was cleared; otherwise False.
success = Action.Unselect()
Acquires an image from a scanner.
result = Action.AcquireImagefromScanner(useSilentMode)
| Parameter | Description | Default |
|---|---|---|
| useSilentModeBoolean, Optional | Whether to acquire without showing the scanner UI. | True |
Boolean — True if acquisition succeeded; otherwise False.
success = Action.AcquireImagefromScanner(True)
Captures an image from a connected camera or scanner.
result = Action.Capture()
Boolean — True if capture succeeded; otherwise False.
success = Action.Capture()
Sharpens the image using the advanced sharpening filter.
result = Action.AdvancedSharpening(sharpenAmountPercentage)
| Parameter | Description | Default |
|---|---|---|
| sharpenAmountPercentageInteger, Optional | Sharpening amount percentage. | 100 |
Boolean — True if sharpening was applied; otherwise False.
success = Action.AdvancedSharpening(125)
Smooths the image using a box-averaging filter.
result = Action.BoxAveraging(kernelSize)
| Parameter | Description | Default |
|---|---|---|
| kernelSizeInteger, Optional | Averaging kernel width and height in pixels. | 3 |
Boolean — True if the filter was applied; otherwise False.
success = Action.BoxAveraging(5)
Overlays an image while making the selected chroma-key color transparent.
result = Action.ChromaKeyOverlay(sourceLocation1, targetColorRed, targetColorGreen, targetColorBlue, sourceLocation2, opacity, enableFeathering, featheringRadius, tolerance, softness)
| Parameter | Description | Default |
|---|---|---|
| sourceLocation1Integer, Optional | Foreground image source (0 for workspace, 1–10 for buffers). | 1 |
| targetColorRedInteger, Optional | Red component of the chroma-key color (0–255). | 0 |
| targetColorGreenInteger, Optional | Green component of the chroma-key color (0–255). | 0 |
| targetColorBlueInteger, Optional | Blue component of the chroma-key color (0–255). | 0 |
| sourceLocation2Integer, Optional | Background image source (0 for workspace, 1–10 for buffers). | 0 |
| opacityInteger, Optional | Overlay opacity percentage (0–100). | 100 |
| enableFeatheringBoolean, Optional | Whether to soften the keyed edge. | False |
| featheringRadiusInteger, Optional | Edge feathering radius in pixels. | 30 |
| toleranceInteger, Optional | Color matching tolerance range (0–100). | 35 |
| softnessInteger, Optional | Edge gradient softness range (0–100). | 20 |
Boolean — True if the overlay was applied; otherwise False.
success = Action.ChromaKeyOverlay(1, 0, 255, 0, 0, 100, False, 30, 35, 20)
Crops a rectangular area from the image.
result = Action.Crop(cropWidthPixels, cropHeightPixels, startXCoordinate, startYCoordinate)
| Parameter | Description | Default |
|---|---|---|
| cropWidthPixelsInteger, Optional | Crop width in pixels. | 500 |
| cropHeightPixelsInteger, Optional | Crop height in pixels. | 500 |
| startXCoordinateInteger, Optional | Left coordinate of the crop in pixels. | 0 |
| startYCoordinateInteger, Optional | Top coordinate of the crop in pixels. | 0 |
Boolean — True if cropping was applied; otherwise False.
success = Action.Crop(500, 500, 0, 0)
Removes atmospheric haze, fog, and chamber glare to restore crisp contrast and vivid colors using a high-speed O(1) Dark Channel Prior algorithm.
result = Action.Dehaze(patchRadius, dehazeStrength, saturationBoost, brightnessBoost)
| Parameter | Description | Default |
|---|---|---|
| patchRadiusInteger, Optional | Local patch radius in pixels for haze estimation. Range: 1 to 150. | 25 |
| dehazeStrengthSingle, Optional | Haze removal intensity. Range: 0.0 to 1.0. | 0.7F |
| saturationBoostSingle, Optional | Color saturation boost after haze removal. Range: -1.0 to 1.0. | 0.15F |
| brightnessBoostInteger, Optional | Additional brightness compensation. Range: -100 to 100. | 10 |
Boolean — True if the Dehaze filter was applied; otherwise False.
success = Action.Dehaze(25, 0.7F, 0.15F, 10)
Applies a dithering algorithm to reduce image color depth.
result = Action.Dithering(ditheringAlgorithmType)
| Parameter | Description | Default |
|---|---|---|
| ditheringAlgorithmTypeInteger, Optional | Integer representing the dithering algorithm. Supported ditheringAlgorithmType values: 0: Ordered 1: FloydSteinberg | 0 |
Boolean — True if dithering was applied; otherwise False.
success = Action.Dithering(0)
Creates an embossed relief effect.
result = Action.Emboss(angle, distance, strength, bias)
| Parameter | Description | Default |
|---|---|---|
| angleSingle, Optional | Light-source angle in degrees. | 135.0F |
| distanceInteger, Optional | Relief offset in pixels. | 1 |
| strengthInteger, Optional | Effect strength percentage. | 100 |
| biasInteger, Optional | Output intensity bias. | 128 |
Boolean — True if the effect was applied; otherwise False.
success = Action.Emboss(135.0F, 1, 100, 128)
Transforms the image into the frequency domain using FFT.
result = Action.FFT()
Boolean — True if the transform was applied; otherwise False.
success = Action.FFT()
Flips the image horizontally.
result = Action.FlipHorizontally()
Boolean — True if the image was transformed; otherwise False.
success = Action.FlipHorizontally()
Flips the image vertically.
result = Action.FlipVertically()
Boolean — True if the image was transformed; otherwise False.
success = Action.FlipVertically()
Adjusts image brightness using gamma correction.
result = Action.GammaAdjustment(gammaValue)
| Parameter | Description | Default |
|---|---|---|
| gammaValueDouble, Optional | Gamma correction value. | 0.1 |
Boolean — True if the adjustment was applied; otherwise False.
success = Action.GammaAdjustment(0.8)
Blurs the image using a Gaussian filter.
result = Action.GaussianFilter(kernelSize)
| Parameter | Description | Default |
|---|---|---|
| kernelSizeInteger, Optional | Gaussian kernel width and height in pixels. | 3 |
Boolean — True if the filter was applied; otherwise False.
success = Action.GaussianFilter(5)
Enhances local contrast and compresses dynamic range (shadow/highlight recovery) using a high-speed O(1) Stack Blur algorithm.
result = Action.HDRLocalToneMapping(blurRadius, detailStrength, toneCompression, brightnessBoost)
| Parameter | Description | Default |
|---|---|---|
| blurRadiusInteger, Optional | Local neighborhood radius in pixels. Range: 1 to 150. | 40 |
| detailStrengthSingle, Optional | Clarity and fine-detail amplification strength. Range: 0.0 to 3.0. | 1.2F |
| toneCompressionSingle, Optional | Shadow/highlight dynamic range compression strength. Range: 0.0 to 1.0. | 0.5F |
| brightnessBoostInteger, Optional | Additional brightness boost applied to the final pixels. Range: -100 to 100. | 0 |
Boolean — True if the HDR Local Tone Mapping filter was applied; otherwise False.
success = Action.HDRLocalToneMapping(40, 1.2F, 0.5F, 0)
Applies selective optical highlight bloom and analog cinema film halation to bright light sources using a high-speed O(1) Stack Blur engine.
result = Action.HighlightBloomHalation(spreadRadius, threshold, bloomStrength, halationTint)
| Parameter | Description | Default |
|---|---|---|
| spreadRadiusInteger, Optional | Diffusion radius in pixels. Range: 1 to 150. | 25 |
| thresholdInteger, Optional | Luminance threshold for isolating bright highlights. Range: 0 to 250. | 180 |
| bloomStrengthSingle, Optional | Intensity of the highlight bloom glow. Range: 0.0 to 2.0. | 0.8F |
| halationTintSingle, Optional | Red-orange cinema film halation tint ratio (0.0 for pure optical bloom, 1.0 for full film halation). Range: 0.0 to 1.0. | 0.0F |
Boolean — True if the Highlight Bloom & Halation filter was applied; otherwise False.
success = Action.HighlightBloomHalation(25, 180, 0.8F, 0.35F)
Sharpens multi-scale structural edges and surface textures using a high-speed O(1) High-Pass frequency extraction algorithm.
result = Action.HighPassSharpening(radius, strength, threshold, blendMode)
| Parameter | Description | Default |
|---|---|---|
| radiusInteger, Optional | Frequency radius in pixels. Range: 1 to 100. | 10 |
| strengthSingle, Optional | High-frequency detail amplification strength. Range: 0.0 to 2.0. | 1.0F |
| thresholdInteger, Optional | Noise suppression threshold in pixel levels. Range: 0 to 50. | 3 |
| blendModeInteger, Optional | Integer representing the blending algorithm. Supported blendMode values: 0: Overlay (Balanced) 1: SoftLight (Subtle) 2: HardLight (Intense) | 0 |
Boolean — True if the High-Pass Sharpening filter was applied; otherwise False.
success = Action.HighPassSharpening(10, 1.0F, 3, 0)
Places and transforms a buffer image stamp over the current image.
result = Action.ImageStamp(stampImageSource, locationX, locationY, scaleX, scaleY, angle, opacity, enableTransparentColor, transparentColorArgb, enableGradualAlpha, tolerance, enableFeather, featherRadius)
| Parameter | Description | Default |
|---|---|---|
| stampImageSourceInteger, Optional | Stamp image source buffer index. | 1 |
| locationXInteger, Optional | Stamp left coordinate in pixels. | 0 |
| locationYInteger, Optional | Stamp top coordinate in pixels. | 0 |
| scaleXInteger, Optional | Horizontal scale percentage. | 100 |
| scaleYInteger, Optional | Vertical scale percentage. | 100 |
| angleSingle, Optional | Rotation angle in degrees. | 0.0F |
| opacityInteger, Optional | Stamp opacity percentage. | 100 |
| enableTransparentColorBoolean, Optional | Whether to make a selected color transparent. | False |
| transparentColorArgbInteger, Optional | ARGB value of the transparent color. | -1 |
| enableGradualAlphaBoolean, Optional | Whether to apply gradual alpha blending. | False |
| toleranceInteger, Optional | Transparent-color matching tolerance. | 30 |
| enableFeatherBoolean, Optional | Whether to feather stamp edges. | False |
| featherRadiusInteger, Optional | Feathering radius in pixels. | 10 |
Boolean — True if the stamp was applied; otherwise False.
success = Action.ImageStamp(1, 0, 0, 100, 100, 0.0F, 100, False, -1, False, 30, False, 10)
Reconstructs a spatial image from frequency-domain data using inverse FFT.
result = Action.InverseFFT()
Boolean — True if the inverse transform was applied; otherwise False.
success = Action.InverseFFT()
Simulates a tilt-shift miniature lens effect with smooth depth-of-field blurring and saturation enhancement.
result = Action.MiniatureEffect(blurRadius, focusPosition, focusSize, saturationBoost)
| Parameter | Description | Default |
|---|---|---|
| blurRadiusInteger, Optional | Out-of-focus blur radius in pixels. Range: 1 to 150. | 25 |
| focusPositionSingle, Optional | Vertical center position of the sharp focus zone (0.0 = top, 0.5 = center, 1.0 = bottom). Range: 0.0 to 1.0. | 0.5F |
| focusSizeSingle, Optional | Relative height of the sharp focus band. Range: 0.05 to 0.80. | 0.25F |
| saturationBoostSingle, Optional | Color vibrancy boost for a miniature model look. Range: -1.0 to 1.0. | 0.25F |
Boolean — True if the Miniature Effect filter was applied; otherwise False.
success = Action.MiniatureEffect(25, 0.5F, 0.25F, 0.25F)
Applies a mosaic or pixelation effect.
result = Action.MosaicFilter(mosaicModeType, value)
| Parameter | Description | Default |
|---|---|---|
| mosaicModeTypeInteger, Optional | Integer representing the mosaic mode. Supported mosaicModeType values: 0: PixelSize - value is the block size in pixels 1: GridCount - value is the number of grid cells | 0 |
| valueInteger, Optional | Mosaic block size or mode-specific amount. | 10 |
Boolean — True if the effect was applied; otherwise False.
success = Action.MosaicFilter(0, 10)
Applies a dreamy, painterly luminescence (Orton Effect) by combining overexposed sharp and blurred layers via Multiply blending.
result = Action.OrtonEffect(blurRadius, glowStrength, exposureBoost, brightnessBoost)
| Parameter | Description | Default |
|---|---|---|
| blurRadiusInteger, Optional | Blur radius for the glow diffusion in pixels. Range: 1 to 150. | 25 |
| glowStrengthSingle, Optional | Overall blending opacity of the Orton effect. Range: 0.0 to 1.0. | 0.6F |
| exposureBoostSingle, Optional | Highlight overexposure boost in the Screen pass. Range: 0.0 to 1.0. | 0.7F |
| brightnessBoostInteger, Optional | Additional brightness boost applied to the final pixels. Range: -100 to 100. | 0 |
Boolean — True if the Orton Effect filter was applied; otherwise False.
success = Action.OrtonEffect(25, 0.6F, 0.7F, 0)
Overlays two workspace or buffer images with opacity, blending, and feathering options.
result = Action.OverlayImage(sourceLocation1, sourceLocation2, targetColorRed, targetColorGreen, targetColorBlue, opacity, enableFeathering, featheringRadius, tolerance, gradientAlpha)
| Parameter | Description | Default |
|---|---|---|
| sourceLocation1Integer, Optional | First image source (0 for workspace, 1–10 for buffers). | 1 |
| sourceLocation2Integer, Optional | Second image source (0 for workspace, 1–10 for buffers). | 0 |
| targetColorRedInteger, Optional | Red component of the target color (0–255). | 0 |
| targetColorGreenInteger, Optional | Green component of the target color (0–255). | 0 |
| targetColorBlueInteger, Optional | Blue component of the target color (0–255). | 0 |
| opacityInteger, Optional | Overlay opacity percentage. | 100 |
| enableFeatheringBoolean, Optional | Whether to feather the overlay edge. | False |
| featheringRadiusInteger, Optional | Feathering radius in pixels. | 30 |
| toleranceInteger, Optional | Color matching tolerance. | 0 |
| gradientAlphaBoolean, Optional | Whether to apply gradual alpha blending. | False |
Boolean — True if the overlay was applied; otherwise False.
success = Action.OverlayImage(1, 0, 0, 0, 0, 100, False, 30, 0, False)
Resizes the image to the requested dimensions using the selected interpolation.
result = Action.Resize(resizeUnitType, maintainAspectRatio, baseDimensionType, targetWidth, targetHeight, interpolationAlgorithmType)
| Parameter | Description | Default |
|---|---|---|
| resizeUnitTypeInteger, Optional | Integer representing the resize units. Supported resizeUnitType values: 0: Pixels 1: Percent | 0 |
| maintainAspectRatioBoolean, Optional | Whether to preserve the image aspect ratio. | True |
| baseDimensionTypeInteger, Optional | Integer representing the dimension basis. Supported baseDimensionType values: 0: Width 1: Height | 0 |
| targetWidthInteger, Optional | Requested width. | 800 |
| targetHeightInteger, Optional | Requested height. | 600 |
| interpolationAlgorithmTypeInteger, Optional | Integer representing the interpolation algorithm. Supported interpolationAlgorithmType values: 0: NearestNeighbor 1: Bilinear 2: Bicubic 3: HighQualityBilinear 4: HighQualityBicubic | 4 |
Boolean — True if the image was resized; otherwise False.
success = Action.Resize(0, True, 0, 800, 600, 4)
Resizes the canvas around the image with alignment and fill-color options.
result = Action.ResizeCanvas(resizeUnitType, maintainAspectRatio, baseDimensionType, targetWidth, targetHeight, canvasAlignmentType, backgroundColorRed, backgroundColorGreen, backgroundColorBlue)
| Parameter | Description | Default |
|---|---|---|
| resizeUnitTypeInteger, Optional | Integer representing the resize units. Supported resizeUnitType values: 0: Pixels 1: Percent | 0 |
| maintainAspectRatioBoolean, Optional | Whether to preserve the image aspect ratio. | True |
| baseDimensionTypeInteger, Optional | Integer representing the dimension basis. Supported baseDimensionType values: 0: Width 1: Height | 0 |
| targetWidthInteger, Optional | Requested canvas width. | 800 |
| targetHeightInteger, Optional | Requested canvas height. | 600 |
| canvasAlignmentTypeInteger, Optional | Integer representing the image alignment. Supported canvasAlignmentType values: 0: Center 1: LeftTop 2: RightTop 3: LeftBottom 4: RightBottom | 0 |
| backgroundColorRedInteger, Optional | Red component of the canvas fill color (0–255). | 255 |
| backgroundColorGreenInteger, Optional | Green component of the canvas fill color (0–255). | 255 |
| backgroundColorBlueInteger, Optional | Blue component of the canvas fill color (0–255). | 255 |
Boolean — True if the canvas was resized; otherwise False.
success = Action.ResizeCanvas(0, True, 0, 800, 600, 0, 255, 255, 255)
Rotates the image by the requested angle and fills uncovered areas.
result = Action.Rotate(rotationAngleDegrees, rotationDirectionType, backgroundColorRed, backgroundColorGreen, backgroundColorBlue)
| Parameter | Description | Default |
|---|---|---|
| rotationAngleDegreesSingle, Optional | Rotation angle in degrees. | 90.0F |
| rotationDirectionTypeInteger, Optional | Integer representing the rotation direction. Supported rotationDirectionType values: 0: CounterClockwise 1: Clockwise | 1 |
| backgroundColorRedInteger, Optional | Red component of the fill color (0–255). | 255 |
| backgroundColorGreenInteger, Optional | Green component of the fill color (0–255). | 255 |
| backgroundColorBlueInteger, Optional | Blue component of the fill color (0–255). | 255 |
Boolean — True if rotation was applied; otherwise False.
success = Action.Rotate(90.0F, 1, 255, 255, 255)
Rotates the image to align it with a detected line.
result = Action.RotationalAlignmentByLine(backgroundColorRed, backgroundColorGreen, backgroundColorBlue)
| Parameter | Description | Default |
|---|---|---|
| backgroundColorRedInteger, Optional | Red component of the fill color (0–255). | 255 |
| backgroundColorGreenInteger, Optional | Green component of the fill color (0–255). | 255 |
| backgroundColorBlueInteger, Optional | Blue component of the fill color (0–255). | 255 |
Boolean — True if alignment was applied; otherwise False.
success = Action.RotationalAlignmentByLine(255, 255, 255)
Sharpens image details using a 3×3 convolution filter.
result = Action.Sharpen3x3()
Boolean — True if sharpening was applied; otherwise False.
success = Action.Sharpen3x3()
Sharpens the image using a high-quality 5×5 filter.
result = Action.Sharpen5x5HighQuality(sharpenStrengthPercentage)
| Parameter | Description | Default |
|---|---|---|
| sharpenStrengthPercentageInteger, Optional | Sharpening strength percentage. | 10 |
Boolean — True if sharpening was applied; otherwise False.
success = Action.Sharpen5x5HighQuality(20)
Reduces image noise while preserving edges.
result = Action.SmartDenoise(radius, threshold)
| Parameter | Description | Default |
|---|---|---|
| radiusInteger, Optional | Denoising neighborhood radius. | 5 |
| thresholdInteger, Optional | Noise similarity threshold. | 30 |
Boolean — True if denoising was applied; otherwise False.
success = Action.SmartDenoise(5, 30)
Converts the image into a fine pencil sketch or colored-pencil technical line art using a high-speed O(1) Color Dodge algorithm.
result = Action.SmartSketch(strokeWidth, pencilDarkness, colorBlend, paperBrightness)
| Parameter | Description | Default |
|---|---|---|
| strokeWidthInteger, Optional | Stroke width (blur radius) in pixels. Range: 1 to 100. | 15 |
| pencilDarknessSingle, Optional | Graphite line darkness and shading intensity. Range: 0.01 to 1.0. | 0.5F |
| colorBlendSingle, Optional | Original color blending ratio (0.0 for pure grayscale sketch, up to 1.0 for colored-pencil look). Range: 0.0 to 1.0. | 0.0F |
| paperBrightnessInteger, Optional | Background paper brightness adjustment. Range: -100 to 100. | 0 |
Boolean — True if the Smart Sketch filter was applied; otherwise False.
success = Action.SmartSketch(15, 0.5F, 0.0F, 0)
Applies a dreamy, radiant luminescence effect using a high-speed O(1) Stack Blur and Screen/SoftLight blending.
result = Action.SoftGlow(blurRadius, glowStrength, brightnessBoost, blendMode)
| Parameter | Description | Default |
|---|---|---|
| blurRadiusInteger, Optional | Blur radius for the glow diffusion in pixels. Range: 1 to 150. | 20 |
| glowStrengthSingle, Optional | Blending strength (opacity) of the glow layer. Range: 0.0 to 1.0. | 0.45F |
| brightnessBoostInteger, Optional | Additional brightness boost applied to the final blended pixels. Range: -100 to 100. | 5 |
| blendModeInteger, Optional | Integer representing the blending algorithm used to combine the glow layer with the base image. Supported blendMode values: 0: Screen (Bright & Airy) 1: SoftLight (Gentle Contrast) | 0 |
Boolean — True if the Soft Glow filter was applied; otherwise False.
success = Action.SoftGlow(20, 0.45F, 5, 0)
Blurs the image using a high-speed Stack Blur algorithm.
result = Action.StackBlur(kernelSize)
| Parameter | Description | Default |
|---|---|---|
| kernelSizeInteger, Optional | Blur radius (half size of the kernel) in pixels. Range: 1 to 100. | 3 |
Boolean — True if the filter was applied; otherwise False.
success = Action.StackBlur(5)
Adds a styled text annotation or watermark to the image.
result = Action.TextAnnotation(textString, locationX, locationY, fontName, fontSize, fontStyleInt, innerColorArgb, outerColorArgb, opacity, outlineThickness, angle, isAntiAlias)
| Parameter | Description | Default |
|---|---|---|
| textStringString, Optional | Text to draw. | "Text" |
| locationXInteger, Optional | Text left coordinate in pixels. | 0 |
| locationYInteger, Optional | Text top coordinate in pixels. | 0 |
| fontNameString, Optional | Font family name. | "Arial" |
| fontSizeSingle, Optional | Font size in points. | 12.0F |
| fontStyleIntInteger, Optional | Integer representing the font style. Supported fontStyleInt values: 0: Regular 1: Bold 2: Italic 3: Bold Italic 4: Underline 8: Strikeout | 0 |
| innerColorArgbInteger, Optional | ARGB value of the text fill color. | -256 |
| outerColorArgbInteger, Optional | ARGB value of the outline color. | -16777216 |
| opacityInteger, Optional | Text opacity percentage. | 100 |
| outlineThicknessSingle, Optional | Outline thickness in pixels. | 1.0F |
| angleSingle, Optional | Text rotation angle in degrees. | 0.0F |
| isAntiAliasBoolean, Optional | Whether to antialias the text. | True |
Boolean — True if the annotation was drawn; otherwise False.
success = Action.TextAnnotation("Sample", 20, 20, "Arial", 12.0F, 0, -256, -16777216, 100, 1.0F, 0.0F, True)
Automatically selects the main subject in a general image.
result = Action.AIAutoSubjectSelectionGeneral()
Boolean — True if subject selection succeeded; otherwise False.
success = Action.AIAutoSubjectSelectionGeneral()
Automatically selects the subject in a portrait image.
result = Action.AIAutoSubjectSelectionPortrait()
Boolean — True if subject selection succeeded; otherwise False.
success = Action.AIAutoSubjectSelectionPortrait()
Removes the background from a general image and fills it with a color.
result = Action.AIBackgroundRemovalGeneral(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue)
| Parameter | Description | Default |
|---|---|---|
| virtualBackgroundColorRedInteger, Optional | Replacement background red component (0–255). | 255 |
| virtualBackgroundColorGreenInteger, Optional | Replacement background green component (0–255). | 255 |
| virtualBackgroundColorBlueInteger, Optional | Replacement background blue component (0–255). | 255 |
Boolean — True if background removal succeeded; otherwise False.
success = Action.AIBackgroundRemovalGeneral(255, 255, 255)
Removes the background from a portrait image and fills it with a color.
result = Action.AIBackgroundRemovalPortrait(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue)
| Parameter | Description | Default |
|---|---|---|
| virtualBackgroundColorRedInteger, Optional | Replacement background red component (0–255). | 255 |
| virtualBackgroundColorGreenInteger, Optional | Replacement background green component (0–255). | 255 |
| virtualBackgroundColorBlueInteger, Optional | Replacement background blue component (0–255). | 255 |
Boolean — True if background removal succeeded; otherwise False.
success = Action.AIBackgroundRemovalPortrait(255, 255, 255)
Removes the background from a selfie and fills it with a color.
result = Action.AIBackgroundRemovalSelfie(virtualBackgroundColorRed, virtualBackgroundColorGreen, virtualBackgroundColorBlue)
| Parameter | Description | Default |
|---|---|---|
| virtualBackgroundColorRedInteger, Optional | Replacement background red component (0–255). | 255 |
| virtualBackgroundColorGreenInteger, Optional | Replacement background green component (0–255). | 255 |
| virtualBackgroundColorBlueInteger, Optional | Replacement background blue component (0–255). | 255 |
Boolean — True if background removal succeeded; otherwise False.
success = Action.AIBackgroundRemovalSelfie(255, 255, 255)
Segments cells or nuclei in an image and binarizes them using the StarDist AI model.
result = Action.AIBinarizationSegmentation()
Boolean — True if StarDist segmentation and binarization succeeded; otherwise False.
success = Action.AIBinarizationSegmentationStarDist()
Binarizes the image using a selected custom ONNX model.
result = Action.AICustomBinarization(targetModelName)
| Parameter | Description | Default |
|---|---|---|
| targetModelNameString, Optional | Model name to use; an empty string selects the default model. | "" |
Boolean — True if binarization succeeded; otherwise False.
success = Action.AICustomBinarization("")
Estimates an image depth map using an AI model.
result = Action.AIDepthEstimation(autoResizeLargeImages)
| Parameter | Description | Default |
|---|---|---|
| autoResizeLargeImagesBoolean, Optional | Whether to resize large images before inference. | True |
Boolean — True if depth estimation succeeded; otherwise False.
success = Action.AIDepthEstimation(True)
Straightens and unwarps a perspective-distorted document image.
result = Action.AIDocumentUnwarping()
Boolean — True if document unwarping succeeded; otherwise False.
success = Action.AIDocumentUnwarping()
Detects faces and 6-point landmarks using an AI model, and optionally applies an ROI selection mask, draws visual overlays, or exports a CSV.
result = Action.AIFaceDetection(confidenceThreshold, nmsThreshold, enableTiling, useRotatedEllipse, applyToMask, drawBoundingBoxes, showFaceID, showConfidence, showKeypoints, boxColorRed, boxColorGreen, boxColorBlue, exportCSV, csvExportDirectory)
| Parameter | Description | Default |
|---|---|---|
| confidenceThresholdSingle, Optional | Minimum face detection confidence (0.0–1.0). | 0.45F |
| nmsThresholdSingle, Optional | Non-maximum suppression threshold (0.0–1.0). | 0.4F |
| enableTilingBoolean, Optional | Whether to process the image in multi-scale tiles for high-res/group photos. | True |
| useRotatedEllipseBoolean, Optional | True to use eye-aligned rotated ellipses; False for rectangles. | True |
| applyToMaskBoolean, Optional | True to convert detected faces into an active workspace selection mask (AdvSel) for subsequent filtering/blurring. | False |
| drawBoundingBoxesBoolean, Optional | Whether to draw the bounding ROI shape (ellipse or rectangle). | True |
| showFaceIDBoolean, Optional | Whether to display the sequential face ID (#1, #2...). | True |
| showConfidenceBoolean, Optional | Whether to display confidence scores. | False |
| showKeypointsBoolean, Optional | Whether to draw the 6 facial landmarks. | True |
| boxColorRedInteger, Optional | Bounding-box red component (0–255). | 255 |
| boxColorGreenInteger, Optional | Bounding-box green component (0–255). | 0 |
| boxColorBlueInteger, Optional | Bounding-box blue component (0–255). | 0 |
| exportCSVBoolean, Optional | Whether to export face ROI and 6-keypoint coordinates as CSV. | False |
| csvExportDirectoryString, Optional | Directory for CSV output; empty uses the source image folder. | "" |
Boolean — True if face detection completed; otherwise False.
success = Action.AIFaceDetection(0.45F, 0.4F, True, True, False, True, True, False, True, 255, 0, 0, False, "")
Restores a low-quality image using the fast AI model.
result = Action.AIImageQualityRestorationFast(restorationBoostFactor)
| Parameter | Description | Default |
|---|---|---|
| restorationBoostFactorSingle, Optional | Restoration boost factor. | 1.0F |
Boolean — True if restoration succeeded; otherwise False.
success = Action.AIImageQualityRestorationFast(1.0F)
Restores a low-quality image using the fastest AI preview model.
result = Action.AIImageQualityRestorationFastest()
Boolean — True if restoration succeeded; otherwise False.
success = Action.AIImageQualityRestorationFastest()
Restores a low-quality image using the slower, more accurate AI model.
result = Action.AIImageQualityRestorationSlow()
Boolean — True if restoration succeeded; otherwise False.
success = Action.AIImageQualityRestorationSlow()
Restores a low-quality image using the highest-quality AI model.
result = Action.AIImageQualityRestorationSlowest()
Boolean — True if restoration succeeded; otherwise False.
success = Action.AIImageQualityRestorationSlowest()
Sharpens the image using AI enhancement.
result = Action.AIImageSharpening(sharpenBoostFactor)
| Parameter | Description | Default |
|---|---|---|
| sharpenBoostFactorSingle, Optional | AI sharpening boost factor. | 2.5F |
Boolean — True if sharpening succeeded; otherwise False.
success = Action.AIImageSharpening(2.5F)
Upscales the image using the fast RealESRGAN model variant.
result = Action.AIImageUpscaleRealESRFast()
Boolean — True if upscaling succeeded; otherwise False.
success = Action.AIImageUpscaleRealESRFast()
Upscales the image using the RealESRGAN AI model.
result = Action.AIImageUpscaleRealESRGAN(upscaleMagnificationType)
| Parameter | Description | Default |
|---|---|---|
| upscaleMagnificationTypeInteger, Optional | Integer representing the upscaling magnification. Supported upscaleMagnificationType values: 2: 2x 4: 4x 8: 8x | 4 |
Boolean — True if upscaling succeeded; otherwise False.
success = Action.AIImageUpscaleRealESRGAN(4)
Removes unwanted image content using AI inpainting.
result = Action.AIInpainting()
Boolean — True if inpainting succeeded; otherwise False.
success = Action.AIInpainting()
Removes motion blur and restores sharpness in an image using deep learning.
result = Action.AIMotionDeblur()
Boolean — True if motion deblurring succeeded; otherwise False.
success = Action.AIMotionDeblur()
Detects objects with YOLOv3 and optionally draws boxes or exports a CSV.
result = Action.AIObjectDetection(confidenceThreshold, nmsThreshold, enableTiling, targetClasses, drawBoundingBoxes, showConfidence, boxColorRed, boxColorGreen, boxColorBlue, exportCSV, csvExportDirectory)
| Parameter | Description | Default |
|---|---|---|
| confidenceThresholdSingle, Optional | Minimum detection confidence. | 0.5F |
| nmsThresholdSingle, Optional | Non-maximum suppression threshold. | 0.5F |
| enableTilingBoolean, Optional | Whether to process the image in tiles. | False |
| targetClassesString, Optional | Comma-separated target class names; empty selects all classes. | "" |
| drawBoundingBoxesBoolean, Optional | Whether to draw detected bounding boxes. | True |
| showConfidenceBoolean, Optional | Whether to show confidence values with boxes. | True |
| boxColorRedInteger, Optional | Bounding-box red component (0–255). | 255 |
| boxColorGreenInteger, Optional | Bounding-box green component (0–255). | 0 |
| boxColorBlueInteger, Optional | Bounding-box blue component (0–255). | 0 |
| exportCSVBoolean, Optional | Whether to export detection results as CSV. | False |
| csvExportDirectoryString, Optional | Directory for CSV output. | "" |
Boolean — True if detection completed; otherwise False.
success = Action.AIObjectDetection(0.5F, 0.4F, False, "", True, True, 255, 0, 0, False, "")
Restores details in an overexposed image using an AI model.
result = Action.AIOverExposureCorrection()
Boolean — True if correction succeeded; otherwise False.
success = Action.AIOverExposureCorrection()
Creates an intelligent selection using image content analysis.
result = Action.AISmartSelection()
Boolean — True if the selection was created; otherwise False.
success = Action.AISmartSelection()
Restores details in an underexposed image using an AI model.
result = Action.AIUnderExposureCorrection()
Boolean — True if correction succeeded; otherwise False.
success = Action.AIUnderExposureCorrection()
Applies adaptive thresholding to images with varying illumination.
result = Action.AdaptiveThresholding(adaptiveBoxSize, adaptiveThresholdLevel, isObjectColorAutomatic, manualObjectColorType)
| Parameter | Description | Default |
|---|---|---|
| adaptiveBoxSizeInteger, Optional | Box size used for local threshold calculation. | 80 |
| adaptiveThresholdLevelInteger, Optional | Threshold tuning level. | 86 |
| isObjectColorAutomaticBoolean, Optional | Whether to detect object color automatically. | True |
| manualObjectColorTypeInteger, Optional | Integer representing the manual object color. Supported manualObjectColorType values (used when automatic detection is disabled): 0: White 1: Black | 0 |
Boolean — True if thresholding succeeded; otherwise False.
success = Action.AdaptiveThresholding(100, 90, False, 1)
Performs a logical operation between two workspace or buffer images.
result = Action.BinaryOperation(logicalOperationType, firstImageSourceLocation, secondImageSourceLocation)
| Parameter | Description | Default |
|---|---|---|
| logicalOperationTypeInteger, Optional | Integer representing the binary logical operation. Supported logicalOperationType values: 0: AND 1: OR 2: XOR | 0 |
| firstImageSourceLocationInteger, Optional | First image source index. | 0 |
| secondImageSourceLocationInteger, Optional | Second image source index. | 1 |
Boolean — True if the operation succeeded; otherwise False.
success = Action.BinaryOperation(0, 0, 1)
Detects object boundaries using the selected overlay mode.
result = Action.BoundaryDetection(boundaryOverlayModeType)
| Parameter | Description | Default |
|---|---|---|
| boundaryOverlayModeTypeInteger, Optional | Integer representing the boundary overlay mode. Supported boundaryOverlayModeType values: 0: WithOverlay - draw boundaries over the original image 1: WithoutOverlay - draw boundaries only | 0 |
Boolean — True if boundary detection succeeded; otherwise False.
success = Action.BoundaryDetection(0)
Detects edges using the Canny algorithm.
result = Action.CannyEdge(cannyHighThreshold)
| Parameter | Description | Default |
|---|---|---|
| cannyHighThresholdInteger, Optional | High threshold used by the Canny detector. | 100 |
Boolean — True if detection succeeded; otherwise False.
success = Action.CannyEdge(100)
Converts every non-black pixel to white.
result = Action.ChangeNonBlackToWhite()
Boolean — True if conversion succeeded; otherwise False.
success = Action.ChangeNonBlackToWhite()
Computes the difference between two workspace or buffer images.
result = Action.DifferentialImage(firstImageSourceLocation, secondImageSourceLocation)
| Parameter | Description | Default |
|---|---|---|
| firstImageSourceLocationInteger, Optional | First image source index. | 0 |
| secondImageSourceLocationInteger, Optional | Second image source index. | 1 |
Boolean — True if the difference image was created; otherwise False.
success = Action.DifferentialImage(0, 1)
Applies morphological dilation to expand foreground objects.
result = Action.Dilate(morphologyKernelSize)
| Parameter | Description | Default |
|---|---|---|
| morphologyKernelSizeInteger, Optional | Morphological kernel size. | 3 |
Boolean — True if dilation was applied; otherwise False.
success = Action.Dilate(3)
Dilates traced outlines to make them thicker.
result = Action.DilateOutline()
Boolean — True if outlines were dilated; otherwise False.
success = Action.DilateOutline()
Draws a colored border around the selected region or ROIs.
result = Action.DrawSelectionBorder(borderColorRed, borderColorGreen, borderColorBlue, borderThicknessPixels, borderOpacityPercentage, applyToMultipleROIs)
| Parameter | Description | Default |
|---|---|---|
| borderColorRedInteger, Optional | Border red component (0–255). | 0 |
| borderColorGreenInteger, Optional | Border green component (0–255). | 0 |
| borderColorBlueInteger, Optional | Border blue component (0–255). | 0 |
| borderThicknessPixelsInteger, Optional | Border thickness in pixels. | 1 |
| borderOpacityPercentageInteger, Optional | Border opacity percentage. | 100 |
| applyToMultipleROIsBoolean, Optional | Whether to apply to multiple ROIs. | False |
Boolean — True if the border was drawn; otherwise False.
success = Action.DrawSelectionBorder(0, 0, 0, 1, 100, False)
Detects image edges using the selected algorithm.
result = Action.EdgeDetection(edgeDetectionAlgorithmType)
| Parameter | Description | Default |
|---|---|---|
| edgeDetectionAlgorithmTypeInteger, Optional | Integer representing the edge detection algorithm. Supported edgeDetectionAlgorithmType values: 0: Homogeneity 1: Sobel 2: LeftHand 3: UpperLeftHand | 0 |
Boolean — True if detection succeeded; otherwise False.
success = Action.EdgeDetection(0)
Applies morphological erosion to shrink foreground objects.
result = Action.Erode(morphologyKernelSize)
| Parameter | Description | Default |
|---|---|---|
| morphologyKernelSizeInteger, Optional | Morphological kernel size. | 3 |
Boolean — True if erosion was applied; otherwise False.
success = Action.Erode(3)
Erodes traced outlines to make them thinner.
result = Action.ErodeOutline()
Boolean — True if outlines were eroded; otherwise False.
success = Action.ErodeOutline()
Fills the selected region or ROI with a color and opacity.
result = Action.FillRegion(fillRegionType, fillColorRed, fillColorGreen, fillColorBlue, fillOpacityPercentage)
| Parameter | Description | Default |
|---|---|---|
| fillRegionTypeInteger, Optional | Integer representing the fill target. Supported fillRegionType values: 0: Inside - fill inside the region 1: Outside - fill outside the region | 0 |
| fillColorRedInteger, Optional | Fill color red component (0–255). | 0 |
| fillColorGreenInteger, Optional | Fill color green component (0–255). | 0 |
| fillColorBlueInteger, Optional | Fill color blue component (0–255). | 0 |
| fillOpacityPercentageInteger, Optional | Fill opacity percentage. | 100 |
Boolean — True if the region was filled; otherwise False.
success = Action.FillRegion(0, 0, 0, 0, 100)
Hides object outlines using a specified or most frequent color.
result = Action.HideOutlines(targetColorRed, targetColorGreen, targetColorBlue, useMostFrequentColor, repeatCount)
| Parameter | Description | Default |
|---|---|---|
| targetColorRedInteger, Optional | Replacement red component (0–255). | 255 |
| targetColorGreenInteger, Optional | Replacement green component (0–255). | 255 |
| targetColorBlueInteger, Optional | Replacement blue component (0–255). | 255 |
| useMostFrequentColorBoolean, Optional | Whether to use the most frequent image color instead. | True |
| repeatCountInteger, Optional | Number of iterations to repeat the outline hiding process (1–50). | 1 |
Boolean — True if outlines were hidden; otherwise False.
success = Action.HideOutlines(255, 255, 255, True, 3)
Converts the image to binary using a manual intensity threshold.
result = Action.ManualThresholding(binarizationThresholdValue)
| Parameter | Description | Default |
|---|---|---|
| binarizationThresholdValueInteger, Optional | Threshold intensity. | 128 |
Boolean — True if binarization succeeded; otherwise False.
success = Action.ManualThresholding(128)
Applies multilevel thresholding independently to RGB channels.
result = Action.MultiStepThresholding(redChannelLevels, greenChannelLevels, blueChannelLevels)
| Parameter | Description | Default |
|---|---|---|
| redChannelLevelsInteger, Optional | Number of red-channel intensity levels. | 5 |
| greenChannelLevelsInteger, Optional | Number of green-channel intensity levels. | 5 |
| blueChannelLevelsInteger, Optional | Number of blue-channel intensity levels. | 5 |
Boolean — True if thresholding succeeded; otherwise False.
success = Action.MultiStepThresholding(5, 5, 5)
Traces object outlines while always preserving the original pixel colors on the extracted outlines.
result = Action.Outline(isInverted, applyBinarization)
| Parameter | Description | Default |
|---|---|---|
| isInvertedBoolean, Optional | Whether to invert the binarization or background result before extracting outlines (dark objects on a light background). | False |
| applyBinarizationBoolean, Optional | Whether to apply threshold-based pre-binarization for boundary detection. Set to False to skip binarization and extract boundaries directly from all non-zero color regions (e.g., after Region Coloring) without brightness threshold loss. Original outline colors are preserved in both modes. | True |
Boolean — True if outlines were traced; otherwise False.
success = Action.Outline(False, False)
Colors connected image regions to distinguish them.
result = Action.RegionColoring(connectivity)
| Parameter | Description | Default |
|---|---|---|
| connectivityInteger, Optional | Integer representing the pixel connectivity. Supported connectivity values: 4: 4-connected (FourWay) 8: 8-connected (EightWay); any other value is treated as 8 | 8 |
Boolean — True if the regions were colored; otherwise False.
success = Action.RegionColoring(8)
Removes small connected components from a binary image.
result = Action.RemoveDots(dotMode, maxDotSize, connectivity)
| Parameter | Description | Default |
|---|---|---|
| dotModeInteger | Integer representing the target dots. Supported dotMode values: 0: Black dots 1: White dots (also used for any other value) 2: Both black and white dots | — |
| maxDotSizeInteger | Maximum component area in pixels to remove. | — |
| connectivityInteger, Optional | Integer representing pixel connectivity. Supported connectivity values: 4: 4-connected (FourWay) 8: 8-connected (EightWay); any other value is treated as 8 | 8 |
Boolean — True if dot removal succeeded; otherwise False.
success = Action.RemoveDots(2, 20, 8)
Reduces binary objects to one-pixel-wide skeletons.
result = Action.Skeletonize(isExtended, isInverted, minBranchLength, tailLength)
| Parameter | Description | Default |
|---|---|---|
| isExtendedBoolean, Optional | Whether to use extended skeleton processing. | True |
| isInvertedBoolean, Optional | Whether to invert the binary image before processing. | False |
| minBranchLengthInteger, Optional | Minimum branch length to retain. | 15 |
| tailLengthInteger, Optional | Tail length setting for skeleton processing. | 10 |
Boolean — True if skeletonization succeeded; otherwise False.
success = Action.Skeletonize(True, False, 15, 10)
Segments the image into superpixels.
result = Action.SuperPixelSegmentation(numSuperpixels, compactness, fillWithWhite)
| Parameter | Description | Default |
|---|---|---|
| numSuperpixelsInteger, Optional | Requested number of superpixels. | 400 |
| compactnessSingle, Optional | Superpixel compactness factor. | 30.0F |
| fillWithWhiteBoolean, Optional | Whether to fill superpixel regions with white. | False |
Boolean — True if segmentation succeeded; otherwise False.
success = Action.SuperPixelSegmentation(400, 30.0F, False)
Segments touching objects using watershed separation.
result = Action.WatershedSegmentation(minDistanceThreshold, smoothingRadius, boundaryThickness, boundaryColorRed, boundaryColorGreen, boundaryColorBlue)
| Parameter | Description | Default |
|---|---|---|
| minDistanceThresholdInteger, Optional | Minimum distance threshold between object centers. | 10 |
| smoothingRadiusInteger, Optional | Pre-segmentation smoothing radius. | 3 |
| boundaryThicknessInteger, Optional | Boundary thickness in pixels. | 1 |
| boundaryColorRedInteger, Optional | Boundary red component (0–255). | 255 |
| boundaryColorGreenInteger, Optional | Boundary green component (0–255). | 0 |
| boundaryColorBlueInteger, Optional | Boundary blue component (0–255). | 0 |
Boolean — True if segmentation succeeded; otherwise False.
success = Action.WatershedSegmentation(10, 3, 1, 255, 0, 0)
Activates undo tracking for workspace operations.
Action.ActivateUndoEngine()
Void — Void.
Action.ActivateUndoEngine()
Deactivates undo tracking for workspace operations.
Action.DeactivateUndoEngine()
Void — Void.
Action.DeactivateUndoEngine()
Returns a clone of the workspace image or an image-buffer image.
result = Action.GetImage(sourceLocation)
| Parameter | Description | Default |
|---|---|---|
| sourceLocationInteger, Optional | 0 selects the workspace; 1–10 selects a buffer. | 0 |
Bitmap — Bitmap clone, or Nothing when unavailable or export is not allowed.
bitmap = Action.GetImage(0)
Saves a bitmap image to the specified file path.
result = Action.SaveImage(sourceBitmap, destFileName, jpegQuality)
| Parameter | Description | Default |
|---|---|---|
| sourceBitmapBitmap | Bitmap to save. | — |
| destFileNameString | Destination file path. | — |
| jpegQualityInteger, Optional | JPEG quality from 0 to 100. | 90 |
String — String containing the save result or an error message.
message = Action.SaveImage(bitmap, "C:\Images\result.jpg", 90)
Opens a dialog to save an image with the selected format and quality.
Action.SaveImageDialog(targetBitmap, selectedExtension, selectedQuality)
| Parameter | Description | Default |
|---|---|---|
| targetBitmapBitmap | Bitmap to save. | — |
| selectedExtensionString | Selected file extension. | — |
| selectedQualityInteger | JPEG quality setting. | — |
Void — Void. Throws an exception if export is not allowed.
Action.SaveImageDialog(bitmap, ".jpg", 90)
Saves the current workspace with a new name.
Action.SaveWorkspaceAs()
Void — Void. Throws an exception if export is not allowed.
Action.SaveWorkspaceAs()
Saves the current workspace selection as a new file.
Action.SaveWorkspaceSelectionAs()
Void — Void. Throws an exception if export is not allowed.
Action.SaveWorkspaceSelectionAs()
Sets the workspace image or an image-buffer image from a bitmap clone.
result = Action.SetImage(newImage, targetLocation)
| Parameter | Description | Default |
|---|---|---|
| newImageBitmap | Image to assign. | — |
| targetLocationInteger, Optional | 0 selects the workspace; 1–10 selects a buffer. | 0 |
Boolean — True when the image is assigned; otherwise False.
success = Action.SetImage(bitmap, 0)
Returns the most recent error message produced by the helper.
result = DNNClassifier.GetLastError()
String — The last error message, or an empty string when no error is recorded.
errorMessage = DNNClassifier.GetLastError()
Loads an ML.NET image-classification model from the Classification Models folder.
result = DNNClassifier.LoadModel(modelFilename, forceReload)
| Parameter | Description | Default |
|---|---|---|
| modelFilenameString | Model ZIP file name. | — |
| forceReloadBoolean, Optional | Whether to reload the model when the same model is already loaded. | False |
Boolean — True when the model is loaded or already loaded; otherwise False.
loaded = DNNClassifier.LoadModel("model.zip", True)
Predicts the class label for the supplied bitmap image.
result = DNNClassifier.Predict(img)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Image to classify. | — |
String — Predicted class label, or an empty string if prediction fails.
label = DNNClassifier.Predict(bitmap)
Applies the detected face regions directly to the active workspace selection mask (AdvSel).
result = FaceDetector.ApplyFaceMaskToWorkspace(useRotatedEllipse, scaleExpand)
| Parameter | Description | Default |
|---|---|---|
| useRotatedEllipseBoolean, Optional | True to use rotated elliptical masks; False for rectangular masks. | True |
| scaleExpandDouble, Optional | Expansion scale factor for face ROI coverage. | 1.08 |
Boolean — True if the face mask was successfully applied to the workspace selection; otherwise False.
ok = FaceDetector.ApplyFaceMaskToWorkspace(True, 1.08)
Detects faces and 6-point facial landmarks in an image and stores the detection results.
result = FaceDetector.Detect(img, confThreshold, nmsThreshold, useTiling)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Image to analyze. | — |
| confThresholdDouble, Optional | Minimum confidence threshold. | 0.45 |
| nmsThresholdDouble, Optional | Non-maximum suppression threshold. | 0.4 |
| useTilingBoolean, Optional | Whether to use multi-scale tiled inference for high-res/group images. | True |
Integer — Number of detected faces, or 0 if detection fails.
count = FaceDetector.Detect(bitmap, 0.45, 0.4, True)
Returns all face detection results from the most recent detection.
result = FaceDetector.GetAllResults()
ONNX_FaceDetection.FaceDetectionResult() — Array of face detection results, or an empty array when no results are available.
results = FaceDetector.GetAllResults()
Returns the total number of faces from the most recent detection.
result = FaceDetector.GetFaceCount()
Integer — Number of detected faces.
count = FaceDetector.GetFaceCount()
Returns the 6 facial keypoints (0:LeftEye, 1:RightEye, 2:NoseTip, 3:MouthCenter, 4:LeftEar, 5:RightEar) for a specific 0-based face index.
result = FaceDetector.GetFaceKeypoints(faceIndex)
| Parameter | Description | Default |
|---|---|---|
| faceIndexInteger | Zero-based index of the detected face. | — |
PointF() — Array of 6 PointF coordinates, or an empty array if the index is out of range.
kps = FaceDetector.GetFaceKeypoints(0)
Returns bounding rectangles for all detected faces.
result = FaceDetector.GetFaceLocations()
RectangleF() — Array of bounding rectangles (RectangleF) for all detected faces.
locations = FaceDetector.GetFaceLocations()
Generates a strict binary mask bitmap (White = Detected Faces, Black = Background) from the most recent detection results.
result = FaceDetector.GetFaceMaskImage(img, useRotatedEllipse, scaleExpand)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Source image used to match dimensions and resolution. | — |
| useRotatedEllipseBoolean, Optional | True to draw rotated ellipses aligned with eye tilt; False for rectangles. | True |
| scaleExpandDouble, Optional | Expansion scale factor for face ROI coverage. | 1.08 |
Bitmap — Binary mask bitmap (24bppRgb), or Nothing if generation fails.
maskBmp = FaceDetector.GetFaceMaskImage(bitmap, True, 1.08)
Returns the head tilt (roll) angle in degrees for a specific 0-based face index.
result = FaceDetector.GetFaceRollAngle(faceIndex)
| Parameter | Description | Default |
|---|---|---|
| faceIndexInteger | Zero-based index of the detected face. | — |
Single — Head tilt angle in degrees, or 0.0 if the index is out of range.
tilt = FaceDetector.GetFaceRollAngle(0)
Returns the most recent error message produced by the helper.
result = FaceDetector.GetLastError()
String — The last error message, or an empty string when no error is recorded.
errorMessage = FaceDetector.GetLastError()
Returns a copy of the image rendered with independent options for face ROI, ID, confidence, and 6 keypoints.
result = FaceDetector.GetRenderedImage(img, showBoundingBox, showFaceId, showConfidence, showKeypoints, useRotatedEllipse, colorName)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Source image to render. | — |
| showBoundingBoxBoolean, Optional | Whether to draw the bounding ROI shape. | True |
| showFaceIdBoolean, Optional | Whether to display the face ID number (#1, #2...). | True |
| showConfidenceBoolean, Optional | Whether to display confidence values. | True |
| showKeypointsBoolean, Optional | Whether to draw the 6 facial keypoints. | True |
| useRotatedEllipseBoolean, Optional | True to draw rotated ellipses; False for rectangles. | True |
| colorNameString, Optional | Known .NET color name for ROI boxes. | "Red" |
Bitmap — Rendered bitmap, or Nothing if rendering fails.
rendered = FaceDetector.GetRenderedImage(bitmap, True, True, True, True, True, "Red")
Checks whether at least one face was detected in the most recent analysis.
result = FaceDetector.HasFaces()
Boolean — True if one or more faces were detected; otherwise False.
found = FaceDetector.HasFaces()
Initializes the BlazeFace detector with its default model and settings.
result = FaceDetector.Initialize()
Boolean — True when the detector is initialized or already available; otherwise False.
ready = FaceDetector.Initialize()
Converts ARGB values to integer.
result = ImgProc.ARGBToARGBInteger(_AlphaValue, _RedValue, _GreenValue, _BlueValue)
| Parameter | Description | Default |
|---|---|---|
| _AlphaValueInteger | Alpha channel value (0-255). | — |
| _RedValueInteger | Red channel value (0-255). | — |
| _GreenValueInteger | Green channel value (0-255). | — |
| _BlueValueInteger | Blue channel value (0-255). | — |
Integer — ARGB color as integer, or 0 if conversion fails.
color = ImgProc.ARGBToARGBInteger(255, 255, 0, 0)
Converts ARGB bytes to Color object.
result = ImgProc.ARGBToColor(AlphaInByte, RedInByte, GreenInByte, BlueInByte)
| Parameter | Description | Default |
|---|---|---|
| AlphaInByteInteger | Alpha channel value (0-255). | — |
| RedInByteInteger | Red channel value (0-255). | — |
| GreenInByteInteger | Green channel value (0-255). | — |
| BlueInByteInteger | Blue channel value (0-255). | — |
Color — Color object, or default color if conversion fails.
clr = ImgProc.ARGBToColor(255, 255, 0, 0)
Changes specified color to new color throughout image.
result = ImgProc.Change_Color(SourceImage, ColorOfInterest_RGBInt, ChangeToR, ChangeToG, ChangeToB, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to modify. Type: Bitmap; required; passed by reference. | — |
| ColorOfInterest_RGBIntInteger | RGB color to replace. | — |
| ChangeToRByte | New red channel value. | — |
| ChangeToGByte | New green channel value. | — |
| ChangeToBByte | New blue channel value. | — |
| IsShowProgressBoolean, Optional | Whether to show progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Modified image, or Nothing if operation fails.
modified = ImgProc.Change_Color(bitmap, RGB(255,0,0), 0, 255, 0)
Changes specified RGB color to new RGB color.
result = ImgProc.Change_Color_ByRGB(SourceImage, ColorOfInterestR, ColorOfInterestG, ColorOfInterestB, ChangeToR, ChangeToG, ChangeToB, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to modify. Type: Bitmap; required; passed by reference. | — |
| ColorOfInterestRByte | Red channel of color to replace. | — |
| ColorOfInterestGByte | Green channel of color to replace. | — |
| ColorOfInterestBByte | Blue channel of color to replace. | — |
| ChangeToRByte | New red channel value. | — |
| ChangeToGByte | New green channel value. | — |
| ChangeToBByte | New blue channel value. | — |
| IsShowProgressBoolean, Optional | Whether to show progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Modified image, or Nothing if operation fails.
modified = ImgProc.Change_Color_ByRGB(bitmap, 255, 0, 0, 0, 255, 0)
Validates RGB values in text boxes.
ImgProc.Check_RGBInTextBox(Text_R, Text_G, Text_B)
| Parameter | Description | Default |
|---|---|---|
| Text_RTextBox | TextBox containing red value. | — |
| Text_GTextBox | TextBox containing green value. | — |
| Text_BTextBox | TextBox containing blue value. | — |
Void — None.
ImgProc.Check_RGBInTextBox(txtRed, txtGreen, txtBlue)
Converts image to CIELab color space with adjustable L, a, b channels.
result = ImgProc.CIELab(original, lShift, aShift, bShift, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| originalBitmap | Source image to convert. | — |
| lShiftInteger | Lightness shift (-127 to 127). | — |
| aShiftInteger | a channel shift green-to-red (-127 to 127). | — |
| bShiftInteger | b channel shift blue-to-yellow (-127 to 127). | — |
| MaskImageImage, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — CIELab-converted image, or Nothing if conversion fails.
cielab = ImgProc.CIELab(bitmap, 0, 10, -10)
Applies color deconvolution to separate stains in histological images using a high-speed parallel algorithm.
result = ImgProc.ColorDeconvolution(SourceImage, StainType, ShowColor, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| StainTypeInteger | Integer representing the stain type. Supported values: 0: H&E - Hematoxylin (Nuclei) 1: H&E - Eosin (Cytoplasm) 2: H-DAB - Hematoxylin (Background) 3: H-DAB - DAB (Protein Marker) 4: Masson's Trichrome - Methyl Blue (Collagen) 5: Masson's Trichrome - Ponceau Fuchsin (Muscle) 6: H-AEC - Hematoxylin (Nuclei) 7: H-AEC - AEC (Red Marker) 8: Methyl Green-DAB - Methyl Green (Nuclei) 9: Methyl Green-DAB - DAB (Protein Marker) 10: H-PAS - Hematoxylin (Nuclei) 11: H-PAS - PAS (Glycogen / Basement Membrane) 12: Alcian Blue & H - Alcian Blue (Acid Mucins / GAG) 13: Alcian Blue & H - Hematoxylin (Nuclei) 14: Giemsa - Methylene Blue (Nuclei) 15: Giemsa - Eosin (Erythrocytes / Cytoplasm) 16: Feulgen-Light Green - Feulgen (DNA) 17: Feulgen-Light Green - Light Green (Cytoplasm) 18: Safranin-O & Fast Green - Safranin-O (Lignin / Cartilage) 19: Safranin-O & Fast Green - Fast Green (Cellulose / Cytoplasm) 20: H&E-DAB (Triple) - Hematoxylin (Nuclei) 21: H&E-DAB (Triple) - Eosin (Cytoplasm) 22: H&E-DAB (Triple) - DAB (Protein Marker) | — |
| ShowColorBoolean | Whether to apply pseudo-coloring to the extracted stain result. | — |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Deconvoluted image, or Nothing if operation fails.
deconvoluted = ImgProc.ColorDeconvolution(bitmap, 0, True)
Converts hexadecimal color string to integer.
result = ImgProc.ColorHexToColorInteger(ColorHex)
| Parameter | Description | Default |
|---|---|---|
| ColorHexString | Hexadecimal color string (e.g., "#FF0000"). Type: String; required; passed by reference. | — |
Integer — Integer color value, or 0 if conversion fails.
colorInt = ImgProc.ColorHexToColorInteger("#FF0000")
Converts hexadecimal color string to RGB components.
ImgProc.ColorHexToRGB(HexColorStr, R, G, B)
| Parameter | Description | Default |
|---|---|---|
| HexColorStrString | Hexadecimal color string (e.g., "#FF0000"). | — |
| RByte | Output red component. Type: Byte; required; passed by reference. | — |
| GByte | Output green component. Type: Byte; required; passed by reference. | — |
| BByte | Output blue component. Type: Byte; required; passed by reference. | — |
Void
ImgProc.ColorHexToRGB("#FF0000", r, g, b)
Displays ARGB values of a color integer to console output.
ImgProc.ColorIntegerToARGB(PixelValue)
| Parameter | Description | Default |
|---|---|---|
| PixelValueInteger | Color value as integer. | — |
Void — Void; prints ARGB components to console.
ImgProc.ColorIntegerToARGB(4294967295)
Displays RGB values of a color integer to console output.
ImgProc.ColorIntegerToRGB(PixelValue)
| Parameter | Description | Default |
|---|---|---|
| PixelValueInteger | Color value as integer. | — |
Void — Void; prints RGB components to console.
ImgProc.ColorIntegerToRGB(255)
Decomposes color to ARGB and HSI components.
ImgProc.ColorIntegerToRGBGHSI(ColorValue, RedValue, GreenValue, BlueValue, GrayValue, HueValue, SaturationValue, IntensityValue)
| Parameter | Description | Default |
|---|---|---|
| ColorValueInteger | Integer color value to decompose. | — |
| RedValueByte | Output red component. Type: Byte; required; passed by reference. | — |
| GreenValueByte | Output green component. Type: Byte; required; passed by reference. | — |
| BlueValueByte | Output blue component. Type: Byte; required; passed by reference. | — |
| GrayValueByte | Output gray component. Type: Byte; required; passed by reference. | — |
| HueValueSingle | Output hue component. Type: Single; required; passed by reference. | — |
| SaturationValueSingle | Output saturation component. Type: Single; required; passed by reference. | — |
| IntensityValueSingle | Output intensity component. Type: Single; required; passed by reference. | — |
Void
ImgProc.ColorIntegerToRGBGHSI(color, r, g, b, gray, hue, sat, int)
Selects or isolates pixels matching the specified target RGB color within a given tolerance.
result = ImgProc.ColorRangeSelection(SourceImage, targetR, targetG, targetB, colorSpace, isFastAlgorithm, tolerance, maintainOrgColor, isShowProgress, maskImage, maskRegionBoundary, isMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| targetRInteger | Target color red component (0-255). | — |
| targetGInteger | Target color green component (0-255). | — |
| targetBInteger | Target color blue component (0-255). | — |
| colorSpaceString, Optional | Color space model ('RGB', 'HSI', 'Lab', or 'Chroma'). | "RGB" |
| isFastAlgorithmBoolean, Optional | Whether to use Fast (Manhattan) distance instead of Standard (Euclidean). Ignored when colorSpace is 'Chroma'. | False |
| toleranceInteger, Optional | Color matching tolerance threshold (0-255). | 40 |
| maintainOrgColorBoolean, Optional | Whether to preserve original pixel colors for matched areas (False converts matched areas to white). | True |
| isShowProgressBoolean, Optional | Whether to report progress events. | False |
| maskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| maskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| isMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with color range selection applied, or Nothing if processing fails.
selected = ImgProc.ColorRangeSelection(bitmap, 0, 255, 0, "Chroma", False, 40, True)
Converts RGB Color object to hexadecimal string representation.
result = ImgProc.ColorToColorHEX(SourceColor)
| Parameter | Description | Default |
|---|---|---|
| SourceColorColor | Color object to convert. | — |
String — Hexadecimal color string (e.g., "#FF0000"), or empty string if conversion fails.
hex = ImgProc.ColorToColorHEX(Color.Red)
Converts 24-bit grayscale to 8-bit indexed image format.
result = ImgProc.Convert_Gray24Bit_To_8bppIndexed(srcBitmap)
| Parameter | Description | Default |
|---|---|---|
| srcBitmapBitmap | Source 24-bit grayscale bitmap. | — |
Bitmap — 8-bit indexed image, or Nothing if conversion fails.
indexed = ImgProc.Convert_Gray24Bit_To_8bppIndexed(bitmap)
Converts RGB to rg chromaticity coordinates.
result = ImgProc.Convert_To_rgChromaticity(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — rg chromaticity image, or Nothing if conversion fails.
rgChromaticity = ImgProc.Convert_To_rgChromaticity(bitmap)
Converts RGB to rg chromaticity with parallel processing.
result = ImgProc.Convert_To_rgChromaticity_Parallel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — rg chromaticity image, or Nothing if conversion fails.
rgChromaticity = ImgProc.Convert_To_rgChromaticity_Parallel(bitmap)
Removes blue channel from image.
result = ImgProc.Delete_BlueChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with blue channel removed, or Nothing if operation fails.
noBlue = ImgProc.Delete_BlueChannel(bitmap)
Removes green channel from image.
result = ImgProc.Delete_GreenChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with green channel removed, or Nothing if operation fails.
noGreen = ImgProc.Delete_GreenChannel(bitmap)
Removes red channel from image.
result = ImgProc.Delete_RedChannel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with red channel removed, or Nothing if operation fails.
noRed = ImgProc.Delete_RedChannel(bitmap)
Quantizes color channel value to discrete levels.
result = ImgProc.Digitalize(ColorChannelValue, LevelCount)
| Parameter | Description | Default |
|---|---|---|
| ColorChannelValueSingle | Color value to quantize. | — |
| LevelCountInteger | Number of discrete levels. | — |
Byte — Quantized color value.
quantized = ImgProc.Digitalize(128.5, 8)
Extracts blue channel as grayscale image.
result = ImgProc.GrayFrom_Blue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Blue channel as grayscale, or Nothing if extraction fails.
grayBlue = ImgProc.GrayFrom_Blue(bitmap)
Extracts green channel as grayscale.
result = ImgProc.GrayFrom_Green(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Green channel as grayscale, or Nothing if extraction fails.
grayGreen = ImgProc.GrayFrom_Green(bitmap)
Extracts red channel as grayscale image.
result = ImgProc.GrayFrom_Red(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Red channel as grayscale, or Nothing if extraction fails.
grayRed = ImgProc.GrayFrom_Red(bitmap)
Converts colored image to grayscale using luminosity method.
result = ImgProc.GrayScaling(SourceImage, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. | — |
| IsShowProgressBoolean, Optional | Whether to display progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Grayscale image, or Nothing if conversion fails.
gray = ImgProc.GrayScaling(bitmap, True)
Applies color map to grayscale image for visualization.
result = ImgProc.GrayToColor(SourceImage, MapType, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source grayscale image. | — |
| MapTypeImgProcessing.ColorMapType | Color map type to apply. Type: ImgProcessing.ColorMapType; required. Supported values: 0: RedBlue 1: Viridis 2: Parula 3: Plasma 4: Inferno 5: Magma 6: Cividis 7: Jet 8: Turbo 9: Rainbow 10: Spectral 11: HSV 12: Ocean 13: Seismic 14: RdBu 15: Coolwarm 16: bwr 17: BrBG 18: PiYG 19: Hot 20: Cool 21: Spring 22: Summer 23: Autumn 24: Winter 25: Bone 26: Copper 27: Pink 28: Terrain 29: Twilight 30: Rocket (Black - Blue - Red - Light Yellow) 31: Mako (Black - Deep Blue - Purple - Light Pink) 32: Cubehelix (Astronomy standard, brightness preserved in grayscale) 33: YlGnBu (Yellow - Green - Blue) 34: RdYlGn (Red - Yellow - Green) 35: PuOr (Purple - White - Orange) 36: Ironbow (Thermal: Black - Purple - Red - Yellow - White) 37: WhiteHot (Thermal: Cold Black - Hot White) 38: BlackHot (Thermal: Cold White - Hot Black) 39: Lava (Black - Dark Red - Orange - Yellow - White) 40: Arctic (Black - Dark Blue - Cyan - White) | — |
| MaskImageBitmap, Optional | Optional mask to constrain mapping. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Colorized image, or Nothing if mapping fails.
colored = ImgProc.GrayToColor(grayBitmap, ImgProcessing.ColorMapType.Jet)
Converts hexadecimal color string to RGB byte values.
ImgProc.HexToRGB(HexColorStr, R, G, B)
| Parameter | Description | Default |
|---|---|---|
| HexColorStrString | Hex color string (e.g., "#FF0000"). | — |
| RByte | Output red component (0-255). | — |
| GByte | Output green component (0-255). | — |
| BByte | Output blue component (0-255). | — |
Void — Void; returns RGB values through ByRef parameters.
Dim r, g, b As Byte; ImgProc.HexToRGB("#FF0000", r, g, b)
Removes or hides outlines of specified color from image.
result = ImgProc.Hide_Outlines(SourceImage, TargetColor_R, TargetColor_G, TargetColor_B, IsMostFrequentColor, RepeatCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to modify. Type: Bitmap; required; passed by reference. | — |
| TargetColor_RByte | Red channel of outline color. | — |
| TargetColor_GByte | Green channel of outline color. | — |
| TargetColor_BByte | Blue channel of outline color. | — |
| IsMostFrequentColorBoolean, Optional | Whether to use most frequent color for replacement. | True |
| RepeatCountInteger, Optional | Number of iterations to repeat the outline hiding process (1–50). | 1 |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Modified image with hidden outlines, or Nothing if operation fails.
hidden = ImgProc.Hide_Outlines(bitmap, 0, 0, 0, True, 3)
Converts HSI to RGB color space.
ImgProc.HSITORGB(Hue, Saturation255, Intensity255, Red, Green, Blue)
| Parameter | Description | Default |
|---|---|---|
| HueInteger | Hue value. | — |
| Saturation255Single | Saturation (0-255). | — |
| Intensity255Single | Intensity (0-255). | — |
| RedInteger | Output red component. Type: Integer; required; passed by reference. | — |
| GreenInteger | Output green component. Type: Integer; required; passed by reference. | — |
| BlueInteger | Output blue component. Type: Integer; required; passed by reference. | — |
Void
ImgProc.HSITORGB(180, 128, 200, red, green, blue)
Converts HSV to RGB color space.
ImgProc.HSVtoRGB(h, s, v, r, g, b)
| Parameter | Description | Default |
|---|---|---|
| hSingle | Hue value. | — |
| sSingle | Saturation value. | — |
| vSingle | Value component. | — |
| rByte | Output red component. Type: Byte; required; passed by reference. | — |
| gByte | Output green component. Type: Byte; required; passed by reference. | — |
| bByte | Output blue component. Type: Byte; required; passed by reference. | — |
Void
ImgProc.HSVtoRGB(180, 0.5, 0.75, r, g, b)
Adjusts hue, saturation, and intensity values of the image.
result = ImgProc.HueSaturationIntensity(original, hueShift, satShift, intShift, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| originalBitmap | Source image to adjust. | — |
| hueShiftInteger | Hue shift (-180 to 180). | — |
| satShiftInteger | Saturation shift (-100 to 100). | — |
| intShiftInteger | Intensity shift (-100 to 100). | — |
| MaskImageImage, Optional | Optional mask to constrain adjustment. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Hue-saturation-intensity adjusted image, or Nothing if processing fails.
hsi = ImgProc.HueSaturationIntensity(bitmap, 30, 20, -10)
Checks if image is binary (contains only black and white pixels).
result = ImgProc.IsBinaryImage(SourceImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Image to check. | — |
Boolean — True if image is binary, False otherwise.
isBinary = ImgProc.IsBinaryImage(bitmap)
Checks if RGB pixel values represent black or white.
result = ImgProc.IsBWPixel(red, green, blue)
| Parameter | Description | Default |
|---|---|---|
| redByte | Red component (0-255). | — |
| greenByte | Green component (0-255). | — |
| blueByte | Blue component (0-255). | — |
Boolean — True if pixel is black or white, False otherwise.
isBW = ImgProc.IsBWPixel(0, 0, 0)
Checks if image is grayscale (all color channels equal).
result = ImgProc.IsGrayImage(SourceImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Image to check. | — |
Boolean — True if image is grayscale, False otherwise.
isGray = ImgProc.IsGrayImage(bitmap)
Returns maximum value among three color components.
result = ImgProc.Maximum(rR, rG, rB)
| Parameter | Description | Default |
|---|---|---|
| rRSingle | Red component value. | — |
| rGSingle | Green component value. | — |
| rBSingle | Blue component value. | — |
Single — Maximum value among the three components.
max = ImgProc.Maximum(255.0, 128.0, 200.0)
Merges three channel images using specified color space.
result = ImgProc.MergeChannels(SourceImage, ColorSpace, Image1, Image2, Image3, maskImage, maskRegionBoundary, isMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageImage | Original source image for background preservation. | — |
| ColorSpaceString | Target color space ('RGB', 'HSI', or 'LAB'). | — |
| Image1Bitmap | First channel image. | — |
| Image2Bitmap | Second channel image. | — |
| Image3Bitmap | Third channel image. | — |
| maskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| maskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| isMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Merged image in specified color space, or Nothing if merging fails.
merged = ImgProc.MergeChannels(bitmap, "RGB", ch1, ch2, ch3)
Returns minimum value among three color components.
result = ImgProc.Minimum(rR, rG, rB)
| Parameter | Description | Default |
|---|---|---|
| rRSingle | Red component value. | — |
| rGSingle | Green component value. | — |
| rBSingle | Blue component value. | — |
Single — Minimum value among the three components.
min = ImgProc.Minimum(255.0, 128.0, 200.0)
Applies multi-step thresholding to separate color channels into quantized levels.
result = ImgProc.MultiStepThresholding(SourceImage, LevelCount_Red, LevelCount_Green, LevelCount_Blue, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to threshold. | — |
| LevelCount_RedInteger | Number of quantization levels for red channel. | — |
| LevelCount_GreenInteger | Number of quantization levels for green channel. | — |
| LevelCount_BlueInteger | Number of quantization levels for blue channel. | — |
| MaskImageBitmap, Optional | Optional mask to constrain thresholding. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Thresholded image, or Nothing if processing fails.
thresholded = ImgProc.MultiStepThresholding(bitmap, 3, 3, 3)
Removes alpha channel transparency from image.
result = ImgProc.RemoveTransparency(SourceImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
Bitmap — Image without transparency, or Nothing if removal fails.
noAlpha = ImgProc.RemoveTransparency(bitmap)
Converts RGB byte values to ARGB integer format with full alpha.
result = ImgProc.RGBToARGBInteger(red, green, blue)
| Parameter | Description | Default |
|---|---|---|
| redInteger | Red component (0-255). | — |
| greenInteger | Green component (0-255). | — |
| blueInteger | Blue component (0-255). | — |
Integer — ARGB integer value, or 0 if conversion fails.
argb = ImgProc.RGBToARGBInteger(255, 128, 64)
Converts RGB to CMYK color space.
ImgProc.RGBToCMYK(r, g, b, IsCompute_Cyan, IsCompute_Magenta, IsCompute_Yellow)
| Parameter | Description | Default |
|---|---|---|
| rByte | Red component value. | — |
| gByte | Green component value. | — |
| bByte | Blue component value. | — |
| IsCompute_CyanBoolean | Compute cyan component. | — |
| IsCompute_MagentaBoolean | Compute magenta component. | — |
| IsCompute_YellowBoolean | Compute yellow component. | — |
Void
ImgProc.RGBToCMYK(255, 128, 64, True, True, True)
Converts RGB byte values to Color object.
result = ImgProc.RGBToColor(RedInByte, GreenInByte, BlueInByte)
| Parameter | Description | Default |
|---|---|---|
| RedInByteInteger | Red component (0-255). | — |
| GreenInByteInteger | Green component (0-255). | — |
| BlueInByteInteger | Blue component (0-255). | — |
Color — Color object, or Color.Black if conversion fails.
color = ImgProc.RGBToColor(255, 100, 50)
Converts RGB values to hexadecimal color string.
result = ImgProc.RGBToColorHex(RedValue, GreenValue, BlueValue)
| Parameter | Description | Default |
|---|---|---|
| RedValueInteger | Red component value. | — |
| GreenValueInteger | Green component value. | — |
| BlueValueInteger | Blue component value. | — |
String — Hexadecimal color string, or empty string if conversion fails.
hexColor = ImgProc.RGBToColorHex(255, 0, 0)
Converts RGB to green chromaticity coordinate.
ImgProc.RGBToGChromaticity(_RedValue, _GreenValue, _BlueValue)
| Parameter | Description | Default |
|---|---|---|
| _RedValueInteger | Red channel value. | — |
| _GreenValueInteger | Green channel value. | — |
| _BlueValueInteger | Blue channel value. | — |
Void — None.
ImgProc.RGBToGChromaticity(255, 128, 0)
Converts RGB to rg chromaticity values (shared version).
ImgProc.RGBToGChromaticity_Shared(RedValue, GreenValue, BlueValue, RGChromaticity_Red, RGChromaticity_Green, RGChromaticity_Blue)
| Parameter | Description | Default |
|---|---|---|
| RedValueInteger | Red channel value. | — |
| GreenValueInteger | Green channel value. | — |
| BlueValueInteger | Blue channel value. | — |
| RGChromaticity_RedByte | Output rg chromaticity red value. Type: Byte; required; passed by reference. | — |
| RGChromaticity_GreenByte | Output rg chromaticity green value. Type: Byte; required; passed by reference. | — |
| RGChromaticity_BlueByte | Output rg chromaticity blue value. Type: Byte; required; passed by reference. | — |
Void — None.
ImgProc.RGBToGChromaticity_Shared(255, 128, 0, outR, outG, outB)
Converts RGB to grayscale byte value using standard formula.
result = ImgProc.RGBToGray(r, g, b)
| Parameter | Description | Default |
|---|---|---|
| rInteger | Red component (0-255). | — |
| gInteger | Green component (0-255). | — |
| bInteger | Blue component (0-255). | — |
Byte — Grayscale byte value (0-255), or 0 if conversion fails.
grayByte = ImgProc.RGBToGray(255, 100, 50)
Converts RGB to grayscale using precise luminosity calculation.
result = ImgProc.RGBToGray_ByRealCalc(r, g, b)
| Parameter | Description | Default |
|---|---|---|
| rInteger | Red component (0-255). | — |
| gInteger | Green component (0-255). | — |
| bInteger | Blue component (0-255). | — |
Integer — Grayscale value (0-255), or 0 if conversion fails.
grayValue = ImgProc.RGBToGray_ByRealCalc(255, 100, 50)
Converts RGB to HSI color space.
ImgProc.RGBToHSI(r, g, b)
| Parameter | Description | Default |
|---|---|---|
| rByte | Red component value. | — |
| gByte | Green component value. | — |
| bByte | Blue component value. | — |
Void
ImgProc.RGBToHSI(255, 128, 64)
Converts RGB to HSI using parallel method.
ImgProc.RGBToHSI_Parallel(r, g, b, Hue, Saturation, Intensity)
| Parameter | Description | Default |
|---|---|---|
| rInteger | Red component value. | — |
| gInteger | Green component value. | — |
| bInteger | Blue component value. | — |
| HueSingle | Output hue value. Type: Single; required; passed by reference. | — |
| SaturationSingle | Output saturation value. Type: Single; required; passed by reference. | — |
| IntensitySingle | Output intensity value. Type: Single; required; passed by reference. | — |
Void
ImgProc.RGBToHSI_Parallel(255, 128, 64, hue, sat, int)
Converts RGB to CIELab color space.
ImgProc.RGBToLab(r, g, b)
| Parameter | Description | Default |
|---|---|---|
| rByte | Red component value. | — |
| gByte | Green component value. | — |
| bByte | Blue component value. | — |
Void
ImgProc.RGBToLab(255, 128, 64)
Converts RGB to CIELab with original value output.
ImgProc.RGBToLab_OriginalValue(r, g, b, LabL, Laba, Labb)
| Parameter | Description | Default |
|---|---|---|
| rByte | Red component value. | — |
| gByte | Green component value. | — |
| bByte | Blue component value. | — |
| LabLDouble | Output L component. Type: Double; required; passed by reference. | — |
| LabaDouble | Output a component. Type: Double; required; passed by reference. | — |
| LabbDouble | Output b component. Type: Double; required; passed by reference. | — |
Void
ImgProc.RGBToLab_OriginalValue(255, 128, 64, labL, labA, labB)
Converts RGB to CIELab using parallel method.
ImgProc.RGBToLab_Parallel(r, g, b, Out_L, Out_a, Out_b)
| Parameter | Description | Default |
|---|---|---|
| rByte | Red component value. | — |
| gByte | Green component value. | — |
| bByte | Blue component value. | — |
| Out_LByte | Output L component. Type: Byte; required; passed by reference. | — |
| Out_aByte | Output a component. Type: Byte; required; passed by reference. | — |
| Out_bByte | Output b component. Type: Byte; required; passed by reference. | — |
Void
ImgProc.RGBToLab_Parallel(255, 128, 64, outL, outA, outB)
Splits a (color opponent) channel in Lab color space.
result = ImgProc.Split_a(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — a channel image, or Nothing if decomposition fails.
aChannel = ImgProc.Split_a(bitmap)
Splits b (color opponent) channel in Lab color space.
result = ImgProc.Split_b(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — b channel image, or Nothing if decomposition fails.
bChannel = ImgProc.Split_b(bitmap)
Extracts blue channel from color image as grayscale.
result = ImgProc.Split_Blue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Blue channel as grayscale image, or Nothing if extraction fails.
blueChannel = ImgProc.Split_Blue(bitmap)
Splits C (cyan) channel in CMYK decomposition.
result = ImgProc.Split_Cyan(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — C channel image, or Nothing if decomposition fails.
cChannel = ImgProc.Split_Cyan(bitmap)
Extracts green channel from color image as grayscale.
result = ImgProc.Split_Green(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Green channel as grayscale image, or Nothing if extraction fails.
greenChannel = ImgProc.Split_Green(bitmap)
Extracts hue channel from HSI color space.
result = ImgProc.Split_Hue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Hue channel as image, or Nothing if extraction fails.
hueChannel = ImgProc.Split_Hue(bitmap)
Extracts intensity channel from HSI color space.
result = ImgProc.Split_Intensity(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Intensity channel as image, or Nothing if extraction fails.
intensity = ImgProc.Split_Intensity(bitmap)
Splits K (black) channel in CMYK decomposition.
result = ImgProc.Split_KBlack(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — K channel image, or Nothing if decomposition fails.
kChannel = ImgProc.Split_KBlack(bitmap)
Splits L (lightness) channel in Lab color space.
result = ImgProc.Split_L(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — L channel image, or Nothing if decomposition fails.
lChannel = ImgProc.Split_L(bitmap)
Splits M (magenta) channel in CMYK decomposition.
result = ImgProc.Split_Magenta(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — M channel image, or Nothing if decomposition fails.
mChannel = ImgProc.Split_Magenta(bitmap)
Extracts red channel from color image as grayscale.
result = ImgProc.Split_Red(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Red channel as grayscale image, or Nothing if extraction fails.
redChannel = ImgProc.Split_Red(bitmap)
Splits rg chromaticity blue channel.
result = ImgProc.Split_rgChromaticityBlue(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — rg chromaticity blue channel image, or Nothing if splitting fails.
rgBlue = ImgProc.Split_rgChromaticityBlue(bitmap)
Splits rg chromaticity green channel.
result = ImgProc.Split_rgChromaticityGreen(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — rg chromaticity green channel image, or Nothing if splitting fails.
rgGreen = ImgProc.Split_rgChromaticityGreen(bitmap)
Splits rg chromaticity red channel.
result = ImgProc.Split_rgChromaticityRed(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — rg chromaticity red channel image, or Nothing if splitting fails.
rgRed = ImgProc.Split_rgChromaticityRed(bitmap)
Extracts saturation channel from HSI color space.
result = ImgProc.Split_Saturation(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source color image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Saturation channel as image, or Nothing if extraction fails.
saturation = ImgProc.Split_Saturation(bitmap)
Splits Y (yellow) channel in CMYK decomposition.
result = ImgProc.Split_Yellow(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to decompose. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Y channel image, or Nothing if decomposition fails.
yChannel = ImgProc.Split_Yellow(bitmap)
Applies dual-tone color grading to shadows and highlights independently using a high-speed 256-entry luminance LUT.
result = ImgProc.SplitToning(SourceImage, ShadowHue, HighlightHue, ToneStrength, TonalBalance, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| ShadowHueInteger, Optional | Color hue angle in degrees for shadows (0-360). | 210 |
| HighlightHueInteger, Optional | Color hue angle in degrees for highlights (0-360). | 35 |
| ToneStrengthSingle, Optional | Overall color toning intensity (0.0-1.0). | 0.4F |
| TonalBalanceInteger, Optional | Balance shift between shadow and highlight tints (-100 to 100). | 0 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Split Toning applied, or Nothing if processing fails.
tonedBmp = ImgProc.SplitToning(bitmap, 210, 35, 0.4F, 0)
Checks if two images are identical.
result = ImgProc.AreImagesIdentical(img1, img2)
| Parameter | Description | Default |
|---|---|---|
| img1Bitmap | First image to compare. | — |
| img2Bitmap | Second image to compare. | — |
Boolean — True if images are identical, False otherwise.
identical = ImgProc.AreImagesIdentical(bitmap1, bitmap2)
Calculates average color value of specified channel.
result = ImgProc.Calculate_AverageColorValue(SourceImage, TotalPixelsCount, AnalysisInterval, ColorChannel, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| ColorChannelString | Color channel to analyze. Supported values (case-insensitive): "gray": Gray level "red": Red "green": Green "blue": Blue "hue": Hue "saturation": Saturation "intensity": Intensity "cyan": Cyan "magenta": Magenta "yellow": Yellow "k black": K (Black) of CMYK "lab l": CIE Lab L (Lightness) "lab a": CIE Lab a (Green-Red) "lab b": CIE Lab b (Blue-Yellow) "rg chromaticity red": rg chromaticity Red "rg chromaticity green": rg chromaticity Green "rg chromaticity blue": rg chromaticity Blue Any other value: the function returns -1 | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average color value of the specified channel, or 0 if calculation fails.
avgRed = ImgProc.Calculate_AverageColorValue(bitmap, totPix, 1, "R")
Calculates average a (green-red) value in CIELab.
result = ImgProc.Calculate_AverageColorValue_a(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average a (green-red) value, or 0 if calculation fails.
avgA = ImgProc.Calculate_AverageColorValue_a(bitmap, totPix, 1)
Calculates average b (blue-yellow) value in CIELab.
result = ImgProc.Calculate_AverageColorValue_b(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average b (blue-yellow) value, or 0 if calculation fails.
avgB = ImgProc.Calculate_AverageColorValue_b(bitmap, totPix, 1)
Calculates average blue channel value.
result = ImgProc.Calculate_AverageColorValue_Blue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average blue channel value, or 0 if calculation fails.
avgBlue = ImgProc.Calculate_AverageColorValue_Blue(bitmap, totPix, 1)
Calculates average cyan channel value.
result = ImgProc.Calculate_AverageColorValue_Cyan(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average cyan value, or 0 if calculation fails.
avgCyan = ImgProc.Calculate_AverageColorValue_Cyan(bitmap, totPix, 1)
Calculates average grayscale value.
result = ImgProc.Calculate_AverageColorValue_Gray(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average grayscale value, or 0 if calculation fails.
avgGray = ImgProc.Calculate_AverageColorValue_Gray(bitmap, totPix, 1)
Calculates average green channel value.
result = ImgProc.Calculate_AverageColorValue_Green(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average green channel value, or 0 if calculation fails.
avgGreen = ImgProc.Calculate_AverageColorValue_Green(bitmap, totPix, 1)
Calculates average hue value.
result = ImgProc.Calculate_AverageColorValue_Hue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average hue value, or 0 if calculation fails.
avgHue = ImgProc.Calculate_AverageColorValue_Hue(bitmap, totPix, 1)
Calculates average intensity value.
result = ImgProc.Calculate_AverageColorValue_Intensity(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average intensity value, or 0 if calculation fails.
avgInt = ImgProc.Calculate_AverageColorValue_Intensity(bitmap, totPix, 1)
Calculates average black (K) channel value in CMYK.
result = ImgProc.Calculate_AverageColorValue_KBlack(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average black channel value, or 0 if calculation fails.
avgK = ImgProc.Calculate_AverageColorValue_KBlack(bitmap, totPix, 1)
Calculates average L (lightness) value in CIELab.
result = ImgProc.Calculate_AverageColorValue_L(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average L (lightness) value, or 0 if calculation fails.
avgL = ImgProc.Calculate_AverageColorValue_L(bitmap, totPix, 1)
Calculates average magenta channel value.
result = ImgProc.Calculate_AverageColorValue_Magenta(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average magenta value, or 0 if calculation fails.
avgMag = ImgProc.Calculate_AverageColorValue_Magenta(bitmap, totPix, 1)
Calculates multiple color channel averages simultaneously.
ImgProc.Calculate_AverageColorValue_MultipleChannels(SourceImage, ShapeMode, X1, Y1, X2, Y2, ReturnRed, ReturnGreen, ReturnBlue, ReturnGray, ReturnHue, ReturnSat, ReturnIntensity, ReturnCyan, ReturnMagenta, ReturnYellow, ReturnK, ReturnLab_L, ReturnLab_a, ReturnLab_b, ReturnRG_Red, ReturnRG_Green, ReturnRG_Blue)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| ShapeModeInteger | Shape mode for region selection. Supported values: 1: Rectangle region 2: Circle region (inscribed in the X1-X2 range) | — |
| X1Integer | First X-coordinate. | — |
| Y1Integer | First Y-coordinate. | — |
| X2Integer | Second X-coordinate. | — |
| Y2Integer | Second Y-coordinate. | — |
| ReturnRedByte | Output red channel average. Type: Byte; required; passed by reference. | — |
| ReturnGreenByte | Output green channel average. Type: Byte; required; passed by reference. | — |
| ReturnBlueByte | Output blue channel average. Type: Byte; required; passed by reference. | — |
| ReturnGrayByte | Output gray channel average. Type: Byte; required; passed by reference. | — |
| ReturnHueSingle | Output hue average. Type: Single; required; passed by reference. | — |
| ReturnSatSingle | Output saturation average. Type: Single; required; passed by reference. | — |
| ReturnIntensitySingle | Output intensity average. Type: Single; required; passed by reference. | — |
| ReturnCyanSingle | Output cyan average. Type: Single; required; passed by reference. | — |
| ReturnMagentaSingle | Output magenta average. Type: Single; required; passed by reference. | — |
| ReturnYellowSingle | Output yellow average. Type: Single; required; passed by reference. | — |
| ReturnKSingle | — | |
| ReturnLab_LSingle | — | |
| ReturnLab_aSingle | — | |
| ReturnLab_bSingle | — | |
| ReturnRG_RedSingle | — | |
| ReturnRG_GreenSingle | — | |
| ReturnRG_BlueSingle | — |
Void
ImgProc.Calculate_AverageColorValue_MultipleChannels(bitmap, 0, 0, 0, 100, 100, r, g, b, gray, hue, sat, int, cyan, mag, yel)
Calculates average red channel value.
result = ImgProc.Calculate_AverageColorValue_Red(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average red channel value, or 0 if calculation fails.
avgRed = ImgProc.Calculate_AverageColorValue_Red(bitmap, totPix, 1)
Calculates average blue chromaticity value.
result = ImgProc.Calculate_AverageColorValue_rgChromaticityBlue(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average blue chromaticity value, or 0 if calculation fails.
avgRgBlue = ImgProc.Calculate_AverageColorValue_rgChromaticityBlue(bitmap, totPix, 1)
Calculates average green chromaticity value.
result = ImgProc.Calculate_AverageColorValue_rgChromaticityGreen(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average green chromaticity value, or 0 if calculation fails.
avgRgGreen = ImgProc.Calculate_AverageColorValue_rgChromaticityGreen(bitmap, totPix, 1)
Calculates average red chromaticity value.
result = ImgProc.Calculate_AverageColorValue_rgChromaticityRed(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average red chromaticity value, or 0 if calculation fails.
avgRgRed = ImgProc.Calculate_AverageColorValue_rgChromaticityRed(bitmap, totPix, 1)
Calculates average saturation value.
result = ImgProc.Calculate_AverageColorValue_Saturation(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average saturation value, or 0 if calculation fails.
avgSat = ImgProc.Calculate_AverageColorValue_Saturation(bitmap, totPix, 1)
Calculates average yellow channel value.
result = ImgProc.Calculate_AverageColorValue_Yellow(SourceImage, TotalPixelsCount, AnalysisInterval, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average yellow value, or 0 if calculation fails.
avgYellow = ImgProc.Calculate_AverageColorValue_Yellow(bitmap, totPix, 1)
Calculates average using predefined color formula. The result is a 16-bit value combining two channels (low byte | high byte << 8).
result = ImgProc.Calculate_AvgValueByPredefinedColorFormula(SourceImage, TotalPixelsCount, AnalysisInterval, FormulaMethod, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelsCountLong | Output total pixels analyzed. Type: Long; required; passed by reference. | — |
| AnalysisIntervalInteger | Sampling interval for analysis. | — |
| FormulaMethodInteger | Color formula method to use. Supported values: 0: Low byte = Red, High byte = Green 1: Low byte = Red, High byte = Blue 2: Low byte = Green, High byte = Red 3: Low byte = Green, High byte = Blue 4: Low byte = Blue, High byte = Red 5: Low byte = Blue, High byte = Green | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single — Average value computed by formula, or 0 if calculation fails.
avgFormula = ImgProc.Calculate_AvgValueByPredefinedColorFormula(bitmap, totPix, 1, 0)
Calculates local grayscale average from integral map.
result = ImgProc.Calculate_LocalGrayAvgValue(IntegralGrayImageMap(,), LocalBoxSize, CenterX, CenterY)
| Parameter | Description | Default |
|---|---|---|
| IntegralGrayImageMap(,)Long | — | |
| LocalBoxSizeInteger | Size of local box for averaging. | — |
| CenterXInteger | Center X-coordinate. | — |
| CenterYInteger | Center Y-coordinate. | — |
Byte — Local average grayscale value, or 0 if calculation fails.
localAvg = ImgProc.Calculate_LocalGrayAvgValue(integralMap, 15, 50, 50)
Calculates total pixel count in selected region.
result = ImgProc.Calculate_TotalPixels(SourceImage, SelectShape, X1, Y1, X2, Y2, ColorBW)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| SelectShapeInteger | Shape mode for region selection. Supported values: 1: Rectangle region Any other value: Circle region | — |
| X1Integer | First X-coordinate. | — |
| Y1Integer | First Y-coordinate. | — |
| X2Integer | Second X-coordinate. | — |
| Y2Integer | Second Y-coordinate. | — |
| ColorBWInteger | Color for counting. Supported values: 0: Count white pixels (255,255,255) Any other value (e.g., 1): Count black pixels (0,0,0) | — |
Long — Total pixel count, or 0 if calculation fails.
totPix = ImgProc.Calculate_TotalPixels(bitmap, 0, 0, 0, 100, 100, 0)
Validates image dimensions against constraints.
result = ImgProc.Check_ImageSize(SourceImage, MinWidth, MinHeight, MaxWidth, MaxHeight)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to validate. Type: Bitmap; required; passed by reference. | — |
| MinWidthInteger, Optional | Minimum allowed width. | 1 |
| MinHeightInteger, Optional | Minimum allowed height. | 1 |
| MaxWidthInteger, Optional | Maximum allowed width. | 10000 |
| MaxHeightInteger, Optional | Maximum allowed height. | 10000 |
String — Validation result message, or empty string if validation fails.
msg = ImgProc.Check_ImageSize(bitmap, 100, 100, 5000, 5000)
Compares two bitmaps for pixel-by-pixel equality.
result = ImgProc.CompareBitmapImages(b1, b2)
| Parameter | Description | Default |
|---|---|---|
| b1Bitmap | First bitmap to compare. | — |
| b2Bitmap | Second bitmap to compare. | — |
Boolean — True if bitmaps are identical, False otherwise.
isSame = ImgProc.CompareBitmapImages(bmp1, bmp2)
Computes difference between two images.
result = ImgProc.Compute_DifferentialImage(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImage1Bitmap | First grayscale image. Type: Bitmap; required; passed by reference. | — |
| SourceGrayImage2Bitmap | Second grayscale image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Differential image, or Nothing if operation fails.
diff = ImgProc.Compute_DifferentialImage(grayBitmap1, grayBitmap2)
Converts grayscale byte array to RGB image.
result = ImgProc.Convert_GrayByteArray_To_RGBImage(SrcByteArray(,))
| Parameter | Description | Default |
|---|---|---|
| SrcByteArray(,)Byte | — |
Bitmap — RGB image converted from byte array, or Nothing if conversion fails.
image = ImgProc.Convert_GrayByteArray_To_RGBImage(grayArray)
Converts grayscale integer array to RGB image.
result = ImgProc.Convert_GrayByteArray_To_RGBImage_Int(SrcByteArray(,))
| Parameter | Description | Default |
|---|---|---|
| SrcByteArray(,)Integer | — |
Bitmap — RGB image converted from integer array, or Nothing if conversion fails.
image = ImgProc.Convert_GrayByteArray_To_RGBImage_Int(intArray)
Extracts grayscale image pixels into byte array.
result = ImgProc.Convert_GrayImage_To_GrayByteArray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to extract. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Byte(,) — 2D byte array (height x width), or Nothing if extraction fails.
grayArray = ImgProc.Convert_GrayImage_To_GrayByteArray(bitmap)
Converts RGB byte array to RGB image.
result = ImgProc.Convert_RGBByteArray_To_RGBImage(SrcByteArray(,,))
| Parameter | Description | Default |
|---|---|---|
| SrcByteArray(,,)Byte | — |
Bitmap — RGB image converted from byte array, or Nothing if conversion fails.
image = ImgProc.Convert_RGBByteArray_To_RGBImage(rgbArray)
Converts RGB image pixels to grayscale byte array.
result = ImgProc.Convert_RGBImage_To_GrayByteArray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. | — |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Byte(,) — 2D byte array (height x width), or Nothing if conversion fails.
grayArray = ImgProc.Convert_RGBImage_To_GrayByteArray(bitmap)
Converts RGB image pixels to grayscale integer array.
result = ImgProc.Convert_RGBImage_To_GrayIntegerArray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. | — |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Integer(,) — 2D integer array (height x width), or Nothing if conversion fails.
grayIntArray = ImgProc.Convert_RGBImage_To_GrayIntegerArray(bitmap)
Extracts RGB image pixels into 3D byte array.
result = ImgProc.Convert_RGBImage_To_RGBByteArray(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to extract. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Byte(,,) — 3D byte array (height x width x channels), or Nothing if extraction fails.
rgbArray = ImgProc.Convert_RGBImage_To_RGBByteArray(bitmap)
Counts pixels of specific color.
result = ImgProc.Count_ColorPixelOfInterest(SourceImage, ColorOfInterest_RGBInt, TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to scan. | — |
| ColorOfInterest_RGBIntInteger | Target color as RGB integer. | — |
| TotalPixelCountInteger | Output total pixel count. Type: Integer; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain counting. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Integer — Number of pixels matching the target color, or 0 if counting fails.
count = ImgProc.Count_ColorPixelOfInterest(bitmap, Color.Red.ToArgb(), totPix)
Counts pixels of specified color in grayscale array.
result = ImgProc.Count_ColorPixelOfInterest_FromGrayArray(ImageGrayArray(,), ColorOfInterestByte)
| Parameter | Description | Default |
|---|---|---|
| ImageGrayArray(,)Byte | — | |
| ColorOfInterestByteByte | Gray color value to count. | — |
Integer — Number of pixels matching color, or 0 if counting fails.
count = ImgProc.Count_ColorPixelOfInterest_FromGrayArray(grayArray, 128)
Counts pixels of specified color in region.
result = ImgProc.Count_ColorPixelOfInterest_FromGrayArray_Region(ImageGrayArray(,), ColorOfInterestByte, X1, Y1, X2, Y2)
| Parameter | Description | Default |
|---|---|---|
| ImageGrayArray(,)Byte | — | |
| ColorOfInterestByteInteger | Gray color value to count. | — |
| X1Integer | Start X coordinate. | — |
| Y1Integer | Start Y coordinate. | — |
| X2Integer | End X coordinate. | — |
| Y2Integer | End Y coordinate. | — |
Integer — Number of pixels matching color, or 0 if counting fails.
count = ImgProc.Count_ColorPixelOfInterest_FromGrayArray_Region(grayArray, 128, 0, 0, 100, 100)
Counts grayscale pixels of specific value.
result = ImgProc.Count_NumberOfGrayPixel_OfInterest(SourceGrayImage, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| GrayColorOfInterestInteger | Target gray value to count. | — |
| MaskImageBitmap, Optional | Optional mask to constrain counting. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Integer — Number of grayscale pixels matching the target value, or 0 if counting fails.
count = ImgProc.Count_NumberOfGrayPixel_OfInterest(grayBitmap, 128)
Exports cropped regions based on a binary mask image directly from Bitmap objects.
result = ImgProc.CropExportRegions(SourceImage, MaskImage, use4WayConnectivity, outputModeType, marginPixels, transparentBackground, backgroundColorRed, backgroundColorGreen, backgroundColorBlue, destinationFolder, filePrefix, imageFormatType)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to crop from. | — |
| MaskImageBitmap | Binary mask defining regions. | — |
| use4WayConnectivityBoolean, Optional | Whether to use 4-way connectivity. | False |
| outputModeTypeInteger, Optional | Integer representing the region export output mode. Supported outputModeType values: 0: ROI - rectangular region of interest 1: ExactShape - exact region shape 2: Binary - binary mask | 1 |
| marginPixelsInteger, Optional | Margin to add around regions. | 0 |
| transparentBackgroundBoolean, Optional | Whether to use transparent background. | True |
| backgroundColorRedInteger, Optional | Background red component (0-255). | 0 |
| backgroundColorGreenInteger, Optional | Background green component (0-255). | 0 |
| backgroundColorBlueInteger, Optional | Background blue component (0-255). | 0 |
| destinationFolderString, Optional | Folder to save exported regions. | "C:\\ExportedRegions" |
| filePrefixString, Optional | Prefix for exported file names. | "Region\_" |
| imageFormatTypeInteger, Optional | Integer representing the export image format. Supported imageFormatType values: 0: PNG 1: JPEG 2: BMP | 0 |
Integer — Number of successfully exported regions.
exported = ImgProc.CropExportRegions(bitmap, maskBitmap, False, 1, 0, True)
Calculates Euclidean distance between two points.
result = ImgProc.Distance(X1, Y1, X2, Y2)
| Parameter | Description | Default |
|---|---|---|
| X1Double | X-coordinate of first point. | — |
| Y1Double | Y-coordinate of first point. | — |
| X2Double | X-coordinate of second point. | — |
| Y2Double | Y-coordinate of second point. | — |
Double — Euclidean distance between the two points.
dist = ImgProc.Distance(0, 0, 3, 4)
Draws histogram within picture control.
result = ImgProc.Draw_Histogram(ProfileData, TotPixelCount, Pic_Target, ProfileColor)
| Parameter | Description | Default |
|---|---|---|
| ProfileDataSingle() | Array of histogram bin data. | — |
| TotPixelCountInteger | Total pixel count for normalization. | — |
| Pic_TargetPictureBox | Target picture control to draw in. Type: PictureBox; required; passed by reference. | — |
| ProfileColorColor | Color for histogram bars. | — |
Bitmap — Bitmap containing the histogram visualization, or Nothing if drawing fails.
hist = ImgProc.Draw_Histogram(data, 1000000, picTarget, Color.Blue)
Draws line profile within picture control.
result = ImgProc.Draw_LineProfile(ProfileData, Pic_Target, ProfileColor, IsCenterLined)
| Parameter | Description | Default |
|---|---|---|
| ProfileDataSingle() | Array of profile data values. | — |
| Pic_TargetPictureBox | Target picture control to draw in. Type: PictureBox; required; passed by reference. | — |
| ProfileColorColor | Color for profile line. | — |
| IsCenterLinedBoolean, Optional | Whether to draw center line. | False |
Bitmap — Bitmap containing the profile visualization, or Nothing if drawing fails.
profile = ImgProc.Draw_LineProfile(data, picTarget, Color.Red)
Extracts pixel coordinates of specified gray color.
result = ImgProc.Extract_PixelLocations(SourceGrayImage, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| GrayColorOfInterestInteger | Gray color value to find. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Point() — Array of Point coordinates matching color, or Nothing if extraction fails.
points = ImgProc.Extract_PixelLocations(grayBitmap, 128)
Extracts pixel coordinates from byte array.
result = ImgProc.Extract_PixelLocations_FromByte(SrcByteArray, GrayColorOfInterest, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SrcByteArrayByte(,) | Source byte array [height, width]. | — |
| GrayColorOfInterestInteger | Gray color value to find. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Point() — Array of Point coordinates matching color, or Nothing if extraction fails.
points = ImgProc.Extract_PixelLocations_FromByte(byteData, 128)
Extracts all skeleton points from array.
result = ImgProc.Extract_SkeletonPoints(SkeletonArray(,), foreground)
| Parameter | Description | Default |
|---|---|---|
| SkeletonArray(,)Byte | — | |
| foregroundByte | Foreground byte value. | — |
Point() — Array of skeleton points, or Nothing if extraction fails.
points = ImgProc.Extract_SkeletonPoints(skelArray, 255)
Gets average color from 3x3 box excluding target color.
result = ImgProc.Get_Avgerage_Color_3x3Box_ExceptOneColor(TargetX, TargetY, TargetColor_R, TargetColor_G, TargetColor_B, ColorChannelNum)
| Parameter | Description | Default |
|---|---|---|
| TargetXInteger | X coordinate of center pixel. | — |
| TargetYInteger | Y coordinate of center pixel. | — |
| TargetColor_RByte | Red channel of color to exclude. | — |
| TargetColor_GByte | Green channel of color to exclude. | — |
| TargetColor_BByte | Blue channel of color to exclude. | — |
| ColorChannelNumInteger | Integer representing the color channel. Supported ColorChannelNum values: 0: Red 1: Green 2: Blue | — |
Byte — Average color value for the channel, or 0 if operation fails.
avgRed = ImgProc.Get_Avgerage_Color_3x3Box_ExceptOneColor(10, 10, 0, 0, 0, 0)
Gets 2D color RGB map from image.
result = ImgProc.Get_ColorRGB2DMap(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to extract map from. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Object — 2D object array containing color RGB map, or Nothing if extraction fails.
rgbMap = ImgProc.Get_ColorRGB2DMap(bitmap)
Extracts grayscale values from image line.
result = ImgProc.Get_GrayValues(SourceImage, x1, y1, x2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to extract from. | — |
| x1Integer | Start X coordinate. | — |
| y1Integer | Start Y coordinate. | — |
| x2Integer | End X coordinate. | — |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Byte() — Array of grayscale values, or Nothing if extraction fails.
grayValues = ImgProc.Get_GrayValues(bitmap, 0, 0, 100)
Calculates histogram of image pixel intensities.
result = ImgProc.Get_Histogram(SourceImage, TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| TotalPixelCountInteger | Output total pixel count. Type: Integer; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain histogram. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Single(,) — 2D array of histogram data, or Nothing if calculation fails.
hist = ImgProc.Get_Histogram(bitmap, totalPix)
Gets pixel intensity profile along a line.
result = ImgProc.Get_LineProfile(SourceImage, StartAt, EndAt, LineThickness, IsNormalizeBy255)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to extract profile from. | — |
| StartAtPoint | Starting point of profile line. | — |
| EndAtPoint | Ending point of profile line. | — |
| LineThicknessInteger | Thickness of the profile line. | — |
| IsNormalizeBy255Boolean, Optional | Whether to normalize values by 255. | False |
Single(,) — 2D array of profile data, or Nothing if extraction fails.
profile = ImgProc.Get_LineProfile(bitmap, New Point(0, 0), New Point(100, 0), 5)
Returns maximum value among five values.
result = ImgProc.Get_MaxValue(Value1, Value2, Value3, Value4, Value5)
| Parameter | Description | Default |
|---|---|---|
| Value1Single | First value. | — |
| Value2Single | Second value. | — |
| Value3Single | Third value. | — |
| Value4Single | Fourth value. | — |
| Value5Single | Fifth value. | — |
Single — Maximum among the five values.
maxVal = ImgProc.Get_MaxValue(1.0, 2.5, 0.5, 3.0, 1.5)
Returns minimum value among five values.
result = ImgProc.Get_MinValue(Value1, Value2, Value3, Value4, Value5)
| Parameter | Description | Default |
|---|---|---|
| Value1Single | First value. | — |
| Value2Single | Second value. | — |
| Value3Single | Third value. | — |
| Value4Single | Fourth value. | — |
| Value5Single | Fifth value. | — |
Single — Minimum among the five values.
minVal = ImgProc.Get_MinValue(1.0, 2.5, 0.5, 3.0, 1.5)
Detects motion between two images.
result = ImgProc.Get_MotionDetectHits(SourceImage1, SourceImage2, StepSize, Tolerance)
| Parameter | Description | Default |
|---|---|---|
| SourceImage1Bitmap | First source image. | — |
| SourceImage2Bitmap | Second source image to compare. | — |
| StepSizeSingle | Step size for motion sampling. | — |
| ToleranceSingle | Motion detection tolerance. | — |
Single — Measure of motion detected between images.
motion = ImgProc.Get_MotionDetectHits(frame1, frame2, 1.0, 10.0)
Gets pixel color from bitmap at specified coordinates.
result = ImgProc.Get_PixelColor(SourceBitmap, TargetX, TargetY)
| Parameter | Description | Default |
|---|---|---|
| SourceBitmapBitmap | Source bitmap to sample. | — |
| TargetXInteger | X-coordinate within bitmap. | — |
| TargetYInteger | Y-coordinate within bitmap. | — |
Integer — Integer color value at specified bitmap location, or 0 if retrieval fails.
pixelColor = ImgProc.Get_PixelColor(bitmap, 50, 75)
Gets pixel color from screen at specified coordinates.
result = ImgProc.Get_PixelColor_From1PixelInScreen(TargetX, TargetY)
| Parameter | Description | Default |
|---|---|---|
| TargetXInteger | X-coordinate on screen. | — |
| TargetYInteger | Y-coordinate on screen. | — |
Integer — Integer color value at specified screen location, or 0 if retrieval fails.
pixelColor = ImgProc.Get_PixelColor_From1PixelInScreen(100, 100)
Gets pixel color from screen.
result = ImgProc.Get_PixelColor_FromScreen(TargetX, TargetY)
| Parameter | Description | Default |
|---|---|---|
| TargetXInteger | X-coordinate on screen. | — |
| TargetYInteger | Y-coordinate on screen. | — |
Integer — Integer color value at specified screen location, or 0 if retrieval fails.
pixelColor = ImgProc.Get_PixelColor_FromScreen(200, 150)
Gets individual pixel color values in multiple color spaces.
ImgProc.Get_PixelColorValues(SourceImage, X1, Y1, ReturnRed, ReturnGreen, ReturnBlue, ReturnGray, ReturnHue, ReturnSat, ReturnIntensity, ReturnCyan, ReturnMagenta, ReturnYellow, ReturnK, ReturnLab_L, ReturnLab_a, ReturnLab_b, ReturnRG_Red, ReturnRG_Green, ReturnRG_Blue)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to sample. | — |
| X1Integer | X-coordinate of pixel. | — |
| Y1Integer | Y-coordinate of pixel. | — |
| ReturnRedByte | Output red component. Type: Byte; required; passed by reference. | — |
| ReturnGreenByte | Output green component. Type: Byte; required; passed by reference. | — |
| ReturnBlueByte | Output blue component. Type: Byte; required; passed by reference. | — |
| ReturnGrayByte | Output gray value. Type: Byte; required; passed by reference. | — |
| ReturnHueSingle | Output hue. Type: Single; required; passed by reference. | — |
| ReturnSatSingle | Output saturation. Type: Single; required; passed by reference. | — |
| ReturnIntensitySingle | Output intensity. Type: Single; required; passed by reference. | — |
| ReturnCyanSingle | Output cyan. Type: Single; required; passed by reference. | — |
| ReturnMagentaSingle | Output magenta. Type: Single; required; passed by reference. | — |
| ReturnYellowSingle | Output yellow. Type: Single; required; passed by reference. | — |
| ReturnKSingle | Output K (black) in CMYK. Type: Single; required; passed by reference. | — |
| ReturnLab_LSingle | Output Lab L. Type: Single; required; passed by reference. | — |
| ReturnLab_aSingle | Output Lab a. Type: Single; required; passed by reference. | — |
| ReturnLab_bSingle | Output Lab b. Type: Single; required; passed by reference. | — |
| ReturnRG_RedSingle | Output rg chromaticity red. Type: Single; required; passed by reference. | — |
| ReturnRG_GreenSingle | Output rg chromaticity green. Type: Single; required; passed by reference. | — |
| ReturnRG_BlueSingle | Output rg chromaticity blue. Type: Single; required; passed by reference. | — |
Void
ImgProc.Get_PixelColorValues(bitmap, 50, 50, r, g, b, gray, hue, sat, int, cyan, mag, yel, k, labL, labA, labB, rgR, rgG, rgB)
Gets all white pixel locations in grayscale image.
result = ImgProc.Get_PixelLocationArray(SourceGrayImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image to analyze. | — |
| MaskImageBitmap, Optional | Optional mask to constrain search. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Point() — Array of Point coordinates for white pixels, or Nothing if search fails.
whitePoints = ImgProc.Get_PixelLocationArray(bitmap)
Gets pixel locations matching specified grayscale value.
result = ImgProc.Get_PixelLocationArray_Bk(SourceGrayImage, DestPixelGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| DestPixelGrayByte | Target grayscale value to find (0-255). | — |
| MaskImageBitmap, Optional | Optional mask to constrain search. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Point() — Array of Point coordinates, or Nothing if search fails.
points = ImgProc.Get_PixelLocationArray_Bk(bitmap, 128)
Calculates true skeleton curve length with spline.
result = ImgProc.Get_TrueSkeletonLength(SkeletonArray(,), foreground, umPerPixels, SplineVertexCount)
| Parameter | Description | Default |
|---|---|---|
| SkeletonArray(,)Byte | — | |
| foregroundByte | Foreground byte value. | — |
| umPerPixelsSingle | Micrometer per pixel ratio. | — |
| SplineVertexCountInteger | Number of spline vertices. | — |
Single — True skeleton length, or 0 if calculation fails.
length = ImgProc.Get_TrueSkeletonLength(skelArray, 255, 1.0, 100)
Converts image to grayscale and stores in 2D byte array.
result = ImgProc.GrayScaling_PutTo_2DByte(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. | — |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Byte(,) — 2D byte array (height x width), or Nothing if conversion fails.
grayArray = ImgProc.GrayScaling_PutTo_2DByte(bitmap)
Converts image to grayscale and stores in 2D integer array.
result = ImgProc.GrayScaling_PutTo_2DInt(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. | — |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Integer(,) — 2D integer array (height x width), or Nothing if conversion fails.
grayIntArray = ImgProc.GrayScaling_PutTo_2DInt(bitmap)
Converts image to grayscale and returns result from 2D integer array.
result = ImgProc.GrayScaling_ReturnImg_From_2DInt(SourceImage, Gray2DInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| Gray2DIntInteger(,) | 2D integer array (height x width) to use. | — |
| MaskImageBitmap, Optional | Optional mask to constrain processing. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed image, or Nothing if conversion fails.
result = ImgProc.GrayScaling_ReturnImg_From_2DInt(bitmap, intArray)
Checks if image is same as stored reference.
result = ImgProc.IsSameImage(IsTheFirstImage, SourceImage)
| Parameter | Description | Default |
|---|---|---|
| IsTheFirstImageBoolean | Whether to check against first or second reference. | — |
| SourceImageBitmap | Source image to check. | — |
Boolean — True if image matches reference, False otherwise.
isSame = ImgProc.IsSameImage(True, bitmap)
Quick check if image is same as stored reference.
result = ImgProc.IsSameImage_QuickCheck(IsTheFirstImage, SourceImage, x1, y1, x2)
| Parameter | Description | Default |
|---|---|---|
| IsTheFirstImageBoolean | Whether to check against first or second reference. | — |
| SourceImageBitmap | Source image to check. | — |
| x1Integer | Start X coordinate. | — |
| y1Integer | Start Y coordinate. | — |
| x2Integer | End X coordinate. | — |
Boolean — True if image matches reference, False otherwise.
isSame = ImgProc.IsSameImage_QuickCheck(True, bitmap, 0, 0, 100)
Overlays grayscale integer array values as colors on image.
result = ImgProc.Overlay_GrayIntArray_On_Image(SourceImage, Gray2DInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to overlay on. | — |
| Gray2DIntInteger(,) | 2D integer array (height x width) values. | — |
| MaskImageBitmap | Mask image. | — |
| MaskRegionBoundaryRectangle | Boundary rectangle for masked region. | — |
| IsMaskAllRegionSelectedBoolean | Whether entire region is selected. | — |
Bitmap — Image with overlay applied, or Nothing if overlay fails.
overlaid = ImgProc.Overlay_GrayIntArray_On_Image(bitmap, intArray, mask, rect, True)
Counts and classifies all color pixels.
result = ImgProc.Quantify_ColorPixel(SourceImage, Return_ColorTable(,), TotalPixelCount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to analyze. | — |
| Return_ColorTable(,)Integer | — | |
| TotalPixelCountInteger | Output total pixel count. Type: Integer; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain analysis. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Integer — Number of color classifications found, or 0 if quantification fails.
colorCount = ImgProc.Quantify_ColorPixel(bitmap, colorTbl, totPix)
Extracts basic region analysis statistics from label and color maps.
result = ImgProc.RegionExtract_BasicAnalysis(Src_IDMap(,), Src_ColorTable(,))
| Parameter | Description | Default |
|---|---|---|
| Src_IDMap(,)Integer | — | |
| Src_ColorTable(,)Byte | — |
Double(,) — 2D array of analysis statistics, or Nothing if analysis fails.
stats = ImgProc.RegionExtract_BasicAnalysis(labelMap, colorTable)
Converts label ID map to colored image representation.
result = ImgProc.RegionExtract_Convert_LabelIDMap_To_Image(LabelIDMap, ObjectRed, ObjectGreen, ObjectBlue)
| Parameter | Description | Default |
|---|---|---|
| LabelIDMapInteger(,) | Region label map. | — |
| ObjectRedByte, Optional | Red channel value for objects (0-255). | 255 |
| ObjectGreenByte, Optional | Green channel value for objects (0-255). | 255 |
| ObjectBlueByte, Optional | Blue channel value for objects (0-255). | 255 |
Bitmap — Image with regions colored, or Nothing if conversion fails.
colored = ImgProc.RegionExtract_Convert_LabelIDMap_To_Image(labelMap, 255, 0, 0)
Creates green outlined image from label map with optional dilation.
result = ImgProc.RegionExtract_Create_GreenObjectOutlineImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2, DilateBoxSize)
| Parameter | Description | Default |
|---|---|---|
| SourceLabelIDMap(,)Integer | — | |
| SourceIDINfoIndexInteger | Region ID index to extract. | — |
| x1Integer | Left boundary coordinate. | — |
| x2Integer | Right boundary coordinate. | — |
| y1Integer | Top boundary coordinate. | — |
| y2Integer | Bottom boundary coordinate. | — |
| DilateBoxSizeInteger | Size of dilation box kernel. | — |
Bitmap — Green outlined image, or Nothing if creation fails.
outline = ImgProc.RegionExtract_Create_GreenObjectOutlineImage(labelMap, 1, 0, 100, 0, 100, 3)
Creates image with region outlines overlaid on original image.
result = ImgProc.RegionExtract_Create_OutlinedOriginalImage(SourceImage, LabelIDMap, ObjectRed, ObjectGreen, ObjectBlue)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to overlay on. | — |
| LabelIDMapInteger(,) | Region label map. | — |
| ObjectRedByte, Optional | Red channel value for outlines (0-255). | 255 |
| ObjectGreenByte, Optional | Green channel value for outlines (0-255). | 255 |
| ObjectBlueByte, Optional | Blue channel value for outlines (0-255). | 255 |
Bitmap — Image with outlines overlaid, or Nothing if creation fails.
outlined = ImgProc.RegionExtract_Create_OutlinedOriginalImage(bitmap, labelMap)
Creates white outlined image from label map with optional dilation.
result = ImgProc.RegionExtract_Create_WhiteObjectOutlineImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2, DilateBoxSize)
| Parameter | Description | Default |
|---|---|---|
| SourceLabelIDMap(,)Integer | — | |
| SourceIDINfoIndexInteger | Region ID index to extract. | — |
| x1Integer | Left boundary coordinate. | — |
| x2Integer | Right boundary coordinate. | — |
| y1Integer | Top boundary coordinate. | — |
| y2Integer | Bottom boundary coordinate. | — |
| DilateBoxSizeInteger | Size of dilation box kernel. | — |
Bitmap — White outlined image, or Nothing if creation fails.
outline = ImgProc.RegionExtract_Create_WhiteObjectOutlineImage(labelMap, 1, 0, 100, 0, 100, 3)
Extracts and converts specified regions from label map to byte array.
result = ImgProc.RegionExtract_Crop_LabelIDMap_To_2DByte(LabelIDMap, IDInfoIndex, X1, X2, Y1, Y2)
| Parameter | Description | Default |
|---|---|---|
| LabelIDMapInteger(,) | Region label map. | — |
| IDInfoIndexInteger | Region ID index to extract. | — |
| X1Integer | Left boundary coordinate. | — |
| X2Integer | Right boundary coordinate. | — |
| Y1Integer | Top boundary coordinate. | — |
| Y2Integer | Bottom boundary coordinate. | — |
Byte(,) — 2D byte array of extracted region, or Nothing if extraction fails.
regionBytes = ImgProc.RegionExtract_Crop_LabelIDMap_To_2DByte(labelMap, 1, 0, 100, 0, 100)
Crops white object region from label ID map.
result = ImgProc.RegionExtract_Crop_WhiteObjectImage(SourceLabelIDMap(,), SourceIDINfoIndex, x1, x2, y1, y2)
| Parameter | Description | Default |
|---|---|---|
| SourceLabelIDMap(,)Integer | — | |
| SourceIDINfoIndexInteger | Region ID index to extract. | — |
| x1Integer | Left boundary coordinate. | — |
| x2Integer | Right boundary coordinate. | — |
| y1Integer | Top boundary coordinate. | — |
| y2Integer | Bottom boundary coordinate. | — |
Bitmap — White cropped region image, or Nothing if cropping fails.
cropped = ImgProc.RegionExtract_Crop_WhiteObjectImage(labelMap, 1, 0, 100, 0, 100)
Updates label ID map to include only specified region IDs.
result = ImgProc.RegionExtract_Update_LabelIDMap_ByIncluding(LabelIDMap, IDArray)
| Parameter | Description | Default |
|---|---|---|
| LabelIDMapInteger(,) | Region label map to update. | — |
| IDArrayDictionary(Of Integer, Boolean) | Dictionary of region IDs to include. | — |
Integer(,) — Updated label ID map, or Nothing if update fails.
filtered = ImgProc.RegionExtract_Update_LabelIDMap_ByIncluding(labelMap, idDict)
Converts label ID map values to corresponding image colors.
result = ImgProc.RegionExtract_Update_LabelIDMap_To_Image(SourceImage, LabelIDMap, RegionColorTable, IsOverlap, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to use for color reference. | — |
| LabelIDMapInteger(,) | Region label map. | — |
| RegionColorTableByte(,) | Region color table. | — |
| IsOverlapBoolean, Optional | Whether to overlap with source image. | True |
| BkColorInteger, Optional | Background color to use. | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with labels converted to colors, or Nothing if conversion fails.
coloredRegions = ImgProc.RegionExtract_Update_LabelIDMap_To_Image(bitmap, labelMap, colorTable)
Converts to binary using local adaptive threshold.
result = ImgProc.AdaptiveBinarization(SourceImage, LocalBoxSizeValue, IsObjectWhite, ThresholdLevel, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to binarize. | — |
| LocalBoxSizeValueInteger | Size of local adaptive box. | — |
| IsObjectWhiteBoolean | Whether object is white (true) or black (false). | — |
| ThresholdLevelInteger | Threshold level for binarization. | — |
| IsShowProgressBoolean, Optional | Whether to show progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain binarization. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Binarized image, or Nothing if binarization fails.
binary = ImgProc.AdaptiveBinarization(bitmap, 15, True, 10)
Applies adaptive contrast enhancement with histogram equalization.
result = ImgProc.AdaptiveContrast(SourceImage, Strength, TilesX, TilesY, ClipLimit, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to enhance. | — |
| StrengthSingle, Optional | Enhancement strength (0.0-1.0). | 0.6F |
| TilesXInteger, Optional | Number of horizontal tiles. | 8 |
| TilesYInteger, Optional | Number of vertical tiles. | 8 |
| ClipLimitSingle, Optional | Histogram clip limit. | 1.5F |
| IsShowProgressBoolean, Optional | Whether to show progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | True |
Bitmap — Contrast-enhanced image, or Nothing if enhancement fails.
enhanced = ImgProc.AdaptiveContrast(bitmap, 0.6, 8, 8, 1.5)
Adds margins to image edges with background color.
result = ImgProc.AddMargin(SourceImage, LeftMargin, RightMargin, TopMargin, BottomMargin)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to add margins to. | — |
| LeftMarginInteger | Left margin size in pixels. | — |
| RightMarginInteger | Right margin size in pixels. | — |
| TopMarginInteger | Top margin size in pixels. | — |
| BottomMarginInteger | Bottom margin size in pixels. | — |
Bitmap — Image with added margins, or Nothing if operation fails.
margined = ImgProc.AddMargin(bitmap, 10, 10, 10, 10)
Auto adjusts contrast automatically.
result = ImgProc.AutoContrast(SourceImage, ClipPercent)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to adjust. | — |
| ClipPercentSingle, Optional | Clip percentage for contrast range. | 0.5F |
Bitmap — Contrast-adjusted image, or Nothing if adjustment fails.
contrasted = ImgProc.AutoContrast(bitmap, 0.5)
Auto equalizes histogram.
result = ImgProc.AutoEqualize(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to equalize. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Histogram-equalized image, or Nothing if equalization fails.
equalized = ImgProc.AutoEqualize(bitmap)
Auto adjusts gamma curve.
result = ImgProc.AutoGamma(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to adjust. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Gamma-adjusted image, or Nothing if adjustment fails.
gammaed = ImgProc.AutoGamma(bitmap)
Auto adjusts tonal range.
result = ImgProc.AutoTone(SourceImage, ClipPercent, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to adjust. | — |
| ClipPercentSingle, Optional | Clip percentage for tonal range. | 0.5F |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Tone-adjusted image, or Nothing if adjustment fails.
toned = ImgProc.AutoTone(bitmap, 0.5)
Auto adjusts white balance.
result = ImgProc.AutoWhiteBalance(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to adjust. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — White-balanced image, or Nothing if adjustment fails.
balanced = ImgProc.AutoWhiteBalance(bitmap)
Applies box averaging (simple blur) filter.
result = ImgProc.BoxAveraging(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to blur. | — |
| BoxSizeHalfInteger | Half-size of averaging box kernel. | — |
| MaskImageBitmap, Optional | Optional mask to constrain blur. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Blurred image, or Nothing if processing fails.
blurred = ImgProc.BoxAveraging(bitmap, 2)
Adjusts brightness and contrast of image.
result = ImgProc.BrightContrast(SourceImage, BrightLevel, ContrastLevel, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to adjust. | — |
| BrightLevelInteger | Brightness adjustment level. | — |
| ContrastLevelInteger | Contrast adjustment level. | — |
| IsShowProgressBoolean, Optional | Whether to show progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain adjustment. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Adjusted image, or Nothing if adjustment fails.
brightened = ImgProc.BrightContrast(bitmap, 20, 10)
Applies Floyd-Steinberg dithering for black and white conversion.
result = ImgProc.BW_Dithering_FS(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to dither. | — |
| MaskImageBitmap, Optional | Optional mask to constrain dithering. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Dithered black and white image, or Nothing if processing fails.
dithered = ImgProc.BW_Dithering_FS(bitmap)
Applies ordered dithering for black and white conversion.
result = ImgProc.BW_Dithering_OrderedDither(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to dither. | — |
| MaskImageBitmap, Optional | Optional mask to constrain dithering. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Dithered black and white image, or Nothing if processing fails.
dithered = ImgProc.BW_Dithering_OrderedDither(bitmap)
Detects edges using Canny edge detection algorithm.
result = ImgProc.CannyEdgeDetecton(SourceImage, LocalBoxSize, SkipGrayScaling, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| LocalBoxSizeInteger | Local box size for Canny processing. | — |
| SkipGrayScalingBoolean, Optional | Whether to skip grayscale conversion. | False |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Nothing | |
| IsMaskAllRegionSelectedBoolean, Optional | True |
Bitmap — Edge-detected image, or Nothing if detection fails.
edges = ImgProc.CannyEdgeDetecton(bitmap, 3)
Converts all non-black pixels to white, creating binary image.
result = ImgProc.ChangeNonBlackToWhite(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| MaskImageBitmap, Optional | Optional mask to constrain conversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Binary image with white non-black pixels, or Nothing if processing fails.
binary = ImgProc.ChangeNonBlackToWhite(bitmap)
Composites processed image with mask on original.
result = ImgProc.CompositeWithMask(originalImage, processedImage, maskImage, processedRegion)
| Parameter | Description | Default |
|---|---|---|
| originalImageBitmap | Original source image. | — |
| processedImageBitmap | Processed result image. | — |
| maskImageBitmap | Mask image for blending. | — |
| processedRegionRectangle | Region rectangle for processing. | — |
Bitmap — Composited image, or Nothing if compositing fails.
composite = ImgProc.CompositeWithMask(origBitmap, procBitmap, maskBitmap, rect)
Converts image to 24-bit RGB bitmap.
result = ImgProc.Convert_To_24bitBitmap(SourceImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. Type: Bitmap; required; passed by reference. | — |
Bitmap — 24-bit RGB bitmap, or Nothing if conversion fails.
rgb24 = ImgProc.Convert_To_24bitBitmap(bitmap)
Converts to 24-bit RGB image.
result = ImgProc.Convert_To_24bitImage(SourceImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to convert. Type: Bitmap; required; passed by reference. | — |
Bitmap — 24-bit RGB image, or Nothing if conversion fails.
rgb24 = ImgProc.Convert_To_24bitImage(bitmap)
Corrects uneven illumination using grid-based division.
result = ImgProc.CorrectUnevenIllumination(SourceImage, GridRows, GridCols, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to correct. | — |
| GridRowsInteger, Optional | Number of grid rows. | 16 |
| GridColsInteger, Optional | Number of grid columns. | 16 |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Illumination-corrected image, or Nothing if correction fails.
corrected = ImgProc.CorrectUnevenIllumination(bitmap, 16, 16)
Creates blank image with specified background color.
result = ImgProc.Create_BlankImage(SourceImage, BackColor)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image defining dimensions. | — |
| BackColorColor | Background color to fill. | — |
Bitmap — Blank image with specified color, or Nothing if creation fails.
blank = ImgProc.Create_BlankImage(bitmap, Color.White)
Creates mask for single ellipse region.
result = ImgProc.Create_MaskEllipse(CanvasWidth, CanvasHeighT, MaskRect)
| Parameter | Description | Default |
|---|---|---|
| CanvasWidthInteger | Canvas width. | — |
| CanvasHeighTInteger | Canvas height. | — |
| MaskRectRectangle | Ellipse region for mask. | — |
Bitmap — Mask bitmap, or Nothing if creation fails.
mask = ImgProc.Create_MaskEllipse(800, 600, ellipseRect)
Creates mask for multiple ellipse regions.
result = ImgProc.Create_MaskEllipses(CanvasWidth, CanvasHeighT, MaskRects())
| Parameter | Description | Default |
|---|---|---|
| CanvasWidthInteger | Canvas width. | — |
| CanvasHeighTInteger | Canvas height. | — |
| MaskRects()Rectangle | — |
Bitmap — Mask bitmap, or Nothing if creation fails.
mask = ImgProc.Create_MaskEllipses(800, 600, ellipses())
Creates mask for single rectangle region.
result = ImgProc.Create_MaskRectangle(CanvasWidth, CanvasHeighT, MaskRect)
| Parameter | Description | Default |
|---|---|---|
| CanvasWidthInteger | Canvas width. | — |
| CanvasHeighTInteger | Canvas height. | — |
| MaskRectRectangle | Rectangle region for mask. | — |
Bitmap — Mask bitmap, or Nothing if creation fails.
mask = ImgProc.Create_MaskRectangle(800, 600, rect)
Creates mask for multiple rectangle regions.
result = ImgProc.Create_MaskRectangles(CanvasWidth, CanvasHeighT, MaskRects())
| Parameter | Description | Default |
|---|---|---|
| CanvasWidthInteger | Canvas width. | — |
| CanvasHeighTInteger | Canvas height. | — |
| MaskRects()Rectangle | — |
Bitmap — Mask bitmap, or Nothing if creation fails.
mask = ImgProc.Create_MaskRectangles(800, 600, rects())
Crops image to specified dimensions at target position.
result = ImgProc.Crop(SourceImage, nWidth, nHeight, TargetX, TargetY)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to crop. | — |
| nWidthInteger | Width of crop area in pixels. | — |
| nHeightInteger | Height of crop area in pixels. | — |
| TargetXInteger | X coordinate of top-left corner. | — |
| TargetYInteger | Y coordinate of top-left corner. | — |
Bitmap — Cropped image, or Nothing if cropping fails.
cropped = ImgProc.Crop(bitmap, 320, 240, 0, 0)
Creates deep copy of image region.
result = ImgProc.DeepCopy(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to copy. | — |
| MaskImageBitmap, Optional | Optional mask to constrain copy. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Copied image, or Nothing if copy fails.
copy = ImgProc.DeepCopy(bitmap)
Removes atmospheric haze, fog, and chamber glare to restore crisp contrast and vivid colors using a high-speed O(1) Dark Channel Prior algorithm.
result = ImgProc.Dehaze(SourceImage, PatchRadius, DehazeStrength, SaturationBoost, BrightnessBoost, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| PatchRadiusInteger, Optional | Local patch radius in pixels for haze estimation (1-150). | 25 |
| DehazeStrengthSingle, Optional | Haze removal intensity (0.0-1.0). | 0.7F |
| SaturationBoostSingle, Optional | Color saturation boost after haze removal (-1.0 to 1.0). | 0.15F |
| BrightnessBoostInteger, Optional | Additional brightness compensation (-100 to 100). | 10 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Dehaze applied, or Nothing if processing fails.
clearBmp = ImgProc.Dehaze(bitmap, 25, 0.7F, 0.15F, 10)
Expands specified outline color on grayscale image edges.
result = ImgProc.DilateOutlines(SourceGrayImage, BackgroundGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| BackgroundGrayByte | Background grayscale value. | — |
| MaskImageBitmap, Optional | Optional mask to constrain processing. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with dilated outlines, or Nothing if processing fails.
dilated = ImgProc.DilateOutlines(bitmap, 0)
Draws rectangles on image with specified color.
result = ImgProc.Draw_Rectangles(Pic_Target, SourceRectangles(), LineColor)
| Parameter | Description | Default |
|---|---|---|
| Pic_TargetBitmap | Target image to draw on. | — |
| SourceRectangles()Rectangle | — | |
| LineColorColor | Color of rectangle outlines. | — |
Bitmap — Image with drawn rectangles, or Nothing if drawing fails.
drawn = ImgProc.Draw_Rectangles(bitmap, rects, Color.Red)
Detects edges using explicit comparison method.
result = ImgProc.EdgeDetect_by_ExplicitComp(SourceImage, IsOverlay, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| IsOverlayBoolean | Whether to overlay edges on original image. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Edge-detected image, or Nothing if processing fails.
edges = ImgProc.EdgeDetect_by_ExplicitComp(bitmap, True)
Detects edges using homogeneity measure.
result = ImgProc.EdgeDetect_by_Homogenity(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Edge-detected image, or Nothing if detection fails.
edges = ImgProc.EdgeDetect_by_Homogenity(bitmap)
Detects edges using left-hand rule method.
result = ImgProc.EdgeDetect_by_LeftHand(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Edge-detected image, or Nothing if detection fails.
edges = ImgProc.EdgeDetect_by_LeftHand(bitmap)
Detects edges using Sobel operator.
result = ImgProc.EdgeDetect_by_Sobel(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Edge-detected image, or Nothing if detection fails.
edges = ImgProc.EdgeDetect_by_Sobel(bitmap)
Detects edges using upper-left hand kernel.
result = ImgProc.EdgeDetect_by_UpperLeftHand(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Edge-detected image, or Nothing if detection fails.
edges = ImgProc.EdgeDetect_by_UpperLeftHand(bitmap)
Applies emboss filter to create 3D relief effect.
result = ImgProc.Emboss(SourceImage, Angle, Distance, Strength, Bias, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to emboss. | — |
| AngleSingle, Optional | Direction of light source in degrees (0-360). | 135.0F |
| DistanceInteger, Optional | Distance of emboss effect. | 1 |
| StrengthSingle, Optional | Strength of emboss effect. | 1.0F |
| BiasInteger, Optional | Bias value for emboss calculation. | 128 |
| MaskImageBitmap, Optional | Optional mask to constrain effect. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Embossed image, or Nothing if processing fails.
embossed = ImgProc.Emboss(bitmap, 135.0, 1, 1.0, 128)
Removes specified outline color from grayscale image edges.
result = ImgProc.ErodeOutlines(SourceGrayImage, BackgroundGray, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| BackgroundGrayByte | Background grayscale value. | — |
| MaskImageBitmap, Optional | Optional mask to constrain processing. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with eroded outlines, or Nothing if processing fails.
eroded = ImgProc.ErodeOutlines(bitmap, 0)
Flips image horizontally (mirror left-right), either entirely or within a specified mask region.
result = ImgProc.Flip_Horizontal(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to flip. | — |
| MaskImageBitmap, Optional | Mask image defining the active region (blue channel = 0 for active pixels). | Nothing |
| MaskRegionBoundaryRectangle, Optional | Bounding rectangle of the selected mask region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | True to flip the entire image; False to flip only within the masked region. | True |
Bitmap — Horizontally flipped image, or Nothing if flipping fails.
flipped = ImgProc.Flip_Horizontal(bitmap)
Flips image vertically (mirror top-bottom), either entirely or within a specified mask region.
result = ImgProc.Flip_Vertical(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to flip. | — |
| MaskImageBitmap, Optional | Mask image defining the active region (blue channel = 0 for active pixels). | Nothing |
| MaskRegionBoundaryRectangle, Optional | Bounding rectangle of the selected mask region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | True to flip the entire image; False to flip only within the masked region. | True |
Bitmap — Vertically flipped image, or Nothing if flipping fails.
flipped = ImgProc.Flip_Vertical(bitmap)
Applies gamma adjustment to modify the overall brightness and contrast of the image.
result = ImgProc.GammaAdjustment(SourceImage, gammaValue, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for gamma adjustment. | — |
| gammaValueDouble | Gamma value for adjustment. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Gamma-adjusted image, or Nothing if adjustment fails.
adjusted = ImgProc.GammaAdjustment(bitmap, 1.5)
Applies Gaussian blur filter with configurable size.
result = ImgProc.GaussianFilter(SourceImage, FilterSize, WeightFactor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to blur. | — |
| FilterSizeInteger | Size of Gaussian kernel. | — |
| WeightFactorInteger, Optional | Weight factor for Gaussian (0 for default). | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain blur. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Blurred image, or Nothing if processing fails.
blurred = ImgProc.GaussianFilter(bitmap, 3, 0)
Creates blank canvas with specified dimensions and background color.
result = ImgProc.Generate_Canvas(nWidth, nHeight, BackColor)
| Parameter | Description | Default |
|---|---|---|
| nWidthInteger | Canvas width in pixels. | — |
| nHeightInteger | Canvas height in pixels. | — |
| BackColorColor | Background color for canvas. | — |
Bitmap — Blank canvas image, or Nothing if creation fails.
canvas = ImgProc.Generate_Canvas(640, 480, Color.White)
Enhances local contrast and compresses dynamic range (shadow/highlight recovery) using a high-speed O(1) Stack Blur algorithm.
result = ImgProc.HDRLocalToneMapping(SourceImage, BlurRadius, DetailStrength, ToneCompression, BrightnessBoost, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| BlurRadiusInteger, Optional | Local neighborhood radius in pixels (1-150). | 40 |
| DetailStrengthSingle, Optional | Clarity and fine-detail amplification strength (0.0-3.0). | 1.2F |
| ToneCompressionSingle, Optional | Shadow/highlight dynamic range compression strength (0.0-1.0). | 0.5F |
| BrightnessBoostInteger, Optional | Additional brightness boost applied to the final pixels (-100 to 100). | 0 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with HDR Local Tone Mapping applied, or Nothing if processing fails.
hdrBmp = ImgProc.HDRLocalToneMapping(bitmap, 40, 1.2F, 0.5F, 0)
Applies selective optical highlight bloom and analog cinema film halation to bright light sources using a high-speed O(1) Stack Blur engine.
result = ImgProc.HighlightBloomHalation(SourceImage, SpreadRadius, Threshold, BloomStrength, HalationTint, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| SpreadRadiusInteger, Optional | Diffusion radius in pixels (1-150). | 25 |
| ThresholdInteger, Optional | Luminance threshold for isolating bright highlights (0-250). | 180 |
| BloomStrengthSingle, Optional | Intensity of the highlight bloom glow (0.0-2.0). | 0.8F |
| HalationTintSingle, Optional | Red-orange cinema film halation tint ratio (0.0-1.0). | 0.0F |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Highlight Bloom & Halation applied, or Nothing if processing fails.
bloomBmp = ImgProc.HighlightBloomHalation(bitmap, 25, 180, 0.8F, 0.35F)
Sharpens multi-scale structural edges and surface textures using a high-speed O(1) High-Pass frequency extraction algorithm.
result = ImgProc.HighPassSharpening(SourceImage, Radius, Strength, Threshold, BlendMode, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| RadiusInteger, Optional | Frequency radius in pixels (1-100). | 10 |
| StrengthSingle, Optional | High-frequency detail amplification strength (0.0-2.0). | 1.0F |
| ThresholdInteger, Optional | Noise suppression threshold in pixel levels (0-50). | 3 |
| BlendModeInteger, Optional | Integer representing the blending algorithm. Supported values: 0: Overlay (Balanced) 1: SoftLight (Subtle) 2: HardLight (Intense) | 0 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with High-Pass Sharpening applied, or Nothing if processing fails.
sharpBmp = ImgProc.HighPassSharpening(bitmap, 10, 1.0F, 3, 0)
Detects circles in image using Hough transform.
result = ImgProc.HoughTransform_For_Circle(SourceImage, Radius, AngleCount, IsAbsoluteNormalization, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for circle detection. Type: Bitmap; required; passed by reference. | — |
| RadiusSingle | Circle radius to detect. | — |
| AngleCountInteger | Number of angles to check. | — |
| IsAbsoluteNormalizationBoolean | Whether to use absolute normalization. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with detected circles, or Nothing if detection fails.
circles = ImgProc.HoughTransform_For_Circle(bitmap, 50.0, 360, True)
Detects lines in image using Hough transform.
result = ImgProc.HoughTransform_For_Line(SourceImage, UserMaxCount, IsAbsoluteNormalization, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for line detection. Type: Bitmap; required; passed by reference. | — |
| UserMaxCountInteger | Maximum line count to detect. | — |
| IsAbsoluteNormalizationBoolean | Whether to use absolute normalization. | — |
| MaskImageBitmap, Optional | Optional mask to constrain detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with detected lines, or Nothing if detection fails.
lines = ImgProc.HoughTransform_For_Line(bitmap, 10, True)
Loads image from file path.
result = ImgProc.Image_FromFile(FileName)
| Parameter | Description | Default |
|---|---|---|
| FileNameString | Path to image file. | — |
Bitmap — Loaded image as Bitmap, or Nothing if loading fails.
bitmap = ImgProc.Image_FromFile("C:\\Images\\photo.jpg")
Stamps overlay image on source with transformation.
result = ImgProc.ImageStamp(SourceImage, StampImage, destRectX, destRectY, destRectWidth, destRectHeight, angle, opacityPercent, enableTransparentColor, transparentColorArgb, enableFeather, featherRadius, enableGradualAlpha, tolerance)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to stamp on. | — |
| StampImageBitmap | Stamp image to overlay. | — |
| destRectXSingle | Destination rectangle X. | — |
| destRectYSingle | Destination rectangle Y. | — |
| destRectWidthSingle | Destination rectangle width. | — |
| destRectHeightSingle | Destination rectangle height. | — |
| angleSingle, Optional | Rotation angle in degrees. | 0.0F |
| opacityPercentInteger, Optional | Opacity percentage (0-100). | 100 |
| enableTransparentColorBoolean, Optional | Whether to enable transparent color. | False |
| transparentColorArgbInteger, Optional | ARGB color value for transparency. | -1 |
| enableFeatherBoolean, Optional | Whether to enable edge feathering. | False |
| featherRadiusInteger, Optional | Feather radius in pixels. | 10 |
| enableGradualAlphaBoolean, Optional | Whether to enable gradual alpha. | False |
| toleranceInteger, Optional | Color tolerance threshold. | 30 |
Bitmap — Stamped image, or Nothing if stamping fails.
stamped = ImgProc.ImageStamp(bitmap, stampBitmap, 10, 10, 100, 100, 0, 100)
Inverts image colors (photographic negative).
result = ImgProc.Invert(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to invert. | — |
| MaskImageBitmap, Optional | Optional mask to constrain inversion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Inverted image, or Nothing if inversion fails.
inverted = ImgProc.Invert(bitmap)
Converts image to binary using manual threshold value.
result = ImgProc.ManualBinarization(SourceImage, ThresholdValue, SkipGrayScaling, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to binarize. | — |
| ThresholdValueInteger | Threshold value for binarization (0-255). | — |
| SkipGrayScalingBoolean, Optional | Whether to skip grayscale conversion. | False |
| IsShowProgressBoolean, Optional | Whether to display progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain binarization. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Binary image, or Nothing if binarization fails.
binary = ImgProc.ManualBinarization(bitmap, 128)
Simulates a tilt-shift miniature lens effect with smooth depth-of-field blurring and saturation enhancement.
result = ImgProc.MiniatureEffect(SourceImage, BlurRadius, FocusPosition, FocusSize, SaturationBoost, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| BlurRadiusInteger, Optional | Out-of-focus blur radius in pixels (1-150). | 25 |
| FocusPositionSingle, Optional | Vertical center position of the sharp focus zone (0.0-1.0). | 0.5F |
| FocusSizeSingle, Optional | Relative height of the sharp focus band (0.05-0.80). | 0.25F |
| SaturationBoostSingle, Optional | Color vibrancy boost (-1.0 to 1.0). | 0.25F |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Miniature Effect applied, or Nothing if processing fails.
miniBmp = ImgProc.MiniatureEffect(bitmap, 25, 0.5F, 0.25F, 0.25F)
Applies mosaic or pixelation effect to blur regions.
result = ImgProc.MosaicFilter(SourceImage, isPixelMode, value, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| isPixelModeBoolean | Whether to use pixel mode. | — |
| valueInteger | Mosaic block size or pixel value. | — |
| MaskImageBitmap, Optional | Optional mask to constrain effect. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Mosaiced image, or Nothing if processing fails.
mosaiced = ImgProc.MosaicFilter(bitmap, True, 10)
Applies multiband color processing adjusting saturation and intensity by color band.
result = ImgProc.MultibandColor(original, rSat, rInt, ySat, yInt, gSat, gInt, cSat, cyanInt, bSat, bInt, mSat, mInt, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| originalBitmap | Source image to process. | — |
| rSatInteger | Red saturation adjustment (-100 to 100). | — |
| rIntInteger | Red intensity adjustment (-100 to 100). | — |
| ySatInteger | Yellow saturation adjustment (-100 to 100). | — |
| yIntInteger | Yellow intensity adjustment (-100 to 100). | — |
| gSatInteger | Green saturation adjustment (-100 to 100). | — |
| gIntInteger | Green intensity adjustment (-100 to 100). | — |
| cSatInteger | Cyan saturation adjustment (-100 to 100). | — |
| cyanIntInteger | Cyan intensity adjustment (-100 to 100). | — |
| bSatInteger | Blue saturation adjustment (-100 to 100). | — |
| bIntInteger | Blue intensity adjustment (-100 to 100). | — |
| mSatInteger | Magenta saturation adjustment (-100 to 100). | — |
| mIntInteger | Magenta intensity adjustment (-100 to 100). | — |
| MaskImageImage, Optional | Optional mask to constrain processing. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Color-adjusted image, or Nothing if processing fails.
mbcolor = ImgProc.MultibandColor(bitmap, 10, 5, -5, 10, 0, 0, 5, 0, -10, 5, 0, 0)
Applies a dreamy, painterly luminescence (Orton Effect) by combining overexposed sharp and blurred layers via Multiply blending.
result = ImgProc.OrtonEffect(SourceImage, BlurRadius, GlowStrength, ExposureBoost, BrightnessBoost, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| BlurRadiusInteger, Optional | Blur radius for the glow diffusion in pixels (1-150). | 25 |
| GlowStrengthSingle, Optional | Overall blending opacity of the Orton effect (0.0-1.0). | 0.6F |
| ExposureBoostSingle, Optional | Highlight overexposure boost in the Screen pass (0.0-1.0). | 0.7F |
| BrightnessBoostInteger, Optional | Additional brightness boost applied to the final pixels (-100 to 100). | 0 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Orton Effect applied, or Nothing if processing fails.
ortonBmp = ImgProc.OrtonEffect(bitmap, 25, 0.6F, 0.7F, 0)
Applies edge detection (outline) filter to extract object boundaries while always preserving the original pixel colors on the extracted outlines.
result = ImgProc.Outline(SourceImage, InvertBinarization, ApplyBinarization, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for edge detection. | — |
| InvertBinarizationBoolean, Optional | Whether to invert the binarization or background result (e.g., dark objects on a light background). | False |
| ApplyBinarizationBoolean, Optional | Whether to apply threshold-based pre-binarization for boundary detection. Set to False to skip binarization and extract boundaries directly from all non-zero color regions (e.g., after Region Coloring) without brightness threshold loss. Original outline colors are preserved in both modes. | True |
| IsShowProgressBoolean, Optional | Whether to display progress. | False |
| MaskImageBitmap, Optional | Optional mask to constrain edge detection. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Edge-detected image with original pixel colors preserved on the outlines, or Nothing if processing fails.
edges = ImgProc.Outline(bitmap, False, False, False)
Overlays 3D byte mask to image with transparency.
result = ImgProc.Overlay_Mask3DByte_To_Image(SourceImage, SourceMaskImage3DByte, TransparentColor, Opacity, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to overlay. Type: Bitmap; required; passed by reference. | — |
| SourceMaskImage3DByteByte(,,) | 3D byte array mask [height, width, channels]. Type: Byte(,,); required; passed by reference. | — |
| TransparentColorInteger | Color to treat as transparent. | — |
| OpacitySingle | Opacity level (0.0-1.0). | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Overlaid image, or Nothing if overlay fails.
overlaid = ImgProc.Overlay_Mask3DByte_To_Image(bitmap, maskArray, RGB(255,255,255), 0.5)
Overlays 2D mask array on 3D image array.
ImgProc.Overlay_MaskImage2DArray_To_Image3DArray(SourceImage2DArray(,,), MaskImage2DArray, MaskRed, MaskGreen, MaskBlue, x1, y1, TransparentColor)
| Parameter | Description | Default |
|---|---|---|
| SourceImage2DArray(,,)Byte | — | |
| MaskImage2DArrayByte(,) | 2D byte array mask [height, width]. Type: Byte(,); required; passed by reference. | — |
| MaskRedByte | Red channel value for mask. | — |
| MaskGreenByte | Green channel value for mask. | — |
| MaskBlueByte | Blue channel value for mask. | — |
| x1Integer | Start X coordinate. | — |
| y1Integer | Start Y coordinate. | — |
| TransparentColorByte | Transparent color value. | — |
Void — None.
ImgProc.Overlay_MaskImage2DArray_To_Image3DArray(imageArray, maskArray, 255, 0, 0, 0, 0, 255)
Overlays mask bitmap to image with transparency.
result = ImgProc.Overlay_MaskImage_To_Image(SourceImage, SourceMaskImage, TransparentColor, Opacity)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to overlay. Type: Bitmap; required; passed by reference. | — |
| SourceMaskImageBitmap | Mask image to overlay. Type: Bitmap; required; passed by reference. | — |
| TransparentColorInteger | Color to treat as transparent. | — |
| OpacitySingle | Opacity level (0.0-1.0). | — |
Bitmap — Overlaid image, or Nothing if overlay fails.
overlaid = ImgProc.Overlay_MaskImage_To_Image(bitmap, maskBitmap, RGB(255,255,255), 0.5)
Overlays another image with transparency and feathering.
result = ImgProc.OverlayImage(SourceImage, overlayImg, transR, transG, transB, opacity, isFeather, featherRadius, tolerance, isGradual, MaskImage, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for overlay. | — |
| overlayImgBitmap | Image to overlay on source. | — |
| transRInteger, Optional | Transparent red component (0-255). | 255 |
| transGInteger, Optional | Transparent green component (0-255). | 255 |
| transBInteger, Optional | Transparent blue component (0-255). | 255 |
| opacitySingle, Optional | Opacity factor (0.0-1.0). | 1.0F |
| isFeatherBoolean, Optional | Whether to apply edge feathering. | False |
| featherRadiusInteger, Optional | Feather radius in pixels. | 10 |
| toleranceInteger, Optional | Color tolerance threshold (0-255). | 0 |
| isGradualBoolean, Optional | Whether to apply gradual blending. | False |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Overlaid image, or Nothing if operation fails.
overlaid = ImgProc.OverlayImage(bitmap, overlayBitmap, 255, 255, 255, 1.0, False, 10)
Overlays mask with color and alpha transparency.
result = ImgProc.OverlayMask_Parallel(sourceImage, maskImage, overlayColor, alpha)
| Parameter | Description | Default |
|---|---|---|
| sourceImageBitmap | Source image to overlay. | — |
| maskImageBitmap | Mask image. | — |
| overlayColorColor | Color for overlay. | — |
| alphaInteger | Alpha transparency value. | — |
Bitmap — Overlaid image, or Nothing if overlay fails.
overlaid = ImgProc.OverlayMask_Parallel(bitmap, maskBitmap, Color.Red, 128)
Pastes and fits overlay image into target rectangle.
result = ImgProc.PasteAndFitToRectangle(BaseImage, OverlayImage, TargetRect)
| Parameter | Description | Default |
|---|---|---|
| BaseImageBitmap | Base image to paste on. | — |
| OverlayImageBitmap | Overlay image to paste. | — |
| TargetRectRectangle | Target rectangle for pasting. | — |
Bitmap — Pasted and fitted image, or Nothing if operation fails.
pasted = ImgProc.PasteAndFitToRectangle(baseImage, overlayImage, New Rectangle(10, 10, 100, 100))
Remaps image using coordinate maps.
result = ImgProc.Remap(SourceImage, mapX, mapY, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to remap. | — |
| mapXSingle(,) | X coordinate map. | — |
| mapYSingle(,) | Y coordinate map. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Remapped image, or Nothing if remapping fails.
remapped = ImgProc.Remap(bitmap, xMap, yMap)
Removes background using matte with optional replacement.
result = ImgProc.RemoveBackground(SourceImage, MatteImage, MaskRegionBoundary, IsMaskAllRegionSelected, BgColor, NewBackgroundImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| MatteImageBitmap | Matte/alpha mask image. | — |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
| BgColorColor, Optional | Background color replacement. | Nothing |
| NewBackgroundImageBitmap, Optional | New background image to composite. | Nothing |
Bitmap — Image with background removed, or Nothing if operation fails.
noBackground = ImgProc.RemoveBackground(bitmap, matteBitmap)
Resizes image to specified width and height.
result = ImgProc.Resize(SourceImage, nWidth, nHeight, InterpolationMode)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to resize. | — |
| nWidthInteger | Target width in pixels. | — |
| nHeightInteger | Target height in pixels. | — |
| InterpolationModeDrawing2D.InterpolationMode, Optional | Enum representing the interpolation method. Type: Drawing2D.InterpolationMode; optional; default: HighQualityBicubic. Supported InterpolationMode values: 0: Default 1: Low 2: High 3: Bilinear 4: Bicubic 5: NearestNeighbor 6: HighQualityBilinear 7: HighQualityBicubic | Drawing2D.InterpolationMode.HighQualityBicubic |
Bitmap — Resized image, or Nothing if resizing fails.
resized = ImgProc.Resize(bitmap, 640, 480)
Resizes canvas and places the image within new dimensions.
result = ImgProc.Resize_Canvas(SourceImage, nWidth, nHeight, StretchDirection, BackColor)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to resize. | — |
| nWidthInteger | New canvas width. | — |
| nHeightInteger | New canvas height. | — |
| StretchDirectionString | Image placement on the resized canvas. Supported values: "LeftTop": Place image at the top-left corner "RightTop": Place image at the top-right corner "LeftBottom": Place image at the bottom-left corner "RightBottom": Place image at the bottom-right corner Any other value (e.g., "Center"): Place image at the center | — |
| BackColorColor | Background fill color. | — |
Bitmap — Resized canvas image, or Nothing if resizing fails.
resized = ImgProc.Resize_Canvas(bitmap, 640, 480, "Center", Color.White)
Resizes image by specified zoom factor (e.g., 0.5 for 50%, 2.0 for 200%).
result = ImgProc.ResizeByZoomFactor(SourceImage, ZoomFactor, InterpolationMode)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to resize. | — |
| ZoomFactorSingle | Zoom factor multiplier. | — |
| InterpolationModeDrawing2D.InterpolationMode, Optional | Enum representing the interpolation method. Type: Drawing2D.InterpolationMode; optional; default: HighQualityBicubic. Supported InterpolationMode values: 0: Default 1: Low 2: High 3: Bilinear 4: Bicubic 5: NearestNeighbor 6: HighQualityBilinear 7: HighQualityBicubic | Drawing2D.InterpolationMode.HighQualityBicubic |
Bitmap — Resized image, or Nothing if resizing fails.
resized = ImgProc.ResizeByZoomFactor(bitmap, 0.5)
Removes background using rolling box filter.
result = ImgProc.RollingBoxBackgroundSubtraction(SourceImage, Radius, IsAutomatic, IsObjectWhite, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| RadiusInteger | Rolling box radius. | — |
| IsAutomaticBoolean, Optional | Whether to use automatic mode. | False |
| IsObjectWhiteBoolean, Optional | Whether object is white or black. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Background-subtracted image, or Nothing if operation fails.
subtracted = ImgProc.RollingBoxBackgroundSubtraction(bitmap, 50)
Rotates image around specified center point by angle in degrees, either entirely or within a specified mask region.
result = ImgProc.Rotate(SourceImage, CenterX, CenterY, AngleDegree, BackgroundColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to rotate. | — |
| CenterXInteger | X coordinate of rotation center. | — |
| CenterYInteger | Y coordinate of rotation center. | — |
| AngleDegreeSingle | Rotation angle in degrees. | — |
| BackgroundColorColor | Fill color for empty areas after rotation. | — |
| MaskImageBitmap, Optional | Mask image defining the active region (blue channel = 0 for active pixels). | Nothing |
| MaskRegionBoundaryRectangle, Optional | Bounding rectangle of the selected mask region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | True to rotate the entire image; False to rotate only within the masked region. | True |
Bitmap — Rotated image, or Nothing if rotation fails.
rotated = ImgProc.Rotate(bitmap, 320, 240, 45.0, Color.White)
Rotates image around its center by specified angle in degrees.
result = ImgProc.RotateAtCenter(SourceImage, AngleDegree)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to rotate. | — |
| AngleDegreeSingle | Rotation angle in degrees. | — |
Bitmap — Rotated image, or Nothing if rotation fails.
rotated = ImgProc.RotateAtCenter(bitmap, 45.0)
Applies rotation and flip transformation to image.
result = ImgProc.RotateFlip(SourceImage, RotateFlipOption)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to transform. | — |
| RotateFlipOptionRotateFlipType | Type of rotation and flip operation. Supported values: 0: RotateNoneFlipNone - No rotation, no flip 1: Rotate90FlipNone - Rotate 90 degrees clockwise 2: Rotate180FlipNone - Rotate 180 degrees 3: Rotate270FlipNone - Rotate 270 degrees clockwise 4: RotateNoneFlipX - Flip horizontally 5: Rotate90FlipX - Rotate 90 degrees, then flip horizontally 6: Rotate180FlipX - Rotate 180 degrees, then flip horizontally (same as flip vertically) 7: Rotate270FlipX - Rotate 270 degrees, then flip horizontally | — |
Bitmap — Transformed image, or Nothing if transformation fails.
transformed = ImgProc.RotateFlip(bitmap, RotateFlipType.Rotate90FlipNone)
Adjusts shadows and highlights separately.
result = ImgProc.ShadowsHighlights(SourceImage, ShadowAmount, HighlightAmount, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to adjust. | — |
| ShadowAmountSingle, Optional | Shadow adjustment amount. | 50.0F |
| HighlightAmountSingle, Optional | Highlight adjustment amount. | 0.0F |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Adjusted image, or Nothing if adjustment fails.
adjusted = ImgProc.ShadowsHighlights(bitmap, 50.0, 0.0)
Sharpens image using basic 3x3 kernel.
result = ImgProc.Sharpen_3x3(SourceImage, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to sharpen. | — |
| MaskImageBitmap, Optional | Optional mask to constrain sharpening. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Sharpened image, or Nothing if processing fails.
sharpened = ImgProc.Sharpen_3x3(bitmap)
Sharpens image using improved 3x3 kernel with adjustable strength.
result = ImgProc.Sharpen_3x3_Improved(SourceImage, Strength, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to sharpen. | — |
| StrengthSingle, Optional | Sharpening strength factor. | 1.0F |
| MaskImageBitmap, Optional | Optional mask to constrain sharpening. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Sharpened image, or Nothing if processing fails.
sharpened = ImgProc.Sharpen_3x3_Improved(bitmap, 1.5)
Sharpens image using high-quality 5x5 kernel.
result = ImgProc.Sharpen_5x5_HighQuality_Fixed(SourceImage, Strength, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to sharpen. | — |
| StrengthSingle, Optional | Sharpening strength factor. | 1.0F |
| MaskImageBitmap, Optional | Optional mask to constrain sharpening. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — High-quality sharpened image, or Nothing if processing fails.
sharpened = ImgProc.Sharpen_5x5_HighQuality_Fixed(bitmap, 1.2)
Sharpens image using unsharp mask technique.
result = ImgProc.Sharpen_UnsharpMask(SourceImage, FilterSize, AmountPercent, Threshold, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to sharpen. | — |
| FilterSizeInteger, Optional | Filter kernel size. | 11 |
| AmountPercentInteger, Optional | Sharpening amount percentage. | 100 |
| ThresholdInteger, Optional | Edge detection threshold. | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Sharpened image, or Nothing if sharpening fails.
sharpened = ImgProc.Sharpen_UnsharpMask(bitmap, 11, 100, 0)
Applies smart noise reduction preserving edges.
result = ImgProc.SmartDenoise(SourceImage, Radius, Threshold, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to denoise. | — |
| RadiusInteger, Optional | Filter radius. | 5 |
| ThresholdInteger, Optional | Edge preservation threshold. | 30 |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Denoised image, or Nothing if denoising fails.
denoised = ImgProc.SmartDenoise(bitmap, 5, 30)
Converts the image into a fine pencil sketch or colored-pencil technical line art using a high-speed O(1) Color Dodge algorithm.
result = ImgProc.SmartSketch(SourceImage, StrokeWidth, PencilDarkness, ColorBlend, PaperBrightness, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| StrokeWidthInteger, Optional | Stroke width (blur radius) in pixels (1-100). | 15 |
| PencilDarknessSingle, Optional | Graphite line darkness and shading intensity (0.01-1.0). | 0.5F |
| ColorBlendSingle, Optional | Original color blending ratio (0.0 for pure grayscale sketch, up to 1.0 for colored-pencil look). | 0.0F |
| PaperBrightnessInteger, Optional | Background paper brightness adjustment (-100 to 100). | 0 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Smart Sketch applied, or Nothing if processing fails.
sketchBmp = ImgProc.SmartSketch(bitmap, 15, 0.5F, 0.0F, 0)
Applies a dreamy, radiant luminescence effect using a high-speed O(1) Stack Blur and Screen/SoftLight blending.
result = ImgProc.SoftGlow(SourceImage, BlurRadius, GlowStrength, BrightnessBoost, BlendMode, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| BlurRadiusInteger, Optional | Blur radius for the glow diffusion in pixels (1-150). | 20 |
| GlowStrengthSingle, Optional | Blending strength (opacity) of the glow layer (0.0-1.0). | 0.45F |
| BrightnessBoostInteger, Optional | Additional brightness boost applied to the final blended pixels (-100 to 100). | 5 |
| BlendModeInteger, Optional | Integer representing the blending algorithm used to combine the glow layer with the base image. Supported values: 0: Screen (Bright & Airy) 1: SoftLight (Gentle Contrast) | 0 |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed Bitmap with Soft Glow applied, or Nothing if processing fails.
glowing = ImgProc.SoftGlow(bitmap, 20, 0.45F, 5, 0)
Applies high-speed stack blur filter.
result = ImgProc.StackBlur(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to blur. | — |
| BoxSizeHalfInteger | Blur radius (half-size). | — |
| MaskImageBitmap, Optional | Optional mask to constrain blur. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Blurred image, or Nothing if processing fails.
blurred = ImgProc.StackBlur(bitmap, 5)
Applies custom convolution filter mask to image.
result = ImgProc.StandardFilter(SourceImage, FilterMask(,), WeightFactor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to filter. | — |
| FilterMask(,)Single | — | |
| WeightFactorInteger, Optional | Weight factor for filter (0 for default). | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain filtering. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Filtered image, or Nothing if processing fails.
filtered = ImgProc.StandardFilter(bitmap, {{0,1,0},{1,-4,1},{0,1,0}})
Annotates image with text and outline style.
result = ImgProc.TextAnnotation(SourceImage, x, y, textString, fontName, fontSize, fontStyleInt, innerColorArgb, outerColorArgb, opacityPercent, outlineThickness, angle, isAntiAlias)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to annotate. | — |
| xSingle | Text X position. | — |
| ySingle | Text Y position. | — |
| textStringString | Text content to draw. | — |
| fontNameString, Optional | Font name. | "Microsoft Sans Serif" |
| fontSizeSingle, Optional | Font size in points. | 70.0F |
| fontStyleIntInteger, Optional | Integer representing the font style. Supported fontStyleInt values: 0: Regular 1: Bold 2: Italic 3: Bold Italic 4: Underline 8: Strikeout | 0 |
| innerColorArgbInteger, Optional | Inner text color ARGB. | -1 |
| outerColorArgbInteger, Optional | Outline color ARGB. | -16777216 |
| opacityPercentInteger, Optional | Opacity percentage (0-100). | 100 |
| outlineThicknessSingle, Optional | Outline thickness in pixels. | 10.0F |
| angleSingle, Optional | Text rotation angle in degrees. | 0.0F |
| isAntiAliasBoolean, Optional | Whether to use anti-aliasing. | True |
Bitmap — Annotated image, or Nothing if annotation fails.
annotated = ImgProc.TextAnnotation(bitmap, 10, 10, "Hello", "Arial", 70, 0, -1, -16777216)
Performs binary AND operation on two grayscale images.
result = ImgProc.BinaryOperation_AND(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImage1Bitmap | First grayscale image. Type: Bitmap; required; passed by reference. | — |
| SourceGrayImage2Bitmap | Second grayscale image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Result of AND operation, or Nothing if operation fails.
andResult = ImgProc.BinaryOperation_AND(grayBitmap1, grayBitmap2)
Performs binary OR operation on two grayscale images.
result = ImgProc.BinaryOperation_OR(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImage1Bitmap | First grayscale image. Type: Bitmap; required; passed by reference. | — |
| SourceGrayImage2Bitmap | Second grayscale image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Result of OR operation, or Nothing if operation fails.
orResult = ImgProc.BinaryOperation_OR(grayBitmap1, grayBitmap2)
Performs binary XOR operation on two grayscale images.
result = ImgProc.BinaryOperation_XOR(SourceGrayImage1, SourceGrayImage2, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImage1Bitmap | First grayscale image. Type: Bitmap; required; passed by reference. | — |
| SourceGrayImage2Bitmap | Second grayscale image. Type: Bitmap; required; passed by reference. | — |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Result of XOR operation, or Nothing if operation fails.
xorResult = ImgProc.BinaryOperation_XOR(grayBitmap1, grayBitmap2)
Applies black-white leveling with optional auto thresholding.
result = ImgProc.BWLeveling_Using_FloodFillWithTolerance(SourceGrayImage, IsConductBlurring, IsFindThresholdValue, DefaultThresholdValue, Return_OptimalThresholdValue)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| IsConductBlurringBoolean | Whether to conduct blurring. | — |
| IsFindThresholdValueBoolean | Whether to auto-find threshold. | — |
| DefaultThresholdValueInteger | Default threshold value if not auto-finding. | — |
| Return_OptimalThresholdValueInteger | Output optimal threshold value. Type: Integer; required; passed by reference. | — |
Bitmap — Leveled black-white image, or Nothing if leveling fails.
bwImage = ImgProc.BWLeveling_Using_FloodFillWithTolerance(grayBitmap, True, True, 128, optThreshold)
Applies black-white leveling excluding specified gray range.
result = ImgProc.BWLeveling_Using_FloodFillWithTolerance_Core(SourceGrayImage, ExcludeGrayRange_Min, ExcludeGrayRange_Max)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| ExcludeGrayRange_MinInteger | Minimum gray value to exclude. | — |
| ExcludeGrayRange_MaxInteger | Maximum gray value to exclude. | — |
Bitmap — Leveled black-white image, or Nothing if leveling fails.
bwImage = ImgProc.BWLeveling_Using_FloodFillWithTolerance_Core(grayBitmap, 100, 150)
Checks if shape is closed (no gaps).
result = ImgProc.Check_If_CloseShape(Src_BitMap(,), FalseTolerance)
| Parameter | Description | Default |
|---|---|---|
| Src_BitMap(,)Boolean | — | |
| FalseToleranceInteger, Optional | Tolerance for false detection. | 2 |
Boolean — True if shape is closed, False otherwise.
isClosed = ImgProc.Check_If_CloseShape(boolMap, 2)
Applies dilation morphological operation to expand bright regions.
result = ImgProc.Dilate(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to dilate. | — |
| BoxSizeHalfInteger | Half-size of dilation kernel. | — |
| MaskImageBitmap, Optional | Optional mask to constrain dilation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Dilated image, or Nothing if processing fails.
dilated = ImgProc.Dilate(bitmap, 1)
Applies erosion morphological operation to reduce bright regions.
result = ImgProc.Erode(SourceImage, BoxSizeHalf, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to erode. | — |
| BoxSizeHalfInteger | Half-size of erosion kernel. | — |
| MaskImageBitmap, Optional | Optional mask to constrain erosion. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Eroded image, or Nothing if processing fails.
eroded = ImgProc.Erode(bitmap, 1)
Finds optimal threshold for black-white leveling using flood fill.
result = ImgProc.Find_OptimalThreshold_For_BWLeveling_Using_FloodFillWithTolerance(SourceGrayImage, Return_BWGrayImage)
| Parameter | Description | Default |
|---|---|---|
| SourceGrayImageBitmap | Source grayscale image. | — |
| Return_BWGrayImageBitmap | Output binary image. Type: Bitmap; required; passed by reference. | — |
Integer — Optimal threshold value, or 0 if finding fails.
threshold = ImgProc.Find_OptimalThreshold_For_BWLeveling_Using_FloodFillWithTolerance(grayBitmap, bwImage)
Applies region coloring (blob coloring) to the image using a high-speed parallel algorithm.
result = ImgProc.RegionColoring(SourceImage, Is8Connected, ApplyBinarization, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to color regions. | — |
| Is8ConnectedBoolean | Whether to use 8-connectivity. | — |
| ApplyBinarizationBoolean, Optional | Whether to apply binarization. | False |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with colored regions, or Nothing if operation fails.
colored = ImgProc.RegionColoring(bitmap, True, False)
Extracts color-based connected regions using 4-connectivity flood fill.
result = ImgProc.RegionExtract_ColorFloodFill4(SourceImage, LabelIDMap, RegionColorTable, BoundaryColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for region extraction. | — |
| LabelIDMapInteger(,) | Output 2D array of region labels. | — |
| RegionColorTableByte(,) | Output table of region colors. | — |
| BoundaryColorInteger, Optional | Boundary color integer. | 16776960 |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with color-labeled regions, or Nothing if extraction fails.
colorRegions = ImgProc.RegionExtract_ColorFloodFill4(bitmap, labels, colors)
Extracts color-based connected regions using 8-connectivity flood fill.
result = ImgProc.RegionExtract_ColorFloodFill8(SourceImage, LabelIDMap, RegionColorTable, BoundaryColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for region extraction. | — |
| LabelIDMapInteger(,) | Output 2D array of region labels. | — |
| RegionColorTableByte(,) | Output table of region colors. | — |
| BoundaryColorInteger, Optional | Boundary color integer. | 16776960 |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with color-labeled regions, or Nothing if extraction fails.
colorRegions = ImgProc.RegionExtract_ColorFloodFill8(bitmap, labels, colors)
Extracts connected regions using 4-connectivity flood fill with label mapping.
result = ImgProc.RegionExtract_FloodFill4(SourceImage, LabelIDMap, RegionColorTable, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for region extraction. | — |
| LabelIDMapInteger(,) | Output 2D array of region labels. | — |
| RegionColorTableByte(,) | Output table of region colors. | — |
| BkColorInteger, Optional | Background color to identify. | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with labeled regions, or Nothing if extraction fails.
regionMap = ImgProc.RegionExtract_FloodFill4(bitmap, labels, colors)
Extracts connected regions using 8-connectivity flood fill with label mapping.
result = ImgProc.RegionExtract_FloodFill8(SourceImage, LabelIDMap, RegionColorTable, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for region extraction. | — |
| LabelIDMapInteger(,) | Output 2D array of region labels. | — |
| RegionColorTableByte(,) | Output table of region colors. | — |
| BkColorInteger, Optional | Background color to identify. | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with labeled regions, or Nothing if extraction fails.
regionMap = ImgProc.RegionExtract_FloodFill8(bitmap, labels, colors)
Extracts regions using raster scanning algorithm with optional mask support.
result = ImgProc.RegionExtract_RasterScanning(SourceImage, LabelIDMap, RegionColorTable, BkColor, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for region extraction. | — |
| LabelIDMapInteger(,) | Output 2D array of region labels. | — |
| RegionColorTableByte(,) | Output table of region colors. | — |
| BkColorInteger, Optional | Background color to identify. | 0 |
| MaskImageBitmap, Optional | Optional mask to constrain extraction. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with labeled regions, or Nothing if extraction fails.
regions = ImgProc.RegionExtract_RasterScanning(bitmap, labels, colors)
Extracts regions using raster scanning algorithm without mask image.
result = ImgProc.RegionExtract_RasterScanning_NoMaskImage(SourceImage, LabelIDMap, RegionColorTable, BkColor)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image for region extraction. | — |
| LabelIDMapInteger(,) | Output 2D array of region labels. | — |
| RegionColorTableByte(,) | Output table of region colors. | — |
| BkColorInteger, Optional | Background color to identify. | 0 |
Bitmap — Image with labeled regions, or Nothing if extraction fails.
regions = ImgProc.RegionExtract_RasterScanning_NoMaskImage(bitmap, labels, colors)
Removes small isolated dots or noise from the image using parallel processing.
result = ImgProc.RemoveDots(SourceImage, DotMode, Is8Connected, MaxDotSize, ApplyBinarization, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to process. | — |
| DotModeInteger | Dot removal mode. Supported values: 0: Remove black dots (filled with white) 1: Remove white dots (filled with black) 2: Remove both black and white dots (filled with the opposite color) | — |
| Is8ConnectedBoolean | Whether to use 8-connectivity. | — |
| MaxDotSizeInteger | Maximum size of dots to remove. | — |
| ApplyBinarizationBoolean, Optional | Whether to apply binarization. | True |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Processed image with dots removed, or Nothing if operation fails.
cleaned = ImgProc.RemoveDots(bitmap, 0, True, 10, True)
Reduces binary objects to 1-pixel wide skeletons using parallel processing.
result = ImgProc.Skeletonize(SourceImage, IsExtended, IsInverted, MinBranchLength, TailLength, ApplyBinarization, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to skeletonize. | — |
| IsExtendedBoolean | Whether to use extended skeletonization. | — |
| IsInvertedBoolean | Whether to invert the image before processing. | — |
| MinBranchLengthInteger | Minimum branch length in pixels. | — |
| TailLengthInteger | Tail length for pruning. | — |
| ApplyBinarizationBoolean, Optional | Whether to apply binarization. | True |
| IsShowProgressBoolean, Optional | Whether to show processing progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Skeletonized image, or Nothing if operation fails.
skeleton = ImgProc.Skeletonize(bitmap, True, False, 10, 5, True)
Splits connected objects using convexity defects.
result = ImgProc.SplitObjects_ConvexityDefects(SourceImage, MinDefectDepth, MaxCutLength, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image with connected objects. | — |
| MinDefectDepthSingle, Optional | Minimum defect depth threshold. | 5.0F |
| MaxCutLengthSingle, Optional | Maximum cut length for splitting. | 50.0F |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Image with split objects, or Nothing if splitting fails.
split = ImgProc.SplitObjects_ConvexityDefects(bitmap, 5.0, 50.0)
Segments an image into superpixels using parallel SLIC algorithm.
result = ImgProc.SuperPixelSegmentation(SourceImage, numSuperpixels, compactness, fillWithWhite, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to segment. | — |
| numSuperpixelsInteger, Optional | Target number of superpixels. | 400 |
| compactnessSingle, Optional | Spatial weight for compactness. | 70.0F |
| fillWithWhiteBoolean, Optional | Whether to fill background with white. | False |
| MaskImageBitmap, Optional | Optional mask to constrain segmentation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Segmented image with superpixel boundaries, or Nothing if processing fails.
segmented = ImgProc.SuperPixelSegmentation(bitmap, 400, 70.0, False)
Segments image using watershed algorithm.
result = ImgProc.WatershedSegmentation(SourceImage, MinDistanceThreshold, SmoothRadius, BoundaryThickness, BoundR, BoundG, BoundB, ReturnOnlyBoundaries, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to segment. | — |
| MinDistanceThresholdInteger, Optional | Minimum distance threshold. | 10 |
| SmoothRadiusInteger, Optional | Smoothing radius. | 4 |
| BoundaryThicknessInteger, Optional | Boundary line thickness. | 1 |
| BoundRByte, Optional | Red channel for boundary color. | 0 |
| BoundGByte, Optional | Green channel for boundary color. | 0 |
| BoundBByte, Optional | Blue channel for boundary color. | 0 |
| ReturnOnlyBoundariesBoolean, Optional | Whether to return only boundary lines. | True |
| MaskImageBitmap, Optional | Optional mask to constrain segmentation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Segmented image, or Nothing if segmentation fails.
segmented = ImgProc.WatershedSegmentation(bitmap, 10, 4, 1)
Captures entire desktop screen to bitmap.
result = ImgProc.CaptureDesktopScreen(PrintCursor)
| Parameter | Description | Default |
|---|---|---|
| PrintCursorBoolean, Optional | Whether to render cursor on captured screen. | True |
Bitmap — Captured desktop screen image, or Nothing if capture fails.
screenshot = ImgProc.CaptureDesktopScreen()
Captures specified region of desktop screen.
result = ImgProc.CaptureDesktopScreenByRegion(PrintCursor, IsAllRegion, X1, Y1, X2, Y2)
| Parameter | Description | Default |
|---|---|---|
| PrintCursorBoolean | Whether to render cursor on captured region. | — |
| IsAllRegionBoolean | Whether to capture entire screen region. | — |
| X1Integer | Left coordinate of region. | — |
| Y1Integer | Top coordinate of region. | — |
| X2Integer | Right coordinate of region. | — |
| Y2Integer | Bottom coordinate of region. | — |
Bitmap — Captured region image, or Nothing if capture fails.
regionCapture = ImgProc.CaptureDesktopScreenByRegion(False, False, 0, 0, 800, 600)
Captures window or UI object to bitmap.
result = ImgProc.CaptureObject(pHwnd)
| Parameter | Description | Default |
|---|---|---|
| pHwndIntPtr | Handle to window or UI object. | — |
Bitmap — Captured control image, or Nothing if capture fails.
windowCapture = ImgProc.CaptureObject(formHandle)
Applies chroma key (green screen) effect to composite images.
result = ImgProc.ChromaKey(TargetCanvas, OverlayImage, ChromaR, ChromaG, ChromaB, Opacity, IsFeather, FeatherRadius, ChromaTolerance, ChromaSoftness, extractTransparent, MaskImage, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| TargetCanvasBitmap | Target canvas background image. | — |
| OverlayImageBitmap | Foreground image to composite. | — |
| ChromaRByte | Red component of chroma key color (0-255). | — |
| ChromaGByte | Green component of chroma key color (0-255). | — |
| ChromaBByte | Blue component of chroma key color (0-255). | — |
| OpacitySingle | Opacity factor (0.0-1.0). | — |
| IsFeatherBoolean | Whether to feather edges. | — |
| FeatherRadiusInteger | Feathering radius in pixels. | — |
| ChromaToleranceSingle, Optional | Color matching tolerance range (0.0-100.0). | 35.0F |
| ChromaSoftnessSingle, Optional | Edge gradient softness range (0.0-100.0). | 20.0F |
| extractTransparentBoolean, Optional | Whether to extract transparency. | False |
| MaskImageBitmap, Optional | Optional mask to constrain effect. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Composited image with chroma key applied, or Nothing if compositing fails.
composite = ImgProc.ChromaKey(canvas, overlay, 0, 255, 0, 1.0F, True, 5, 35.0F, 20.0F)
Creates a deep copy of the image.
result = ImgProc.CloneImage(SourceImage)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to clone. | — |
Bitmap — Independent clone of image, or Nothing if cloning fails.
clone = ImgProc.CloneImage(bitmap)
Copies image to clipboard with transparency.
ImgProc.CopyToClipboardWithTransparency(img)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Image to copy. | — |
Void — None.
ImgProc.CopyToClipboardWithTransparency(bitmap)
Draws color level distribution box in picture control.
ImgProc.Draw_ColorLevelBox(ColorMode, Pic_Target, LevelCount)
| Parameter | Description | Default |
|---|---|---|
| ColorModeInteger | Color mode for the distribution. Supported values: 1: Red 2: Green 3: Blue | — |
| Pic_TargetPictureBox | Target picture control to draw in. Type: PictureBox; required; passed by reference. | — |
| LevelCountInteger | Number of discrete levels to display. | — |
Void
ImgProc.Draw_ColorLevelBox(0, picTarget, 8)
Draws line on picture control.
result = ImgProc.Draw_Line(Pic_Target, X1, Y1, X2, Y2, LineColor)
| Parameter | Description | Default |
|---|---|---|
| Pic_TargetPictureBox | Target picture control. Type: PictureBox; required; passed by reference. | — |
| X1Integer | Starting X-coordinate. | — |
| Y1Integer | Starting Y-coordinate. | — |
| X2Integer | Ending X-coordinate. | — |
| Y2Integer | Ending Y-coordinate. | — |
| LineColorColor | Color of the line. | — |
Bitmap — Bitmap with drawn line, or Nothing if drawing fails.
lineBmp = ImgProc.Draw_Line(picTarget, 0, 0, 100, 100, Color.Red)
Draws text with outline in picture control.
result = ImgProc.Draw_Text_Outlined(Pic_Target, x, y, TextString, TextFont, InnerColor, OuterColor)
| Parameter | Description | Default |
|---|---|---|
| Pic_TargetPictureBox | Target picture control. Type: PictureBox; required; passed by reference. | — |
| xInteger | X-coordinate for text. | — |
| yInteger | Y-coordinate for text. | — |
| TextStringString | Text string to draw. | — |
| TextFontFont | Font for text. | — |
| InnerColorColor | Inner text color. | — |
| OuterColorColor | Outline color. | — |
Bitmap — Bitmap containing drawn text, or Nothing if drawing fails.
textBmp = ImgProc.Draw_Text_Outlined(picTarget, 10, 10, "Hello", font, Color.White, Color.Black)
Draws outlined text on bitmap.
result = ImgProc.Draw_Text_Outlined_Bitmap(Pic_Target, x, y, TextString, TextFont, InnerColor, OuterColor)
| Parameter | Description | Default |
|---|---|---|
| Pic_TargetBitmap | Target bitmap to draw text on. | — |
| xInteger | X-coordinate for text. | — |
| yInteger | Y-coordinate for text. | — |
| TextStringString | Text string to draw. | — |
| TextFontFont | Font for text. | — |
| InnerColorColor | Inner text color. | — |
| OuterColorColor | Outline color. | — |
Bitmap — Bitmap with drawn text, or Nothing if drawing fails.
textBmp = ImgProc.Draw_Text_Outlined_Bitmap(bitmap, 10, 10, "Hello", font, Color.White, Color.Black)
Draws outlined text on graphics object.
ImgProc.Draw_Text_Outlined_Graphics(SourceGraphics, x, y, TextString, TextFont, InnerColor, OuterColor)
| Parameter | Description | Default |
|---|---|---|
| SourceGraphicsGraphics | Target graphics object to draw on. | — |
| xInteger | X-coordinate for text. | — |
| yInteger | Y-coordinate for text. | — |
| TextStringString | Text string to draw. | — |
| TextFontFont | Font for text. | — |
| InnerColorColor | Inner text color. | — |
| OuterColorColor | Outline color. | — |
Void
ImgProc.Draw_Text_Outlined_Graphics(g, 10, 10, "Hello", font, Color.White, Color.Black)
Draws outlined text on image.
result = ImgProc.Draw_Text_Outlined_Image(SourceImage, x, y, TextString, TextFont, InnerColor, OuterColor)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to draw text on. | — |
| xInteger | X-coordinate for text. | — |
| yInteger | Y-coordinate for text. | — |
| TextStringString | Text string to draw. | — |
| TextFontFont | Font for text. | — |
| InnerColorColor | Inner text color. | — |
| OuterColorColor | Outline color. | — |
Bitmap — Image with drawn text, or Nothing if drawing fails.
textImg = ImgProc.Draw_Text_Outlined_Image(bitmap, 10, 10, "Hello", font, Color.White, Color.Black)
Draws selection border with RGB values on image.
result = ImgProc.DrawSelectionBorder(SourceImage, cR, cG, cB, BorderThickness, Opacity)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to draw on. | — |
| cRByte | Red component (0-255). | — |
| cGByte | Green component (0-255). | — |
| cBByte | Blue component (0-255). | — |
| BorderThicknessInteger | Thickness of border line in pixels. | — |
| OpacityByte | Alpha transparency (0-255). | — |
Bitmap — Image with selection border drawn, or Nothing if drawing fails.
bordered = ImgProc.DrawSelectionBorder(bitmap, 255, 0, 0, 2, 255)
Fills image regions with RGB color value and opacity.
result = ImgProc.FillRegion(SourceImage, FillColorRed, FillColorGreen, FillColorBlue, IsFillInside, Opacity, IsShowProgress, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to fill. | — |
| FillColorRedByte | Red fill color (0-255). | — |
| FillColorGreenByte | Green fill color (0-255). | — |
| FillColorBlueByte | Blue fill color (0-255). | — |
| IsFillInsideBoolean | Whether to fill inside (True) or outside (False). | — |
| OpacitySingle | Fill opacity (0-1). | — |
| IsShowProgressBoolean, Optional | Whether to display progress. | True |
| MaskImageBitmap, Optional | Optional mask to constrain filling. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Filled image, or Nothing if filling fails.
filled = ImgProc.FillRegion(bitmap, 255, 0, 0, True, 0.5)
Fills region starting from center point with color.
result = ImgProc.FloodFill(SourceImage, CenterX, CenterY, FillColorR, FillColorG, FillColorB, ToleranceR, ToleranceG, ToleranceB, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source image to fill. | — |
| CenterXInteger | Center X-coordinate to start fill. | — |
| CenterYInteger | Center Y-coordinate to start fill. | — |
| FillColorRByte | Fill red component. | — |
| FillColorGByte | Fill green component. | — |
| FillColorBByte | Fill blue component. | — |
| ToleranceRInteger | Red color tolerance. | — |
| ToleranceGInteger | Green color tolerance. | — |
| ToleranceBInteger | Blue color tolerance. | — |
| MaskImageBitmap, Optional | Optional mask to constrain fill. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
Bitmap — Filled image, or Nothing if fill fails.
filled = ImgProc.FloodFill(bitmap, 50, 50, 255, 0, 0, 10, 10, 10)
Generates blank image in picture control.
ImgProc.Generate_BlankImage(Pic_Target, BackColor)
| Parameter | Description | Default |
|---|---|---|
| Pic_TargetPictureBox | Target picture control. Type: PictureBox; required; passed by reference. | — |
| BackColorColor | Background color for the blank image. | — |
Void
ImgProc.Generate_BlankImage(picTarget, Color.White)
Gets actual rectangle bounds of form.
result = ImgProc.Get_ActualFormRect(SrcForm)
| Parameter | Description | Default |
|---|---|---|
| SrcFormForm | Source form window. | — |
Rectangle — Rectangle bounds of the form, or Rectangle.Empty if retrieval fails.
bounds = ImgProc.Get_ActualFormRect(myForm)
Gets number of processor cores.
result = ImgProc.Get_CoreCount()
Integer — Number of available processor cores, or 1 if retrieval fails.
cores = ImgProc.Get_CoreCount()
Gets current cursor position on screen.
ImgProc.Get_CursorPosition(x, y)
| Parameter | Description | Default |
|---|---|---|
| xInteger | Output cursor X coordinate. Type: Integer; required; passed by reference. | — |
| yInteger | Output cursor Y coordinate. Type: Integer; required; passed by reference. | — |
Void — None.
ImgProc.Get_CursorPosition(cursorX, cursorY)
Gets image format object from file extension.
result = ImgProc.Get_ImageFormat(FileExtension)
| Parameter | Description | Default |
|---|---|---|
| FileExtensionString | File extension (e.g., '.jpg', '.png'). | — |
Object — Image format object, or Nothing if format not found.
fmt = ImgProc.Get_ImageFormat(".jpg")
Gets window height margin value.
result = ImgProc.Get_WindowHeightMargin(TargetForm)
| Parameter | Description | Default |
|---|---|---|
| TargetFormForm | Target form window. | — |
Integer — Window height margin, or 0 if retrieval fails.
margin = ImgProc.Get_WindowHeightMargin(myForm)
Gets window width margin value.
result = ImgProc.Get_WindowWidthMargin(TargetForm)
| Parameter | Description | Default |
|---|---|---|
| TargetFormForm | Target form window. | — |
Integer — Window width margin, or 0 if retrieval fails.
margin = ImgProc.Get_WindowWidthMargin(myForm)
Gets bitmap snapshot of UI control.
result = ImgProc.GetControlBitmap(CTL)
| Parameter | Description | Default |
|---|---|---|
| CTLControl | Source UI control. | — |
Bitmap — Bitmap snapshot of the control, or Nothing if snapshot fails.
ctlBitmap = ImgProc.GetControlBitmap(myPictureBox)
Saves depth map as STL file using box filter.
result = ImgProc.SaveDepthMapToSTL_BoxFilter(SourceImage, FilePath, MaxSTLHeight, BaseThickness, SmoothingPasses, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source depth map image. | — |
| FilePathString | Path to save STL file. | — |
| MaxSTLHeightSingle, Optional | Maximum STL height. | 15.0F |
| BaseThicknessSingle, Optional | Base thickness for STL. | 2.0F |
| SmoothingPassesInteger, Optional | Number of smoothing passes. | 3 |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
String — File path if save successful, empty string if operation fails.
result = ImgProc.SaveDepthMapToSTL_BoxFilter(depthBitmap, "output.stl", 15.0, 2.0, 3)
Saves depth map as STL file using Gaussian filter.
result = ImgProc.SaveDepthMapToSTL_GaussianFilter(SourceImage, FilePath, MaxSTLHeight, BaseThickness, SmoothingPasses, MaskImage, MaskRegionBoundary, IsMaskAllRegionSelected)
| Parameter | Description | Default |
|---|---|---|
| SourceImageBitmap | Source depth map image. | — |
| FilePathString | Path to save STL file. | — |
| MaxSTLHeightSingle, Optional | Maximum STL height. | 15.0F |
| BaseThicknessSingle, Optional | Base thickness for STL. | 2.0F |
| SmoothingPassesInteger, Optional | Number of smoothing passes. | 3 |
| MaskImageBitmap, Optional | Optional mask to constrain operation. | Nothing |
| MaskRegionBoundaryRectangle, Optional | Boundary rectangle for masked region. | Nothing |
| IsMaskAllRegionSelectedBoolean, Optional | Whether entire region is selected. | True |
String — File path if save successful, empty string if operation fails.
result = ImgProc.SaveDepthMapToSTL_GaussianFilter(depthBitmap, "output.stl", 15.0, 2.0, 3)
Stops the current image processing operation.
ImgProc.Stop_Processing()
Void
ImgProc.Stop_Processing()
Detects objects in an image and stores the detection results.
result = ObjectDetector.Detect(img, confThreshold, nmsThreshold, useTiling)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Image to analyze. | — |
| confThresholdDouble, Optional | Minimum confidence threshold. | 0.5F |
| nmsThresholdDouble, Optional | Non-maximum suppression threshold. | 0.4F |
| useTilingBoolean, Optional | Whether to use tiled inference. | False |
Integer — Number of detected objects, or 0 if detection fails.
count = ObjectDetector.Detect(bitmap, 0.5, 0.4, False)
Returns all detection results from the most recent detection.
result = ObjectDetector.GetAllResults()
ONNX_YOLOv3Detector.DetectionResult() — Array of detection results, or an empty array when no results are available.
results = ObjectDetector.GetAllResults()
Returns the number of detected objects with the specified class label.
result = ObjectDetector.GetClassCount(className)
| Parameter | Description | Default |
|---|---|---|
| classNameString | Class label to count. | — |
Integer — Number of detections for the class.
count = ObjectDetector.GetClassCount("person")
Returns bounding boxes for detections of the specified class.
result = ObjectDetector.GetClassLocations(className)
| Parameter | Description | Default |
|---|---|---|
| classNameString | Class label to locate. | — |
RectangleF() — Array of bounding rectangles for matching detections.
locations = ObjectDetector.GetClassLocations("person")
Returns the most recent error message produced by the helper.
result = ObjectDetector.GetLastError()
String — The last error message, or an empty string when no error is recorded.
errorMessage = ObjectDetector.GetLastError()
Returns a copy of the image rendered with detection boxes and labels.
result = ObjectDetector.GetRenderedImage(img, showConfidence, colorName)
| Parameter | Description | Default |
|---|---|---|
| imgBitmap | Source image to render. | — |
| showConfidenceBoolean, Optional | Whether to display confidence values. | True |
| colorNameString, Optional | Known .NET color name for boxes and labels. | "Red" |
Bitmap — Rendered bitmap, or Nothing if rendering fails.
rendered = ObjectDetector.GetRenderedImage(bitmap, True, "Lime")
Checks whether the most recent results contain the specified object class.
result = ObjectDetector.HasClass(className)
| Parameter | Description | Default |
|---|---|---|
| classNameString | Class label to find. | — |
Boolean — True if the class was detected; otherwise False.
found = ObjectDetector.HasClass("person")
Initializes the YOLOv3 detector with its default model and settings.
result = ObjectDetector.Initialize()
Boolean — True when the detector is initialized or already available; otherwise False.
ready = ObjectDetector.Initialize()
Adds a circular area defined by a bounding rectangle to the current multi-region selection.
Region.AddCircle(left, top, right, bottom)
| Parameter | Description | Default |
|---|---|---|
| leftInteger | Left X coordinate. | — |
| topInteger | Top Y coordinate. | — |
| rightInteger | Right X coordinate. | — |
| bottomInteger | Bottom Y coordinate. | — |
Void — Void. Coordinates are clipped to the workspace image bounds.
Region.AddCircle(10, 20, 100, 120)
Adds mask pixels from another bitmap at the specified offset.
Region.AddMaskImage(appendBmp, offsetX, offsetY)
| Parameter | Description | Default |
|---|---|---|
| appendBmpBitmap | Bitmap whose white pixels are added to the mask. | — |
| offsetXInteger, Optional | Horizontal offset in pixels. | 0 |
| offsetYInteger, Optional | Vertical offset in pixels. | 0 |
Void — Void.
Region.AddMaskImage(mask, 10, 5)
Adds a polygonal area to the current multi-region selection.
Region.AddPolygon(coords)
| Parameter | Description | Default |
|---|---|---|
| coordsInteger() | At least three coordinate pairs in X, Y order. | — |
Void — Void. Coordinates are clipped to the workspace image bounds.
Region.AddPolygon(New Integer() {10, 10, 100, 10, 50, 80})
Adds a rectangular area to the current multi-region selection.
Region.AddRectangle(left, top, right, bottom)
| Parameter | Description | Default |
|---|---|---|
| leftInteger | Left X coordinate. | — |
| topInteger | Top Y coordinate. | — |
| rightInteger | Right X coordinate. | — |
| bottomInteger | Bottom Y coordinate. | — |
Void — Void. Coordinates are clipped to the workspace image bounds.
Region.AddRectangle(10, 20, 100, 120)
Creates a binary bitmap representing the current selection mask.
result = Region.GetBinaryMaskImage()
Bitmap — Mask bitmap with selected pixels in white and unselected pixels in black, or Nothing if unavailable.
mask = Region.GetBinaryMaskImage()
Returns the bottom coordinate of the current selection boundary.
result = Region.GetBoundaryBottom()
Integer — Bottom boundary coordinate in pixels.
bottom = Region.GetBoundaryBottom()
Returns the left coordinate of the current selection boundary.
result = Region.GetBoundaryLeft()
Integer — Left boundary coordinate in pixels.
left = Region.GetBoundaryLeft()
Returns the right coordinate of the current selection boundary.
result = Region.GetBoundaryRight()
Integer — Right boundary coordinate in pixels.
right = Region.GetBoundaryRight()
Returns the top coordinate of the current selection boundary.
result = Region.GetBoundaryTop()
Integer — Top boundary coordinate in pixels.
top = Region.GetBoundaryTop()
Returns the bottom coordinate of the current rectangular selection boundary.
result = Region.GetRectangleBottom()
Integer — Bottom boundary coordinate in pixels.
bottom = Region.GetRectangleBottom()
Returns the left coordinate of the current rectangular selection boundary.
result = Region.GetRectangleLeft()
Integer — Left boundary coordinate in pixels.
left = Region.GetRectangleLeft()
Returns the right coordinate of the current rectangular selection boundary.
result = Region.GetRectangleRight()
Integer — Right boundary coordinate in pixels.
right = Region.GetRectangleRight()
Returns the top coordinate of the current rectangular selection boundary.
result = Region.GetRectangleTop()
Integer — Top boundary coordinate in pixels.
top = Region.GetRectangleTop()
Returns the current selection mode.
result = Region.GetSelectMode()
String — Selection mode name: None, Adding, or Subtracting.
mode = Region.GetSelectMode()
Returns the name of the current selection shape type.
result = Region.GetShape()
String — Selection shape name, or "None" when unavailable.
shapeName = Region.GetShape()
Hides the current selection shape.
Region.Hide()
Void — Void.
Region.Hide()
Refreshes the workspace drawing canvas.
Region.Invalidate()
Void — Void.
Region.Invalidate()
Checks whether the entire workspace image region is selected.
result = Region.IsAllRegionSelected()
Boolean — True when the entire region is selected or workspace state is unavailable; otherwise False.
allSelected = Region.IsAllRegionSelected()
Checks whether the current selection is a bitmap mask.
result = Region.IsBitmapMask()
Boolean — True when the selection is a bitmap mask; otherwise False.
isMask = Region.IsBitmapMask()
Checks whether the current selection shape is a circle.
result = Region.IsCircle()
Boolean — True when the selection is a circle; otherwise False.
isCircle = Region.IsCircle()
Checks whether the current selection shape is a line.
result = Region.IsLine()
Boolean — True when the selection is a line; otherwise False.
isLine = Region.IsLine()
Checks whether no selection shape is active.
result = Region.IsNone()
Boolean — True when no selection shape is active; otherwise False.
isEmpty = Region.IsNone()
Checks whether the current selection shape is a freehand path.
result = Region.IsPath()
Boolean — True when the selection is a path; otherwise False.
isPath = Region.IsPath()
Checks whether the current selection shape is a polygon.
result = Region.IsPolygon()
Boolean — True when the selection is a polygon; otherwise False.
isPolygon = Region.IsPolygon()
Checks whether the current selection shape is a rectangle.
result = Region.IsRectangle()
Boolean — True when the selection is a rectangle; otherwise False.
isRectangle = Region.IsRectangle()
Removes a circular area defined by a bounding rectangle from the current multi-region selection.
Region.RemoveCircle(left, top, right, bottom)
| Parameter | Description | Default |
|---|---|---|
| leftInteger | Left X coordinate. | — |
| topInteger | Top Y coordinate. | — |
| rightInteger | Right X coordinate. | — |
| bottomInteger | Bottom Y coordinate. | — |
Void — Void. Coordinates are clipped to the workspace image bounds.
Region.RemoveCircle(10, 20, 100, 120)
Removes a polygonal area from the current multi-region selection.
Region.RemovePolygon(coords)
| Parameter | Description | Default |
|---|---|---|
| coordsInteger() | At least three coordinate pairs in X, Y order. | — |
Void — Void. Coordinates are clipped to the workspace image bounds.
Region.RemovePolygon(New Integer() {10, 10, 100, 10, 50, 80})
Removes a rectangular area from the current multi-region selection.
Region.RemoveRectangle(left, top, right, bottom)
| Parameter | Description | Default |
|---|---|---|
| leftInteger | Left X coordinate. | — |
| topInteger | Top Y coordinate. | — |
| rightInteger | Right X coordinate. | — |
| bottomInteger | Bottom Y coordinate. | — |
Void — Void. Coordinates are clipped to the workspace image bounds.
Region.RemoveRectangle(10, 20, 100, 120)
Sets the current selection from a binary mask bitmap.
Region.SetBinaryMaskImage(maskBmp)
| Parameter | Description | Default |
|---|---|---|
| maskBmpBitmap | Bitmap containing the selection mask. | — |
Void — Void. No change is made when the bitmap or workspace is unavailable.
Region.SetBinaryMaskImage(mask)
Creates a circular selection inside the specified bounding rectangle.
Region.SetCircle(left, top, right, bottom)
| Parameter | Description | Default |
|---|---|---|
| leftInteger | Left X coordinate. | — |
| topInteger | Top Y coordinate. | — |
| rightInteger | Right X coordinate. | — |
| bottomInteger | Bottom Y coordinate. | — |
Void — Void.
Region.SetCircle(10, 20, 100, 120)
Creates a line selection between two points.
Region.SetLine(x1, y1, x2, y2)
| Parameter | Description | Default |
|---|---|---|
| x1Integer | First endpoint X coordinate. | — |
| y1Integer | First endpoint Y coordinate. | — |
| x2Integer | Second endpoint X coordinate. | — |
| y2Integer | Second endpoint Y coordinate. | — |
Void — Void.
Region.SetLine(10, 20, 100, 120)
Creates a freehand path selection from an array of alternating X and Y coordinates.
Region.SetPath(coords)
| Parameter | Description | Default |
|---|---|---|
| coordsInteger() | At least two coordinate pairs in X, Y order. | — |
Void — Void.
Region.SetPath(New Integer() {10, 10, 50, 40, 100, 20})
Creates a polygon selection from an array of alternating X and Y coordinates.
Region.SetPolygon(coords)
| Parameter | Description | Default |
|---|---|---|
| coordsInteger() | At least three coordinate pairs in X, Y order. | — |
Void — Void.
Region.SetPolygon(New Integer() {10, 10, 100, 10, 50, 80})
Creates a rectangular selection from two corner coordinates.
Region.SetRectangle(left, top, right, bottom)
| Parameter | Description | Default |
|---|---|---|
| leftInteger | Left X coordinate. | — |
| topInteger | Top Y coordinate. | — |
| rightInteger | Right X coordinate. | — |
| bottomInteger | Bottom Y coordinate. | — |
Void — Void.
Region.SetRectangle(10, 20, 100, 120)
Sets the selection mode to none, adding, or subtracting.
Region.SetSelectMode(modeName)
| Parameter | Description | Default |
|---|---|---|
| modeNameString | String representing the selection mode. Supported modeName values: "None": Clears the selection mode "Adding" (or "Add"): Sets the mode to add new regions to the current selection "Subtracting" (or "Subtract"): Sets the mode to subtract regions from the current selection | — |
Void — Void. Unrecognized values are ignored.
Region.SetSelectMode("Adding")
Displays the last drawn selection shape.
Region.Show()
Void — Void.
Region.Show()
Removes mask pixels using another bitmap at the specified offset.
Region.SubtractMaskImage(subtractBmp, offsetX, offsetY)
| Parameter | Description | Default |
|---|---|---|
| subtractBmpBitmap | Bitmap whose white pixels are removed from the mask. | — |
| offsetXInteger, Optional | Horizontal offset in pixels. | 0 |
| offsetYInteger, Optional | Vertical offset in pixels. | 0 |
Void — Void.
Region.SubtractMaskImage(mask, 10, 5)
Clears the current selection and hides its selection shape.
Region.Unselect()
Void — Void.
Region.Unselect()
Copies text to the system clipboard with license validation.
UI.CopyToClipboard(text)
| Parameter | Description | Default |
|---|---|---|
| textObject | Text content to copy. | — |
Void
UI.CopyToClipboard("Hello World")
Gets whether cancellation has been requested.
result = UI.IsCancelled()
Boolean — True if cancellation is requested, False otherwise.
cancelled = UI.IsCancelled()
Displays a message box dialog with customizable buttons and title.
result = UI.MsgBox(prompt, buttons, title)
| Parameter | Description | Default |
|---|---|---|
| promptObject | Message text to display. | — |
| buttonsObject, Optional | Button style as MsgBoxStyle enumeration value. | Nothing |
| titleObject, Optional | Dialog title text. | Nothing |
Integer — Integer representing the clicked button (VB.NET MsgBoxResult values).
result = UI.MsgBox("Continue?", 4, "Confirmation")
Yields control to allow event processing and UI updates.
UI.YieldEvents()
Void
UI.YieldEvents()
Initializes a sequential frame scan over a time range for step-by-step loop processing in scripts.
result = VideoExtractor.BeginRangeScan(startTimeSec, endTimeSec, interval, intervalUnit)
| Parameter | Description | Default |
|---|---|---|
| startTimeSecDouble, Optional | Start time in seconds. | 0.0 |
| endTimeSecDouble, Optional | End time in seconds (-1.0 for end of video). | -1.0 |
| intervalDouble, Optional | Time step interval value. | 1.0 |
| intervalUnitString, Optional | Interval time unit ("MS", "SEC", "MIN", "HOUR"). | "SEC" |
Integer — Total estimated number of frames to be scanned, or 0 if initialization fails.
total = VideoExtractor.BeginRangeScan(0.0, 10.0, 500, "MS")
Closes the currently opened video file without disposing the helper instance.
VideoExtractor.CloseVideo()
Void — Void.
VideoExtractor.CloseVideo()
Extracts a single video frame at the exact specified time in seconds.
result = VideoExtractor.ExtractFrameAt(timeInSeconds)
| Parameter | Description | Default |
|---|---|---|
| timeInSecondsDouble | Target timestamp in seconds. | — |
Bitmap — Extracted frame as a Bitmap, or Nothing if extraction fails.
frameBmp = VideoExtractor.ExtractFrameAt(12.5)
Extracts a single video frame using a formatted time string (e.g., "00:01:30" or "00:01:30.500").
result = VideoExtractor.ExtractFrameAtHMS(hmsTimeString)
| Parameter | Description | Default |
|---|---|---|
| hmsTimeStringString | Formatted time string (HH:MM:SS or HH:MM:SS.fff). | — |
Bitmap — Extracted frame as a Bitmap, or Nothing if parsing or extraction fails.
frameBmp = VideoExtractor.ExtractFrameAtHMS("00:01:15.250")
Returns the total duration of the currently opened video in seconds.
result = VideoExtractor.GetDuration()
Double — Total video duration in seconds, or 0.0 if no video is open.
totalSec = VideoExtractor.GetDuration()
Returns the duration of a single frame in seconds.
result = VideoExtractor.GetFrameDuration()
Double — Single frame duration in seconds, or 0.0 if no video is open.
stepSec = VideoExtractor.GetFrameDuration()
Returns the approximate frame rate (FPS) of the currently opened video.
result = VideoExtractor.GetFrameRate()
Double — Frames per second as Double, or 0.0 if no video is open.
fps = VideoExtractor.GetFrameRate()
Returns the most recent error message produced by the helper.
result = VideoExtractor.GetLastError()
String — The last error message, or an empty string when no error is recorded.
errorMessage = VideoExtractor.GetLastError()
Calculates the total number of frames that will be extracted for the given time range and interval.
result = VideoExtractor.GetTotalFrameCount(startTimeSec, endTimeSec, interval, intervalUnit)
| Parameter | Description | Default |
|---|---|---|
| startTimeSecDouble | Start time in seconds. | — |
| endTimeSecDouble | End time in seconds. | — |
| intervalDouble | Time interval value. | — |
| intervalUnitString, Optional | Interval time unit ("MS", "SEC", "MIN", "HOUR"). | "SEC" |
Integer — Total frame count as Integer.
total = VideoExtractor.GetTotalFrameCount(0.0, 60.0, 500, "MS")
Returns the display height of the currently opened video in pixels.
result = VideoExtractor.GetVideoHeight()
Integer — Video height in pixels, or 0 if no video is open.
h = VideoExtractor.GetVideoHeight()
Returns the display width of the currently opened video in pixels.
result = VideoExtractor.GetVideoWidth()
Integer — Video width in pixels, or 0 if no video is open.
w = VideoExtractor.GetVideoWidth()
Checks whether a video file is currently opened and ready for extraction.
result = VideoExtractor.IsVideoOpened()
Boolean — True if a video file is open; otherwise False.
isOpen = VideoExtractor.IsVideoOpened()
Opens a video file for frame extraction.
result = VideoExtractor.OpenVideo(filePath)
| Parameter | Description | Default |
|---|---|---|
| filePathString | Full path to the video file. | — |
Boolean — True if the video file was successfully opened; otherwise False.
opened = VideoExtractor.OpenVideo("C:\Videos\sample.mp4")
Reads the next frame in the active sequential scan and advances the scan timestamp.
result = VideoExtractor.ReadNextFrame(outTimestampSec)
| Parameter | Description | Default |
|---|---|---|
| outTimestampSecDouble, Optional | Output parameter receiving the timestamp (in seconds) of the extracted frame. | 0.0 |
Bitmap — Extracted Bitmap for the current step, or Nothing when the scan finishes or fails.
bmp = VideoExtractor.ReadNextFrame(currentSec)
Extracts a single frame at the specified time directly into the active PhenoCapture workspace.
result = VideoExtractor.SendFrameToWorkspace(timeInSeconds, putUndo)
| Parameter | Description | Default |
|---|---|---|
| timeInSecondsDouble | Target timestamp in seconds. | — |
| putUndoBoolean, Optional | Whether to record the operation in the Undo engine. | True |
Boolean — True if the frame was loaded into the workspace; otherwise False.
VideoExtractor.SendFrameToWorkspace(10.0, True)
Appends a Bitmap frame to the currently opened video or animation.
result = VideoWriter.AddFrame(frameBitmap)
| Parameter | Description | Default |
|---|---|---|
| frameBitmapBitmap | Source Bitmap to encode. Automatically resized if dimensions differ from target size. | — |
Boolean — True if the frame was successfully encoded; otherwise False.
VideoWriter.AddFrame(bmp)
Loads an image file from disk and appends it as a frame to the currently opened video.
result = VideoWriter.AddFrameFromFile(imageFilePath, showPreviewWindow)
| Parameter | Description | Default |
|---|---|---|
| imageFilePathString | Full path to the source image file. | — |
| showPreviewWindowBoolean, Optional | Whether to show the frame thumbnail and progress in a dedicated resizable window. | False |
Boolean — True if the image was loaded and encoded; otherwise False.
VideoWriter.AddFrameFromFile("C:\Images\frame001.png", True)
Captures the current image from the active PhenoCapture workspace and appends it as a video frame.
result = VideoWriter.AddWorkspaceFrame()
Boolean — True if the workspace image was successfully encoded; otherwise False.
writer.AddWorkspaceFrame()
Scans a folder for supported image files and initializes the video encoder automatically using the first image's resolution.
result = VideoWriter.BeginFolderEncoding(sourceFolder, destinationFile, fps, format, bitrateKbps, skipStep)
| Parameter | Description | Default |
|---|---|---|
| sourceFolderString | Directory containing source images. | — |
| destinationFileString, Optional | Output video or animation file path (if empty, saves as Output_Encoded.mp4 in sourceFolder). | "" |
| fpsInteger, Optional | Frames per second (1 - 90). | 10 |
| formatString, Optional | Output format ("MP4", "WMV", "GIF", "APNG"). | "MP4" |
| bitrateKbpsInteger, Optional | Target video bitrate in kbps. | 4000 |
| skipStepInteger, Optional | Frame step interval (1 = every file, 2 = every 2nd file). | 1 |
Integer — Total number of frames scheduled to be encoded, or 0 if initialization fails.
total = VideoWriter.BeginFolderEncoding("C:\Images", "C:\Images\Output.mp4", 10, "MP4")
Finalizes and closes the currently opened video or animation file, and closes the preview window if open.
result = VideoWriter.CloseVideo()
Boolean — True if finalized cleanly; otherwise False.
VideoWriter.CloseVideo()
Encodes the next scheduled image frame from the folder initialized by BeginFolderEncoding.
result = VideoWriter.EncodeNextFolderFrame(showPreviewWindow)
| Parameter | Description | Default |
|---|---|---|
| showPreviewWindowBoolean, Optional | Whether to display the current thumbnail and frame count in a dedicated resizable window. | True |
Boolean — True if the frame was encoded; False when finished or if an error occurs.
ok = VideoWriter.EncodeNextFolderFrame(True)
Returns the file name of the most recently encoded image frame during folder encoding.
result = VideoWriter.GetCurrentFrameFileName()
String — File name string (e.g., "frame001.png").
fileName = VideoWriter.GetCurrentFrameFileName()
Returns the most recent error message produced by the helper.
result = VideoWriter.GetLastError()
String — The last error message, or an empty string when no error is recorded.
errorMessage = VideoWriter.GetLastError()
Returns the aligned frame height (in pixels) of the currently opened output file.
result = VideoWriter.GetTargetHeight()
Integer — Target frame height in pixels, or 0 if not opened.
h = VideoWriter.GetTargetHeight()
Returns the aligned frame width (in pixels) of the currently opened output file.
result = VideoWriter.GetTargetWidth()
Integer — Target frame width in pixels, or 0 if not opened.
w = VideoWriter.GetTargetWidth()
Returns the number of frames written to the currently opened video or animation.
result = VideoWriter.GetWrittenFrameCount()
Integer — Total number of encoded frames.
count = VideoWriter.GetWrittenFrameCount()
Checks whether a video or animation file is currently opened for writing.
result = VideoWriter.IsVideoOpened()
Boolean — True if an output stream is open and ready to receive frames; otherwise False.
isOpen = VideoWriter.IsVideoOpened()
Opens a new video or animation file (MP4, WMV, GIF, or APNG) for frame-by-frame encoding.
result = VideoWriter.OpenVideo(filePath, width, height, fps, format, bitrateKbps, estimatedFrameCount)
| Parameter | Description | Default |
|---|---|---|
| filePathString | Full destination path for the output file. | — |
| widthInteger | Frame width in pixels. | — |
| heightInteger | Frame height in pixels. | — |
| fpsInteger, Optional | Frames per second (1 - 90). | 10 |
| formatString, Optional | Output format ("MP4", "WMV", "GIF", "APNG"). | "MP4" |
| bitrateKbpsInteger, Optional | Target video bitrate in kbps (e.g., 4000 for 4 Mbps). | 4000 |
| estimatedFrameCountInteger, Optional | Expected frame count (used by APNG header and progress window). | 0 |
Boolean — True if the encoder was successfully initialized; otherwise False.
ok = VideoWriter.OpenVideo("C:\Temp\out.mp4", 640, 480, 15, "MP4", 4000, 100)