io.scanbot.sdk.core.contourdetector

Class ContourDetector

io.scanbot.sdk.core.contourdetector.ContourDetector

All Implemented Interfaces:

Disposable

public class ContourDetector
implements Disposable

Performs contour detection.

Field Detail

Companion

public static io.scanbot.sdk.core.contourdetector.ContourDetector.Companion Companion

Constructor Detail

ContourDetector

public ContourDetector(@NotNull
                       io.scanbot.sdk.core.contourdetector.ContourDetector.Type contourDetectorType)

Performs contour detection.

Parameters:

contourDetectorType - type of the document detector to use

Method Detail

detect

@Nullable
public DetectionResult detect(@NotNull
                                        kotlin.Array[] nv21,
                                        int width,
                                        int height)

Tries to detect a polygon from the given image.

Parameters:

nv21 - NV21 encoded camera image

width - Width of the image pixels

height - Height of the image in pixels

Returns:

A enum DetectionResult that gives information about the recognition state.

detect

@Nullable
public DetectionResult detect(@NotNull
                                        kotlin.Array[] data)

Tries to detect a polygon from the given image.

Parameters:

data - Encoded image (e.g. a JPEG)

Returns:

A enum DetectionResult that gives information about the recognition state.

detect

@Nullable
public DetectionResult detect(@NotNull
                                        java.lang.String fileName)

Tries to detect a polygon from the given file.

Parameters:

fileName - Encoded file path (e.g. a JPEG)

Returns:

A enum DetectionResult that gives information about the recognition state.

detect

@Nullable
public DetectionResult detect(@NotNull
                                        android.graphics.Bitmap bitmap)

Tries to detect a polygon from the given image.

Parameters:

bitmap - The image

Returns:

A enum DetectionResult that gives information about the recognition state.

getPolygon

@Nullable
public java.util.List<android.graphics.Point> getPolygon()

Returns:

the detected polygon (if any) as absolute pixel coordinates.

getPolygonF

@Nullable
public java.util.List<android.graphics.PointF> getPolygonF()

Returns:

the detected polygon (if any) as floating point coordinates in [0.f, 1.f[.

getDetectionScore

public double getDetectionScore()

Returns:

the detection score (if any) as double value in [0.0, 100.0].

getVerticalLines

@NotNull
public java.util.List<io.scanbot.sdk.core.contourdetector.Line2D> getVerticalLines()

Returns:

Detected vertical lines

getHorizontalLines

@NotNull
public java.util.List<io.scanbot.sdk.core.contourdetector.Line2D> getHorizontalLines()

Returns:

Detected horizontal lines

setAcceptedAngleScore

public void setAcceptedAngleScore(double acceptedAngleScore)

The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion.

Warning: Lower values result in more blurred document images.

Parameters:

acceptedAngleScore -

setAcceptedSizeScore

public void setAcceptedSizeScore(double acceptedSizeScore)

The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0.

Warning: Lower values result in low resolution document images.

Parameters:

acceptedSizeScore -

setRequiredAspectRatios

public void setRequiredAspectRatios(@NotNull
                                    java.util.List<io.scanbot.sdk.core.contourdetector.PageAspectRatio> requiredPageAspectRatios)

Set required class PageAspectRatios.

Parameters:

requiredPageAspectRatios -

See Also:

class PageAspectRatio

setRectOfInterest

public void setRectOfInterest(@NotNull
                              android.graphics.RectF rectOfInterest)

Set rect od interest sizes.

Parameters:

rectOfInterest - RectF

resetPolygonHistory

public void resetPolygonHistory()

Calling this method will reset the polygon smoothing history.

dispose

public void dispose()

Disposes the native resources held by this instance.

dtor

public void dtor(long ptr)

createBitmapFromEncodedData

@JvmStatic
 @NotNull
public static android.graphics.Bitmap createBitmapFromEncodedData(@NotNull
                                                                                       kotlin.Array[] data)

Creates a ARGB_8888 Bitmap from an in-memory JPEG.

Parameters:

data - JPEG data.

Returns:

The decoded Bitmap.

createBitmapFromEncodedFile

@JvmStatic
 @NotNull
public static android.graphics.Bitmap createBitmapFromEncodedFile(@Nullable
                                                                                       java.lang.String fileName)

Creates a ARGB_8888 Bitmap from encoded JPEG on file system

Parameters:

fileName - path to JPEG file

Returns:

The decoded Bitmap.