kfxKEDImagePerfectionProfile.h

Go to the documentation of this file.

//  API Reference
//
//  kfxKEDImagePerfectionProfile.h
//  KMCEngineData Objects
//
//  Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//

#import <Foundation/Foundation.h>

#ifndef KEDIMAGEPERFECTIONPROFILE
#define KEDIMAGEPERFECTIONPROFILE 1


typedef enum {
    KED_USEMRZDETECTION_OFF,
    KED_USEMRZDETECTION_ON,
    KED_USEMRZDETECTION_LAST
} KEDMRZDetectionOptions;


typedef enum {
    KED_USETARGETFRAMECROP_OFF,
    KED_USETARGETFRAMECROP_ON,
    KED_USETARGETFRAMECROP_LAST
} KEDTargetFrameCropOptions;


typedef enum {
    KED_USEDOCUMENTDETECTIONBASEDCROP_OFF,
    KED_USEDOCUMENTDETECTIONBASEDCROP_ON,
    KED_USEDOCUMENTDETECTIONBASEDCROP_LAST
} KEDDocumentDetectionBasedCropOptions;


__deprecated_msg("This class was deprecated in SDK 3.3. Please use KFXImageProcessorConfiguration instead.")
@interface kfxKEDImagePerfectionProfile : NSObject <NSCoding>


// ===================================================

@property (retain,atomic) NSString *name;

// ===================================================

@property (retain,atomic) NSString *ipOperations;         // a valid operations string

// ===================================================

@property (retain,atomic) NSString *ipOperationsFilePath;   // a path to an XML settings file in the app's bundle

// ==========================================================

//=============================
/*
 Application should set the property to KED_USEMRZDETECTION_ON to enable MRZ passport detection during document processing.
 Default:KED_USEMRZDETECTION_OFF
 */
@property (atomic) KEDMRZDetectionOptions useMRZPassportDetection;

// ===================================================

@property (atomic) KEDTargetFrameCropOptions useTargetFrameCrop;

// ===================================================

@property (atomic) KEDDocumentDetectionBasedCropOptions useDocumentDetectionBasedCrop;

-(id)init;


// ==========================================================

-(id)initWithName:(NSString*)name;


// ==========================================================

-(id)initWithName:(NSString*)name andFilePath: (NSString*) filePath;


// ==========================================================

-(id)initWithName:(NSString*)name andOperations: (NSString*) ops;


@end

#endif