Need better scanning performance?
ImageScaleSetting
Parameter ImageScaleSetting is for controlling how to up or down scale the image.
JSON Structure
Location in template:
ImageParameterOptions[i]
└── ApplicableStages[j] (Stage object where Stage = "SST_SCALE_IMAGE")
└── ImageScaleSetting
Parent object: ScaleImageStage
Example:
{
"ImageScaleSetting": {
"ScaleType": "ST_SCALE_DOWN",
"ReferenceEdge": "RE_SHORTER_EDGE",
"EdgeLengthThreshold": 2300
}
}
- This snippet shows only the
ImageScaleSettingparameter.- To use it, embed this parameter within a ScaleImageStage object.
- For the complete JSON structure, see:
Parameter Details
The ImageScaleSetting object includes the following parameters:
ScaleType
Specifies whether to scale up or down the image.
| ScaleType Parameter Details |
|---|
| Type String |
| Value Range “ST_SCALE_DOWN”, “ST_SCALE_UP” |
| Default Value “ST_SCALE_DOWN” |
ReferenceEdge
Specifies which edge (longer edge or shorter edge) to use when scaling the image.
| ReferenceEdge Parameter Details |
|---|
| Type String |
| Value Range “RE_SHORTER_EDGE”, “RE_LONGER_EDGE” |
| Default Value “RE_SHORTER_EDGE” |
EdgeLengthThreshold
Specifies the threshold for scaling the image.
- If the
ScaleTypeis set to “ST_SCALE_DOWN”, the image will be continuously scaled down until theReferenceEdgeis shorter than theEdgeLengthThreshold. - If the
ScaleTypeis set to “ST_SCALE_UP”, the image will be continuously scaled up until theReferenceEdgeis longer than theEdgeLengthThreshold.
| EdgeLengthThreshold Parameter Details |
|---|
| Type int |
| Value Range [512, 0x7fffffff] |
| Default Value 2300 |