Class DocumentQualityAnalyzerConfiguration

Document Quality Analyzer configuration.

Hierarchy

Constructors

Properties

detectOrientation: boolean

Enable orientation detection. Document orientation will be returned in DocumentQualityAnalyzerResult.orientation.

Default Value

false;
earlyStopIfNSymbolsFound: number

If this number of symbols is found and minProcessedFraction of the image is processed, the processing stops.

Default Value

100;
maxImageSize: number

Maximum image size in pixels, if image is bigger, it will be resized.

Default Value

2000;
maxProcessedFraction: number

at most this fraction of the image will be processed, range is from 0 to 1.

Default Value

0.5;
minEstimatedNumberOfSymbolsForDocument: number

if estimated number of symbols is less than this value, return that document is not found.

Default Value

20;
minProcessedFraction: number

at least this fraction of the image will be processed, range is from 0 to 1.

Default Value

0.0;
qualityIndices: DocumentQuality[]

quality levels.

Default Value

["VERY_POOR", "POOR", "REASONABLE", "GOOD", "EXCELLENT"];
qualityThresholds: DocumentQualityThreshold[]

Quality thresholds to separate quality levels.

Default Value

[new DocumentQualityThreshold({
"symbolQuality": 0.5,
"symbolRatio": 0.5
}), new DocumentQualityThreshold({
"symbolQuality": 0.7,
"symbolRatio": 0.3
}), new DocumentQualityThreshold({
"symbolQuality": 0.85,
"symbolRatio": 0.3
}), new DocumentQualityThreshold({
"symbolQuality": 0.9,
"symbolRatio": 0.1
})];
returnQualityHeatmap: boolean

If true, will return the quality heatmap as a part of the result. In this case, the entire image will be processed and the minProcessedFraction will be ignored. Useful for debugging situations where the returned quality doesn't appear to match the perceived quality.

Default Value

false;
tileSize: number

Image will be processed in tiles of this size; will be ignored if image is small.

Default Value

300;

Generated using TypeDoc