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

A single classification result. More...

#import <kfxKEDClassificationResult.h>

Inheritance diagram for kfxKEDClassificationResult:

Class Methods

(NSString *) + decodeClassifierOrientation:
 Decode the orientation into a string equivalent. More...


NSString * classID
 Image classification ID. More...
KEDClassifierOrientation orientation
 Orientation of the image used with classification. More...
float confidence
 Classification confidence. More...

Detailed Description

A single classification result.

Framework: libKfxEngines
Import suggestion: #import <kfxLibEngines/kfxEngines.h>
An instance of this class contains one possible image classification for the image analyzed by the classier. The result includes the ID of the classification, the orientation of the original image for reference, and the confidence level for this item.


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:

Keyed Archiving*

Keyed Unarchiving*

Method Documentation

◆ decodeClassifierOrientation:()

+ (NSString*) decodeClassifierOrientation: (KEDClassifierOrientation orientation

Decode the orientation into a string equivalent.

Use this class method to convert the actual orientation setting into a printable string equivalent.

orientationis an enum KEDClassifierOrientation setting that you want to evauluate.
A string representing the setting supplied.

Property Documentation

◆ classID

- (NSString*) classID

Image classification ID.

This defines the ID that the classifier thinks is associated with this image. Default: nil

◆ confidence

- (float) confidence

Classification confidence.

This value indicates how confident the classifer is to identify the specified classID for the input image. This value can be either negative, 0 or a positive value. Higher positive values indicate higher confidence, whereas lower negative values indicate lower confidence. There are no imposed range limits, but typically the score is between +/- 2.0.

Default: -5000

◆ orientation

- (KEDClassifierOrientation) orientation

Orientation of the image used with classification.

This defines reference orientation of the image as detected by the image classifier, for reference purposes. Set to one of the KEDClassifierOrientation enum setting. Default: KED_CLASSIFY_UNKNOWN

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