capacitor-plugin-scanbot-sdk
    Preparing search index...

    Class DocumentQualityAnalyzerResult

    Result of document quality analysis. It can be used to determine, e.g., if a document is good enough to be used for OCR processing.

    Index

    Constructors

    constructor

    Properties

    bestInputScale cumulativeQualityHistogram documentFound orientation orientationConfidence quality qualityHeatmap qualityLevel

    Methods

    encodeImages release serialize

    Constructors

    Properties

    bestInputScale: number

    Returns the best inputScale whose results are used (see inputScales configuration option).

    cumulativeQualityHistogram: number[]

    Cumulative histogram where every entry is equal to the number of symbols with quality equal or lower than N percent, where N is the index of the entry in the array.

    documentFound: boolean

    Deprecated, please use quality instead, because it provides a more reliable result. True if a document was found.

    orientation: number

    Dominant orientation of the document, if found. The value is in degrees counter-clockwise, where 0 corresponds to the document being straight, and the value is in the range of [-180, 180]. To rotate the document to be straight, rotate the image clockwise by this value.

    orientationConfidence: number

    Confidence that the reported orientation of the document is correct. The value is in the range of [0, 1]. Possible reasons for low confidence are:

    • Document contains text with multiple orientations.
    • Text on the document is poorly readable.
    • Text on the document is on the edge of detectable text range (text is too small or too big).
    • Insufficient statistics because only part of the image was processed. See ProcessByTileConfiguration options in the DocumentQualityAnalyzerConfiguration.
    quality: DocumentQualityAssessment

    Document quality as estimated from the given quality analysis model.

    qualityHeatmap: ImageRef | null

    Quality heatmap. Black marks areas of no detected text. Colors represent the quality of detected text, with red meaning the lowest quality and yellow and green meaning progressively higher quality.

    qualityLevel: DocumentQuality | null

    Deprecated, please use quality instead, because it provides a more reliable result. Quality of the document, if found. The exact behavior of this value can be configured with the qualityThresholds and qualityIndices parameters.

    Methods

    • Returns Promise<void>

    • Returns void

    • Parameters

      Returns Promise<
          {
              bestInputScale?: number;
              cumulativeQualityHistogram?: number[];
              documentFound?: boolean;
              encodeImages?: () => Promise<void>;
              orientation?: number;
              orientationConfidence?: number;
              quality?: DocumentQualityAssessment;
              qualityHeatmap?:
                  | {
                      buffer?: string;
                      clear?: () => Promise<void>;
                      encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
                      encodeInPlace?: () => Promise<void>;
                      hibernate?: () => Promise<void>;
                      info?: () => Promise<ImageInfo | null>;
                      isRetained?: () => boolean;
                      release?: () => void;
                      retain?: () => void;
                      saveImage?: (
                          path: string,
                          options?: SaveImageOptions,
                      ) => Promise<boolean>;
                      serialize?: (
                          imageSerializationMode: ImageSerializationMode,
                      ) => Promise<
                          | (
                              { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}
                          )
                          | null,
                      >;
                      uniqueId?: string;
                  } & {}
                  | null;
              qualityLevel?: DocumentQuality
              | null;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<{ readonly quality?: DocumentQualityAssessment | undefined; readonly documentFound?: boolean | undefined; readonly qualityLevel?: DocumentQuality | null | undefined; ... 7 more ...; encodeImages?: (() => Promise<...>) | undefined; }>;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods