Class DocumentDetectionScores

constructor

• new DocumentDetectionScores(
      source?: DeepPartial<DocumentDetectionScores>,
  ): DocumentDetectionScores

  Parameters

  • Optionalsource: DeepPartial<DocumentDetectionScores>

  Returns DocumentDetectionScores

ReadonlyalreadyCroppedScore

ReadonlyangleScore

ReadonlyaspectRatioScore

ReadonlydistanceScore

ReadonlyheightScore

ReadonlylineCoverageScore

ReadonlysizeScore

ReadonlytotalScore

ReadonlywidthScore

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      alreadyCroppedScore?: number;
      angleScore?: number;
      aspectRatioScore?: number;
      distanceScore?: number;
      heightScore?: number;
      lineCoverageScore?: number;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; readonly angleScore?: number | undefined; readonly sizeScore?: number | undefined; readonly aspectRatioScore?: number | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      sizeScore?: number;
      totalScore?: number;
      widthScore?: number;
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      alreadyCroppedScore?: number;
      angleScore?: number;
      aspectRatioScore?: number;
      distanceScore?: number;
      heightScore?: number;
      lineCoverageScore?: number;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; readonly angleScore?: number | undefined; readonly sizeScore?: number | undefined; readonly aspectRatioScore?: number | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      sizeScore?: number;
      totalScore?: number;
      widthScore?: number;
  }

  • Optional ReadonlyalreadyCroppedScore?: number

    Single-shot mode and ML engine mode only: Confidence in percent that the input image is already of a cropped document.

  • Optional ReadonlyangleScore?: number

    100 points, if all angles are 90 degrees.

  • Optional ReadonlyaspectRatioScore?: number

    100 points, if the aspect ratio matches exactly one of the given aspect ratios.

  • Optional ReadonlydistanceScore?: number

    100 points, if the center of the contour is exactly in the image center.

  • Optional ReadonlyheightScore?: number

    Percentage of the image height taken by the detected document.

  • Optional ReadonlylineCoverageScore?: number

    Percentage of the document contour that the edge detector was able to find (in LEGACY engine mode only).

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; readonly angleScore?: number | undefined; readonly sizeScore?: number | undefined; readonly aspectRatioScore?: number | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }

  • Optional ReadonlysizeScore?: number

    100 points, if the contour occupies at least 50% of the area of the image.

  • Optional ReadonlytotalScore?: number

    Weighted sum of all partial scores.

  • Optional ReadonlywidthScore?: number

    Percentage of the image width taken by the detected document.