straighten

abstract fun straighten(image: ImageRef, parameters: DocumentStraighteningParameters = DocumentStraighteningParameters( ), priorCornersNormalized: List<PointF> = listOf( )): Result<DocumentStraighteningResult>

Straightens the document effectively straightening its edges and text.

Return

The detection result.

Parameters

image

The image of the document to straighten.

parameters

The parameters to use for straightening.

priorCornersNormalized

If it is known where the document corners (e.g. from a prior detection), those can be provided here. The enhancer may take them into account to locate the document more accurately. As part of the straightening process, it may be necessary to detect the document corners. That's why providing them here can speed up the process (given the corners are already available). Corners must be provided in the clockwise order: top-left, top-right, bottom-right, bottom-left. The coordinates must be normalized to the range 0, 1 relative to the image dimensions. For x coordinates, 0 corresponds to the left edge of the image and 1 to the right edge. For y coordinates, 0 corresponds to the top edge of the image and 1 to the bottom edge. Note, that when a coordinate is normalized, correct formula for x coordinate is: x_normalized = x_pixel / (image_width - 1), and for y coordinate is: y_normalized = y_pixel / (image_height - 1).