Need better scanning performance?

Get a FREE customized reading template.

ImageParameter Parameters

The ImageParameter object configures parameters for image processing stages in Dynamsoft Capture Vision, including grayscale conversion, enhancement, binarization, texture detection, and more.

Example JSON

{
    "ImageParameterOptions": [
        {
            "Name": "ip_default",
            "BaseImageParameterName": "",
            "ApplicableStages": [
                {
                    "Stage": "SST_CONVERT_TO_GRAYSCALE",
                    "ColourConversionModes": []
                },
                {
                    "Stage": "SST_BINARIZE_IMAGE",
                    "BinarizationModes": []
                },
                {
                    "Stage": "SST_SCALE_IMAGE",
                    "ImageScaleSettings": {
                        "ScaledDownThreshold": 2300,
                        "ScaledUpThreshold": 500
                    }
                }
            ]
        }
    ]
}

Hierarchical Structure

This tree shows one ImageParameter object inside ImageParameterOptions.

ApplicableStages defines stage objects. Stage-scoped parameters are constrained by the Stage value in each item.

ImageParameter
├── Name
├── BaseImageParameterName
└── ApplicableStages[]
  └── item
    ├── Stage
    └── stage-scoped parameters
      ├── BinarizationModes
      ├── ColourConversionModes
      ├── GrayscaleEnhancementModes
      ├── GrayscaleTransformationModes
      ├── RegionPredetectionModes
      ├── TextDetectionMode
      ├── TextureDetectionModes
      ├── ShortlineDetectionMode
      ├── LineAssemblyMode
      ├── IfEraseTextZone
      └── ImageScaleSettings

Top-Level Parameters

Parameter Name	Description
`Name`	The unique name of the ImageParameter object.
`BaseImageParameterName`	The name of another ImageParameter to inherit from.
`ApplicableStages`	The stages that this ImageParameter applies to.

Nested Parameter Quick Links

Actual Nested Parameters in the Tree

Parameter Name	Description
`BinarizationModes`	The modes for image binarization.
`ColourConversionModes`	The modes for colour-to-grayscale conversion.
`GrayscaleEnhancementModes`	The modes for grayscale enhancement.
`GrayscaleTransformationModes`	The modes for grayscale transformation.
`IfEraseTextZone`	Whether to erase text zones.
`ImageScaleSettings`	The settings for image scaling.
`LineAssemblyMode`	The mode for line assembly.
`RegionPredetectionModes`	The modes for region predetection.
`ShortlineDetectionMode`	The mode for shortline detection.
`TextDetectionMode`	The mode for text detection.
`TextureDetectionModes`	The modes for texture detection.

Conceptual Stage Objects

Object	Description
`StageInputColorImage`	Stage object with `Stage = SST_INPUT_COLOR_IMAGE`.
`StageConvertToGrayscale`	Stage object with `Stage = SST_CONVERT_TO_GRAYSCALE`.
`StageTransformGrayscale`	Stage object with `Stage = SST_TRANSFORM_GRAYSCALE`.
`StageEnhanceGrayscale`	Stage object with `Stage = SST_ENHANCE_GRAYSCALE`.
`StageBinarizeImage`	Stage object with `Stage = SST_BINARIZE_IMAGE`.
`StageDetectTexture`	Stage object with `Stage = SST_DETECT_TEXTURE`.
`StageRemoveTextureFromGrayscale`	Stage object with `Stage = SST_REMOVE_TEXTURE_FROM_GRAYSCALE`.
`StageBinarizeTextureRemovedGrayscale`	Stage object with `Stage = SST_BINARIZE_TEXTURE_REMOVED_GRAYSCALE`.
`StageDetectTextZones`	Stage object with `Stage = SST_DETECT_TEXT_ZONES`.
`StageRemoveTextZonesFromBinary`	Stage object with `Stage = SST_REMOVE_TEXT_ZONES_FROM_BINARY`.
`StageDetectShortlines`	Stage object with `Stage = SST_DETECT_SHORTLINES`.
`StageFindContours`	Stage object with `Stage = SST_FIND_CONTOURS`.
`StageAssembleLines`	Stage object with `Stage = SST_ASSEMBLE_LINES`.
`StageScaleImage`	Stage object with `Stage = SST_SCALE_IMAGE`.