RecognizerRunner.h File Reference

#include "Export.h"
#include "Recognizer.h"
#include "RecognizerError.h"
#include "RecognizerImage.h"
#include "Rectangle.h"
#include "Types.h"
#include <stdlib.h>

Go to the source code of this file.

Data Structures
struct	MBRecognizerRunnerSettings
	Recognizer runner settings data structure. More...
struct	MBPoint
	This structure represents the 2D point. More...
struct	MBSize
	This structure represents the two-dimensional size of an object. More...
struct	MBRecognitionCallback
	The MBRecognitionCallback struct. More...

Typedefs
typedef typedefMB_EXPORTED_TYPE struct MBRecognizerRunner	MBRecognizerRunner
	Typedef for MBRecognizerRunner structure.
typedef MB_EXPORTED_TYPE struct MBRecognizerRunnerSettings	MBRecognizerRunnerSettings
	Typedef for MBRecognizerRunnerSettings structure.
typedef MB_EXPORTED_TYPE struct MBPoint	MBPoint
	Typedef for MBPoint structure.
typedef MB_EXPORTED_TYPE struct MBSize	MBSize
	Typedef for MBSize structure.
typedef MB_EXPORTED_TYPE enum MBDetectionStatus	MBDetectionStatus
	Typedef for MBDetectionStatus enum.
typedef MB_EXPORTED_TYPE enum MBShowImageType	MBShowImageType
	Typedef for the MBShowImageType enum.
typedef MB_EXPORTED_TYPE struct MBRecognitionCallback	MBRecognitionCallback
	Typedef for MBRecognitionCallback structure.

Enumerations
enum	MBDetectionStatus {   DETECTION_STATUS_SUCCESS , DETECTION_STATUS_FAIL , DETECTION_STATUS_CAMERA_TOO_HIGH , DETECTION_STATUS_PARTIAL_OBJECT ,   DETECTION_STATUS_CAMERA_AT_ANGLE , DETECTION_STATUS_CAMERA_TOO_NEAR , DETECTION_STATUS_DOCUMENT_TOO_CLOSE_TO_EDGE }
	Defines a status of the object detection process. More...
enum	MBShowImageType { SHOW_IMAGE_TYPE_ORIGINAL , SHOW_IMAGE_TYPE_DEWARPED , SHOW_IMAGE_TYPE_SUCCESSFUL_SCAN }
	Enumeration of types of images returned via onShowImage callback function. More...

Detailed Description

Copyright (c)2015 MicroBlink Ltd. All rights reserved.

ANY UNAUTHORIZED USE OR SALE, DUPLICATION, OR DISTRIBUTION OF THIS PROGRAM OR ANY OF ITS PARTS, IN SOURCE OR BINARY FORMS, WITH OR WITHOUT MODIFICATION, WITH THE PURPOSE OF ACQUIRING UNLAWFUL MATERIAL OR ANY OTHER BENEFIT IS PROHIBITED! THIS PROGRAM IS PROTECTED BY COPYRIGHT LAWS AND YOU MAY NOT REVERSE ENGINEER, DECOMPILE, OR DISASSEMBLE IT.

Enumeration Type Documentation

MBDetectionStatus

enum MBDetectionStatus

Defines a status of the object detection process.

Enumerator
DETECTION_STATUS_SUCCESS	Object has been detected successfully
DETECTION_STATUS_FAIL	Detection failed, nothing detected
DETECTION_STATUS_CAMERA_TOO_HIGH	Object detected, but the camera is too far above it
DETECTION_STATUS_PARTIAL_OBJECT	Object has been detected, but some parts of it are not in image
DETECTION_STATUS_CAMERA_AT_ANGLE	Object has been detected, but camera is at too big angle
DETECTION_STATUS_CAMERA_TOO_NEAR	Object detected, but the camera is too close to the object
DETECTION_STATUS_DOCUMENT_TOO_CLOSE_TO_EDGE	Document detected, but document is too close to the edge of the frame

MBShowImageType

enum MBShowImageType

Enumeration of types of images returned via onShowImage callback function.

Enumerator
SHOW_IMAGE_TYPE_ORIGINAL	original image passed to recognizer
SHOW_IMAGE_TYPE_DEWARPED	image with position and orientation adjusted and cropped for further processing
SHOW_IMAGE_TYPE_SUCCESSFUL_SCAN	final image resulting from a successful scan