
public final class ContourDetector

Performs contour detection.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`ContourDetector.Type`	The type of the ContourDetector. ML_BASED is the default implementation
`public class`	`ContourDetector.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final List<Point>`	`polygon`
`private final List<PointF>`	`polygonF`
`private final Double`	`detectionScore`
`private final List<Line2D>`	`verticalLines`
`private final List<Line2D>`	`horizontalLines`

Constructor Summary

Constructors
Constructor	Description
`ContourDetector(ContourDetector.Type contourDetectorType)`

Method Summary

Modifier and Type	Method	Description
`final List<Point>`	`getPolygon()`
`final List<PointF>`	`getPolygonF()`
`final Double`	`getDetectionScore()`
`final List<Line2D>`	`getVerticalLines()`
`final List<Line2D>`	`getHorizontalLines()`
`final DetectionResult`	`detect(ByteArray nv21, Integer width, Integer height)`	Tries to detect a polygon from the given image.
`final DetectionResult`	`detect(ByteArray data)`	Tries to detect a polygon from the given image.
`final DetectionResult`	`detect(String fileName)`	Tries to detect a polygon from the given file.
`final DetectionResult`	`detect(Bitmap bitmap)`	Tries to detect a polygon from the given image.
`final Unit`	`setAcceptedAngleScore(Double acceptedAngleScore)`	The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
`final Unit`	`setAcceptedSizeScore(Double acceptedSizeScore)`	The minimum size in percent (0 - 100) of the screen size to accept a detected document.
`final Unit`	`setRequiredAspectRatios(List<PageAspectRatio> requiredPageAspectRatios)`	Set required PageAspectRatios.
`final Unit`	`setRectOfInterest(RectF rectOfInterest)`	Set rect od interest sizes.
`final Unit`	`resetPolygonHistory()`	Calling this method will reset the polygon smoothing history.
`final Unit`	`dtor(Long ptr)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContourDetector
```
ContourDetector(ContourDetector.Type contourDetectorType)
```
    Parameters:
    
    contourDetectorType - type of the document detector to use
- Method Detail
  - getPolygon
```
 final List<Point> getPolygon()
```
  - getPolygonF
```
 final List<PointF> getPolygonF()
```
  - getDetectionScore
```
 final Double getDetectionScore()
```
  - getVerticalLines
```
 final List<Line2D> getVerticalLines()
```
  - getHorizontalLines
```
 final List<Line2D> getHorizontalLines()
```
  - detect
```
 final DetectionResult detect(ByteArray nv21, Integer width, Integer 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
  - detect
```
 final DetectionResult detect(ByteArray data)
```
    Tries to detect a polygon from the given image.
    
    Parameters:
    
    data - Encoded image (e.g.
  - detect
```
 final DetectionResult detect(String fileName)
```
    Tries to detect a polygon from the given file.
    
    Parameters:
    
    fileName - Encoded file path (e.g.
  - detect
```
 final DetectionResult detect(Bitmap bitmap)
```
    Tries to detect a polygon from the given image.
    
    Parameters:
    
    bitmap - The image
  - setAcceptedAngleScore
```
 final Unit 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.
  - setAcceptedSizeScore
```
 final Unit 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.
  - setRequiredAspectRatios
```
 final Unit setRequiredAspectRatios(List<PageAspectRatio> requiredPageAspectRatios)
```
    Set required PageAspectRatios.
  - setRectOfInterest
```
 final Unit setRectOfInterest(RectF rectOfInterest)
```
    Set rect od interest sizes.
    
    Parameters:
    
    rectOfInterest - RectF
  - resetPolygonHistory
```
 final Unit resetPolygonHistory()
```
    Calling this method will reset the polygon smoothing history.
  - dtor
```
 final Unit dtor(Long ptr)
```

Class ContourDetector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContourDetector

Method Detail

getPolygon

getPolygonF

getDetectionScore

getVerticalLines

getHorizontalLines

detect

detect

detect

detect

setAcceptedAngleScore

setAcceptedSizeScore

setRequiredAspectRatios

setRectOfInterest

resetPolygonHistory

dtor