Atalasoft MobileImage API Reference
Instance Methods | Properties | List of all members
kfxKEDImagePerfectionProfile Class Reference

Image Perfection Profile specifies advanced Image Processing options. More...

#import <kfxKEDImagePerfectionProfile.h>

Inheritance diagram for kfxKEDImagePerfectionProfile:

Instance Methods

(id) - init
 Initialize the image perfection profile object. More...
 
(id) - initWithName:
 Initialize the image perfection profile instance with a given name. More...
 
(id) - initWithName:andFilePath:
 Initialize the image perfection profile instance with a given name and a settings file path. More...
 
(id) - initWithName:andOperations:
 Initialize the image perfection profile instance with a given operation string. More...
 

Properties

NSString * name
 Name of this particular image perfection profile. More...
 
NSString * ipOperations
 Unique IP Operations string. More...
 
NSString * ipOperationsFilePath
 Filepath of a unique settings file. More...
 

Detailed Description

Image Perfection Profile specifies advanced Image Processing options.

Framework: libKfxEngines
Import suggestion: #import <kfxLibEngines/kfxEngines.h>
An instance of this class contains the advanced image processing options to perform on an image. These settings are a superset of what is possible with basic settings profiles. These settings may have originated from a KFS Server, a Total Agility server or your own application. This object contains more complicated image processing settings, and allows two methods of specifying these settings: with an Operations string or an XML Settings file. If both an ImagePerfectionProfile and a BasicSettingsProfile are supplied to an image processing engine, the ImagePerfectionProfile takes presidence, while ignoring the basic settings.

Serialization**

This class adopts the NSCoding protocol so that this object may be archived and unarchived using the iOS standard [NSKeyedArchiver archiveRootObject:<object> toFile: archiveFileName]; approach. Using keyed archive files, you can save this object for later use. The library supports backward compatibility, such that as a new version of an app that uses the API in this SDK, includes a newer versions of the SDK libraries that have data model changes, the older archive can still be read by the newer version. However, it is not a design goal to archive and dearchive with forward compatibility, such as decoding an archive on a newer version of the class, using an older library.

Refer to the kfxKEDImage class description, by expanding the class description, that describes how to archive and unarchive objects in this framework that adopt the NSCoding protocol.
You can create keyed archives using NSKeyedArchiver objects and decoded by NSKeyedUnarchiver objects. The framework design uses keyed archives, which differ from sequential archives, in that every value encoded in a keyed archive is given a Kofax unique key name. When you decode an archive, the underlying implementation can use values by name, allowing the unarchive delegate to request values in any order or not at all.
Please refer to the Apple documentation for more information: https://developer.apple.com/library/ios/documentation/cocoa/reference/foundation/Classes/NSCoder_Class/Reference/NSCoder.html

Keyed Archiving* https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedArchiver_Class/Reference/Reference.html#//apple_ref/occ/cl/NSKeyedArchiver

Keyed Unarchiving* https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedUnarchiver_Class/Reference/Reference.html#//apple_ref/occ/instm/NSKeyedUnarchiver

Method Documentation

- (id) init

Initialize the image perfection profile object.

Use this method in your typical initialization of the object. This initializes the object with the standard defaults.

Returns
A kfxKEDImagePerfectionProfile object
- (id) initWithName: (NSString *)  name

Initialize the image perfection profile instance with a given name.

Use this method in your typical [[kfxKEDImagePerfectionProfile alloc] initWithName: "ProfileName"]; code lines to initialize an instance of this class with the standard defaults.

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

Initialize the image perfection profile instance with a given name and a settings file path.

Use this method in your typical [[kfxKEDImagePerfectionProfile alloc] initWithName: "ProfileName andFilePath: "yourFilePath"]; code lines to initialize an instance of this class with the standard defaults.

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

Initialize the image perfection profile instance with a given operation string.

Use this method in your typical [[kfxKEDImagePerfectionProfile alloc] initWithName: "ProfileName andOperations: "_DoBinarization_"]; code lines to initialize an instance of this class with the standard defaults, and the specified operations string with individual image processing tokens.

Property Documentation

- (NSString*) ipOperations
readwriteatomicretain

Unique IP Operations string.

App specific definition of the encoded imaged processing (IP) options desired. The string is composed of a concatonation of individual IP tokens, each of which enable an option. Please refer to the developers guide for a list of IP tokens.

- (NSString*) ipOperationsFilePath
readwriteatomicretain

Filepath of a unique settings file.

App specific definition of the encoded imaged processing (IP) options desired stored in an XML file. Please refer to the developers guide for a definition of the XML file format.

- (NSString*) name
readwriteatomicretain

Name of this particular image perfection profile.

App specific reference name, used to associate a name with this profile, usually describing its purpose.


The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.