Resource Base
Table of contents

GrayscaleEnhancementModes

This parameter provides some image processing methods to enhance the quality of the grayscale image. By default, the library does no image preprocessing. Assume your image has distorted features that can be solved by common image processing methods, this parameter can help you get a higher quality grayscale image by shifting the order of the preprocessing algorithms used (if at all).

It consists of one or more of the following modes, each mode representing a different preprocessing algorithm.

Candidate Mode List

  • GEM_GENERAL
  • GEM_GRAY_EQUALIZE
  • GEM_GRAY_SMOOTH
  • GEM_SHARPEN_SMOOTH

GEM_GENERAL

Takes the un-preprocessed grayscale image for the next stage of operations.

GEM_GRAY_EQUALIZE

Preprocesses the grayscale image using the gray equalization algorithm. This mode can be used for images with low contrast between content and background colour. This mode has the following arguments for further customization.

GEM_GRAY_SMOOTH

Preprocesses the grayscale image using the gray smoothing algorithm. This mode can be used for for images with noise or texture. This mode has the following arguments for further customization.

GEM_SHARPEN_SMOOTH

Preprocesses the grayscale image using the sharpening and smoothing algorithm. This mode can be used for blurry images. This mode has the following arguments for further customizing.

Setting Methods

As JSON Parameter

GrayscaleEnhancementModes as a JSON parameter is a JSON Object array defined as below.

Parent Json Object Key Name Key Value
ImageParameter GrayscaleEnhancementModes A JSON Object array while each Object is defined as below
Key Name Key Value Description
Mode Any one in Candidate Mode List as string (Required) Sets a preprocessing mode.
Sensitivity A number from value range of Sensitivity (Optional) Sets the Argument Sensitivity.
SmoothBlockSizeX A number from value range of SmoothBlockSizeX (Optional) Sets the Argument SmoothBlockSizeX.
SmoothBlockSizeY A number from value range of SmoothBlockSizeY (Optional) Sets the Argument SmoothBlockSizeY.
SharpenBlockSizeX A number from value range of SharpenBlockSizeX (Optional) Sets the Argument SmoothBlockSizeX.
SharpenBlockSizeY A number from value range of SharpenBlockSizeY (Optional) Sets the Argument SmoothBlockSizeY.

Default Value

{
    "GrayscaleEnhancementModes": [
        {
            "Mode": "GEM_GENERAL" 
        }
    ]
}

JSON Parameter Example

{
    "GrayscaleEnhancementModes": [
        {
            "Mode": "GEM_GRAY_SMOOTH", 
            "SmoothBlockSizeX": 5,
            "SmoothBlockSizeY": 5
        },
        {
            "Mode": "GEM_GRAY_EQUALIZE", 
            "Sensitivity": 1
        }
    ]
}

Candidate Argument List

Sensitivity

Sets the sensitivity to perform the equalization process. A larger value means a higher possibility that gray equalization will be activated.

Value Type Value Range Default Value Valid For
int [1, 9] 5 GEM_GRAY_EQUALIZE

SmoothBlockSizeX

Sets the horizontal block size(neighborhood pixel counts) for the smoothing process.

Value Type Value Range Default Value Valid For
int [3, 1000] 3 GEM_GRAY_SMOOTH
GEM_SHARPEN_SMOOTH

SmoothBlockSizeY

Sets the vertical block size(neighborhood pixel counts) for the smoothing process.

Value Type Value Range Default Value Valid For
int [3, 1000] 3 GEM_GRAY_SMOOTH
GEM_SHARPEN_SMOOT

SharpenBlockSizeX

Sets the horizontal block size(neighborhood pixel counts) for the sharpening process.

Value Type Value Range Default Value  
int [3, 1000] 3 GEM_SHARPEN_SMOOTH

SharpenBlockSizeY

Sets the vertical block size(neighborhood pixel counts) for the sharpening process.

Value Type Value Range Default Value Valid For
int [3, 1000] 3 GEM_SHARPEN_SMOOTH

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 2.x
      • Version 2.2.10
      • Version 2.2.0
      • Version 2.0.21
      • Version 2.0.20
      • Version 2.0.11
      • Version 2.0.10
      • Version 2.0.0
    • Version 1.x
      • Version 1.0.21
      • Version 1.0.20
      • Version 1.0.12
      • Version 1.0.11
      • Version 1.0.10
      • Version 1.0.0
    • Documentation Homepage
    Change +