Class DocumentQualityAnalyzer

image: Image

Optional consumeImage: Config.ConsumeType

workerBridge: WorkerBridge

Optional configuration: {
    detectOrientation?: boolean;
    inspectSmallText?: boolean;
    maxImageSize?: number;
    maxProcessedFraction?: number;
    minEstimatedNumberOfSymbolsForDocument?: number;
    minNumberOfRequiredSymbols?: number;
    minProcessedFraction?: number;
    minRequiredOrientationConfidence?: number;
    qualityIndices?: DocumentQuality[];
    qualityThresholds?: ({ readonly symbolQuality?: number; readonly symbolRatio?: number; })[];
    returnQualityHeatmap?: boolean;
    tileSize?: number;
}

• Optional detectOrientation?: boolean

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

  Default Value

  false;
  Copy

• Optional inspectSmallText?: boolean

  Inspect small text (typically less than 12 pixels height) when analyzing the document quality. If true, processing will be slower, but when the quality issue with a document is the low resolution of the text, then the issue will be caught.

  Default Value

  false;
  Copy

• Optional maxImageSize?: number

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

  Default Value

  2000;
  Copy

• Optional maxProcessedFraction?: number

  At most this fraction of the image will be processed, range is from 0 to 1. Decreasing this value below 1.0 can lead to faster processing but may result in less accurate prediction, as only a subset of the image tiles will be analyzed.

  Default Value

  1.0;
  Copy

• Optional minEstimatedNumberOfSymbolsForDocument?: number

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

  Default Value

  20;
  Copy

• Optional minNumberOfRequiredSymbols?: number

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

  Default Value

  100;
  Copy

• Optional minProcessedFraction?: number

  At least this fraction of the image will be processed, range is from 0 to 1. Decreasing this value below 1.0 can lead to faster processing but may result in less accurate prediction, as only a subset of the image tiles will be analyzed.

  Default Value

  1.0;
  Copy

• Optional minRequiredOrientationConfidence?: number

  If detectOrientation is True, minNumberOfRequiredSymbols is found, and orientationConfidence is bigger than this threshold, the processing stops. If the maxProcessedFraction part of the image is processed and orientationConfidence is lower than the threshold, the returned orientation will be 0.

  Default Value

  0.0;
  Copy

• Optional qualityIndices?: DocumentQuality[]

  quality levels.

  Default Value

  ["VERY_POOR", "POOR", "REASONABLE", "GOOD", "EXCELLENT"];
  Copy

• Optional qualityThresholds?: ({ readonly symbolQuality?: number; readonly symbolRatio?: number; })[]

  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
  })];
  Copy

• Optional 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;
  Copy

• Optional tileSize?: number

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

  Default Value

  300;
  Copy