org.bytedeco.opencv.opencv_objdetect

Class BarcodeDetector

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_objdetect.GraphicalCodeDetector

org.bytedeco.opencv.opencv_objdetect.BarcodeDetector

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::barcode")
 @Properties(inherit=opencv_objdetect.class)
public class BarcodeDetector
extends GraphicalCodeDetector

\addtogroup objdetect_barcode \{

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.opencv.opencv_objdetect.GraphicalCodeDetector

GraphicalCodeDetector.Impl

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
BarcodeDetector() \brief Initialize the BarcodeDetector.
BarcodeDetector(BytePointer prototxt_path, BytePointer model_path) \brief Initialize the BarcodeDetector.
BarcodeDetector(long size) Native array allocator.
BarcodeDetector(Pointer p) Pointer cast constructor.
BarcodeDetector(String prototxt_path, String model_path)

Method Summary

Modifier and Type	Method and Description
boolean	decodeWithType(GpuMat img, GpuMat points, StringVector decoded_info, StringVector decoded_type)
boolean	decodeWithType(Mat img, Mat points, StringVector decoded_info, StringVector decoded_type) \brief Decodes barcode in image once it's found by the detect() method.
boolean	decodeWithType(UMat img, UMat points, StringVector decoded_info, StringVector decoded_type)
boolean	detectAndDecodeWithType(GpuMat img, StringVector decoded_info, StringVector decoded_type)
boolean	detectAndDecodeWithType(GpuMat img, StringVector decoded_info, StringVector decoded_type, GpuMat points)
boolean	detectAndDecodeWithType(Mat img, StringVector decoded_info, StringVector decoded_type)
boolean	detectAndDecodeWithType(Mat img, StringVector decoded_info, StringVector decoded_type, Mat points) \brief Both detects and decodes barcode
boolean	detectAndDecodeWithType(UMat img, StringVector decoded_info, StringVector decoded_type)
boolean	detectAndDecodeWithType(UMat img, StringVector decoded_info, StringVector decoded_type, UMat points)
void	getDetectorScales(float[] sizes)
void	getDetectorScales(FloatBuffer sizes)
void	getDetectorScales(FloatPointer sizes) \brief Returns detector box filter sizes.
double	getDownsamplingThreshold() \brief Get detector downsampling threshold.
double	getGradientThreshold() \brief Get detector gradient magnitude threshold.
BarcodeDetector	getPointer(long i)
BarcodeDetector	position(long position)
BarcodeDetector	setDetectorScales(float[] sizes)
BarcodeDetector	setDetectorScales(FloatBuffer sizes)
BarcodeDetector	setDetectorScales(FloatPointer sizes) \brief Set detector box filter sizes.
BarcodeDetector	setDownsamplingThreshold(double thresh) \brief Set detector downsampling threshold.
BarcodeDetector	setGradientThreshold(double thresh) \brief Set detector gradient magnitude threshold.

Methods inherited from class org.bytedeco.opencv.opencv_objdetect.GraphicalCodeDetector

decode, decode, decode, decode, decode, decode, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, decodeMulti, detect, detect, detect, detectAndDecode, detectAndDecode, detectAndDecode, detectAndDecode, detectAndDecode, detectAndDecode, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectAndDecodeMulti, detectMulti, detectMulti, detectMulti, put

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BarcodeDetector

public BarcodeDetector(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BarcodeDetector

public BarcodeDetector(long size)

Native array allocator. Access with Pointer.position(long).

BarcodeDetector

public BarcodeDetector()

\brief Initialize the BarcodeDetector.

BarcodeDetector

public BarcodeDetector(@StdString
                       BytePointer prototxt_path,
                       @StdString
                       BytePointer model_path)

\brief Initialize the BarcodeDetector. Parameters allow to load _optional_ Super Resolution DNN model for better quality.

Parameters:

prototxt_path - prototxt file path for the super resolution model

model_path - model file path for the super resolution model

BarcodeDetector

public BarcodeDetector(@StdString
                       String prototxt_path,
                       @StdString
                       String model_path)

Method Detail

position

public BarcodeDetector position(long position)

Overrides:

position in class GraphicalCodeDetector

getPointer

public BarcodeDetector getPointer(long i)

Overrides:

getPointer in class GraphicalCodeDetector

decodeWithType

@Cast(value="bool")
public boolean decodeWithType(@ByVal
                                                   Mat img,
                                                   @ByVal
                                                   Mat points,
                                                   @ByRef
                                                   StringVector decoded_info,
                                                   @ByRef
                                                   StringVector decoded_type)

\brief Decodes barcode in image once it's found by the detect() method.

Parameters:

img - grayscale or color (BGR) image containing bar code.

points - vector of rotated rectangle vertices found by detect() method (or some other algorithm). For N detected barcodes, the dimensions of this array should be [N][4]. Order of four points in vector is bottomLeft, topLeft, topRight, bottomRight.

decoded_info - UTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.

decoded_type - vector strings, specifies the type of these barcodes

Returns:

true if at least one valid barcode have been found

decodeWithType

@Cast(value="bool")
public boolean decodeWithType(@ByVal
                                                   UMat img,
                                                   @ByVal
                                                   UMat points,
                                                   @ByRef
                                                   StringVector decoded_info,
                                                   @ByRef
                                                   StringVector decoded_type)

decodeWithType

@Cast(value="bool")
public boolean decodeWithType(@ByVal
                                                   GpuMat img,
                                                   @ByVal
                                                   GpuMat points,
                                                   @ByRef
                                                   StringVector decoded_info,
                                                   @ByRef
                                                   StringVector decoded_type)

detectAndDecodeWithType

@Cast(value="bool")
public boolean detectAndDecodeWithType(@ByVal
                                                            Mat img,
                                                            @ByRef
                                                            StringVector decoded_info,
                                                            @ByRef
                                                            StringVector decoded_type,
                                                            @ByVal(nullValue="cv::OutputArray(cv::noArray())")
                                                            Mat points)

\brief Both detects and decodes barcode

Parameters:

img - grayscale or color (BGR) image containing barcode.

decoded_info - UTF8-encoded output vector of string(s) or empty vector of string if the codes cannot be decoded.

decoded_type - vector of strings, specifies the type of these barcodes

points - optional output vector of vertices of the found barcode rectangle. Will be empty if not found.

Returns:

true if at least one valid barcode have been found

detectAndDecodeWithType

@Cast(value="bool")
public boolean detectAndDecodeWithType(@ByVal
                                                            Mat img,
                                                            @ByRef
                                                            StringVector decoded_info,
                                                            @ByRef
                                                            StringVector decoded_type)

detectAndDecodeWithType

@Cast(value="bool")
public boolean detectAndDecodeWithType(@ByVal
                                                            UMat img,
                                                            @ByRef
                                                            StringVector decoded_info,
                                                            @ByRef
                                                            StringVector decoded_type,
                                                            @ByVal(nullValue="cv::OutputArray(cv::noArray())")
                                                            UMat points)

detectAndDecodeWithType

@Cast(value="bool")
public boolean detectAndDecodeWithType(@ByVal
                                                            UMat img,
                                                            @ByRef
                                                            StringVector decoded_info,
                                                            @ByRef
                                                            StringVector decoded_type)

detectAndDecodeWithType

@Cast(value="bool")
public boolean detectAndDecodeWithType(@ByVal
                                                            GpuMat img,
                                                            @ByRef
                                                            StringVector decoded_info,
                                                            @ByRef
                                                            StringVector decoded_type,
                                                            @ByVal(nullValue="cv::OutputArray(cv::noArray())")
                                                            GpuMat points)

detectAndDecodeWithType

@Cast(value="bool")
public boolean detectAndDecodeWithType(@ByVal
                                                            GpuMat img,
                                                            @ByRef
                                                            StringVector decoded_info,
                                                            @ByRef
                                                            StringVector decoded_type)

getDownsamplingThreshold

public double getDownsamplingThreshold()

\brief Get detector downsampling threshold.

Returns:

detector downsampling threshold

setDownsamplingThreshold

@ByRef
public BarcodeDetector setDownsamplingThreshold(double thresh)

\brief Set detector downsampling threshold. By default, the detect method resizes the input image to this limit if the smallest image size is is greater than the threshold. Increasing this value can improve detection accuracy and the number of results at the expense of performance. Correlates with detector scales. Setting this to a large value will disable downsampling.

Parameters:

thresh - downsampling limit to apply (default 512)

See Also:

setDetectorScales

getDetectorScales

public void getDetectorScales(@StdVector
                              FloatPointer sizes)

\brief Returns detector box filter sizes.

Parameters:

sizes - output parameter for returning the sizes.

getDetectorScales

public void getDetectorScales(@StdVector
                              FloatBuffer sizes)

getDetectorScales

public void getDetectorScales(@StdVector
                              float[] sizes)

setDetectorScales

@ByRef
public BarcodeDetector setDetectorScales(@StdVector
                                                 FloatPointer sizes)

\brief Set detector box filter sizes. Adjusts the value and the number of box filters used in the detect step. The filter sizes directly correlate with the expected line widths for a barcode. Corresponds to expected barcode distance. If the downsampling limit is increased, filter sizes need to be adjusted in an inversely proportional way.

Parameters:

sizes - box filter sizes, relative to minimum dimension of the image (default [0.01, 0.03, 0.06, 0.08])

setDetectorScales

@ByRef
public BarcodeDetector setDetectorScales(@StdVector
                                                 FloatBuffer sizes)

setDetectorScales

@ByRef
public BarcodeDetector setDetectorScales(@StdVector
                                                 float[] sizes)

getGradientThreshold

public double getGradientThreshold()

\brief Get detector gradient magnitude threshold.

Returns:

detector gradient magnitude threshold.

setGradientThreshold

@ByRef
public BarcodeDetector setGradientThreshold(double thresh)

\brief Set detector gradient magnitude threshold. Sets the coherence threshold for detected bounding boxes. Increasing this value will generate a closer fitted bounding box width and can reduce false-positives. Values between 16 and 1024 generally work, while too high of a value will remove valid detections.

Parameters:

thresh - gradient magnitude threshold (default 64).