Atalasoft MobileImage API Reference
kfxKEDImage.h
Go to the documentation of this file.
1 // Kofax Mobile Capture API Reference File
2 //
3 // kfxKEDImage.h
4 // KMCEngineData Objects
5 //
6 // Copyright (c) 2012 - 2016 Kofax. Use of this code is with permission pursuant to Kofax license terms.
7 //
8 
9 #import <UIKit/UIKit.h>
10 
11 #ifndef KFXKEDIMAGE
12 #define KFXKEDIMAGE 1
13 
17 #import "kfxKUTErrorInfo.h"
18 
19 
21 
24 typedef enum kedImageRep {
31 
33 
36 typedef enum kedImageMimetype{
43 
45 
52 typedef enum kedFileImageRep {
58 
60 
67 typedef enum
68 {
71 
73 
74 
75 #define KMC_MIN_DPI 25
76 #define DEFAULT_ORIENTATION 0 // Right
77 
79 
158 @interface kfxKEDImage : NSObject <NSCoding>
159 
160 
161 // ==========================================================
162 // R E A D _ O N L Y P R O P E R T I E S
163 // ==========================================================
164 
165 // ==========================================================
167 
172 @property (readonly,atomic) NSString *imageID; //archived
173 
174 #ifdef USE_MANAGER
175 // ==========================================================
177 
182 @property (readonly,atomic) NSString *friendID;
183 #endif
184 
185 
186 // ==========================================================
188 
193 @property (readonly,atomic) NSString *imageSourceID; // archived
194 
195 
196 // ==========================================================
198 
210 @property (atomic, readonly) NSString *imageMetaData; // archived
211 
212 // ==========================================================
214 
219 @property (nonatomic, strong) NSString *imageMicrData; // archived
220 
221 
222 // ==========================================================
224 
241 @property (atomic, readonly) float imageGPSLat; // latitude archived
242 
243 // ==========================================================
245 
262 @property (atomic, readonly) float imageGPSLon; // longitude archived
263 
264 
265 // ==========================================================
267 
276 
277 
278 // ==========================================================
280 
292 
293 
294 // ==========================================================
296 
315 @property (atomic, readonly) KEDImageRepresentation imageRepresentation; // archived
316 
317 
318 // ==========================================================
320 
327 @property (atomic, readonly) KEDFileRepresentation fileRepresentation; //archived
328 
329 
330 // ==========================================================
332 
339 @property (atomic, readonly) int imageFileBufferSize; // archived
340 
341 
342 // ==========================================================
344 
349 @property (atomic, readonly) kfxKEDQuickAnalysisFeedback *imageQuickAnalysisFeedback; // archived
350 
351 
352 // ==========================================================
354 
361 @property (atomic) int imageHeight; // archived
362 
363 
364 // ==========================================================
366 
373 @property (atomic) int imageWidth; // archived
374 
375 
376 // ==========================================================
378 
385 @property (readonly) float attitudePitch; // archived
386 
387 
388 // ==========================================================
390 
397 @property (readonly) float attitudeRoll; // archived
398 
399 
400 // ==========================================================
401 // W R I T E - R E A D P R O P E R T I E S
402 // ==========================================================
403 
404 
405 // ==========================================================
407 
412 @property (retain,atomic) NSString *imageTag; // archived
413 
414 
415 // ==========================================================
417 
423 @property (assign, atomic) int imageDPI; // archived
424 
425 
426 // ==========================================================
428 
434 @property (assign, atomic) int jpegQuality; // archived
435 
436 
437 // ==========================================================
439 
446 @property (assign, atomic) KEDOutputColor imageFileOutputColor; // archived
447 
448 
449 // ==========================================================
451 
457 @property (strong,atomic) NSString *imageCreateDateTime; // archived
458 
459 
460 // ==========================================================
462 
469 @property (assign, atomic) KEDImageMimeType imageMimeType; // archived
470 
471 
472 // ==========================================================
474 
479 @property bool isPositionValid; // archived
480 
481 
482 // ==========================================================
484 
489 @property (nonatomic, retain) NSMutableArray* imageBarCodes; // array of BarCodeResults
490 
491 
492 // ==========================================================
494 
500 @property (nonatomic, retain) NSMutableArray* classificationResults; // array of Classification Results
501 
502 // ==========================================================
504 
509 @property bool isAttitudeValid; // archived
510 
511 
512 
513 // ==========================================================
514 // M E T H O D S
515 // ==========================================================
516 
517 // ==========================================================
519 
593 - (int) imageWriteToFile;
594 
595 
596 // ==========================================================
598 
637 - (int) imageWriteToFile: (FILE_RESTRICTION) restriction;
638 
639 
640 
641 // =========================================================================
643 
707 - (int) imageWriteToFileBuffer;
708 
709 
710 // =========================================================================
712 
741 - (int) imageWriteToFileBuffer : (FILE_RESTRICTION) restriction;
742 
743 
744 // ==========================================================
746 
755 - (long) getImageSize;
756 
757 // ==========================================================
759 
782 - (int) imageReadFromFile;
783 
784 
785 // ==========================================================================
787 
798 
799 
800 // ==========================================================
802 
815 - (int) deleteFile;
816 
817 
818 // ==========================================================
820 
837 - (int) specifyImageBitmap: (UIImage*) image;
838 
839 
840 // ==========================================================
842 
846 - (UIImage*) getImageBitmap;
847 
848 
849 // ==========================================================
851 
857 - (int) clearImageBitmap;
858 
859 
860 // ==========================================================
862 
869  - (int) clearFileBuffer;
870 
871 
872 // ==========================================================
874 
925 - (const char *) getImageFileBuffer;
926 
927 
928 // ==========================================================
930 
934 - (bool) isValidDateTime;
935 
936 
937 // ==========================================================
939 
945 - (int) specifyImageCreateDateAndtime: (NSString*) dateString;
946 
947 
948 // ==========================================================
950 
958 - (int) specifyFilePath: (NSString*) fullFilePath;
959 
960 
961 // ==========================================================
963 
966 - (NSString *) getFilePath;
967 
968 
969 // ==========================================================
971 
974 - (NSString*) getImageSourceID;
975 
976 
977 // ==========================================================
979 
983 - (NSString*) getImageID;
984 #ifdef USE_MANAGER
985 - (NSString*) getFriendID;
986 #endif
987 
988 
989 // ==========================================================
991 
1000 - (NSString*) getImageMetaData;
1001 
1002 
1003 // ==========================================================
1005 
1009 - (float) getImageGPSLat;
1010 
1011 
1012 // ==========================================================
1014 
1018 - (float) getImageGPSLon;
1019 
1020 
1021 // ==========================================================
1023 
1026 - (float) getAttitudePitch;
1027 
1028 
1029 // ==========================================================
1031 
1034 - (float) getAttitudeRoll;
1035 
1036 
1037 // ==========================================================
1039 
1043 
1044 
1045 // ==========================================================
1047 
1051 
1052 
1053 // ==========================================================
1055 
1059 
1060 
1061 // ==========================================================
1063 
1066 +(NSString*)simpleDateTimeString:(NSDate*)date;
1067 
1068 // ==========================================================
1070 
1073 +(NSDate*)dateFromSimpleDateString:(NSString*)s;
1074 
1075 // ==========================================================
1077 
1082 +(NSString*) ISO8601DateTime;
1083 
1084 
1085 // ==========================================================
1087 
1092 +(NSString *) decodeImageRep: (KEDImageRepresentation) option;
1093 
1094 
1095 // ==========================================================
1097 
1103 +(NSString *) decodeMimetype: (KEDImageMimeType) option;
1104 
1105 
1106 // ==========================================================
1108 
1113 +(NSString *) decodeFileColor: (KEDOutputColor) color;
1114 
1115 
1116 // ==========================================================
1118 
1126 - (id)init;
1127 
1128 
1129 // ==========================================================
1131 
1142 - (id)initWithImage:(UIImage*)image;
1143 
1144 @end
1145 #endif
1146 
Definition: kfxKEDImage.h:29
int clearFileBuffer()
Clear the buffered file image.
bool isAttitudeValid
Boolean to indicate if the attitude is valid.
Definition: kfxKEDImage.h:509
kfxKEDImagePerfectionProfile * getImagePerfectionProfileUsed()
Get the image perfection profile used in the last image processing operation.
float imageGPSLon
Global longitude of the location where the original photo was taken.
Definition: kfxKEDImage.h:262
Definition: kfxKEDImage.h:25
NSString * getImageID()
Get the image ID of the image.
float attitudePitch
Image Attitude for the pitch when the image was taken.
Definition: kfxKEDImage.h:385
bool isPositionValid
Boolean to indicate if the GPS data is valid.
Definition: kfxKEDImage.h:479
id init()
Initialize an object allocated for use.
int imageReadFromFile()
Initialize the imageBitmap property with the image contained in a file.
Definition: kfxKEDImage.h:54
int imageDPI
Image Dots per Inch.
Definition: kfxKEDImage.h:423
enum kedFileImageRep KEDFileRepresentation
File storage method.
Definition: kfxKEDImage.h:55
NSString * imageCreateDateTime
Object creation date-time string.
Definition: kfxKEDImage.h:457
KEDImageMimeType imageMimeType
Indicates the file storage configuration.
Definition: kfxKEDImage.h:469
KEDOutputColor imageFileOutputColor
Image File Output Color.
Definition: kfxKEDImage.h:446
kfxKEDQuickAnalysisFeedback * imageQuickAnalysisFeedback
Image Quick Analysis feedback stores quick analysis results.
Definition: kfxKEDImage.h:349
int imageReadFromFileBuffer()
Read an image from the file buffer into the UIImage imageBitmap property.
KEDOutputColor
Definition: kfxKEDBasicSettingsProfile.h:24
kfxKEDBasicSettingsProfile * basicSettingsProfileUsed
Basic settings profile used for image processing.
Definition: kfxKEDImage.h:275
Definition: kfxKEDImage.h:28
Quick Analysis Results Feedback Class.
Definition: kfxKEDQuickAnalysisFeedback.h:39
NSString * getImageMetaData()
Get the image metadata string.
int clearImageBitmap()
Clear the bitmap image.
Image Perfection Profile specifies advanced Image Processing options.
Definition: kfxKEDImagePerfectionProfile.h:34
NSString * imageID
Uniquely identifies this image using a unique ID.
Definition: kfxKEDImage.h:172
kedImageMimetype
Image Mimetype enumeration.
Definition: kfxKEDImage.h:36
Definition: kfxKEDImage.h:27
float getAttitudeRoll()
Get the roll attitude of the camera when the picture was taken.
long getImageSize()
Get the current image size.
kfxKEDQuickAnalysisFeedback * getImageQuickAnalysisFeedback()
Get the quick analysis feedback object from the last quick analysis.
int imageWidth
Image Width in pixels for the image bitmap.
Definition: kfxKEDImage.h:373
float imageGPSLat
Global latitude of the location where the original photo was taken.
Definition: kfxKEDImage.h:241
bool isValidDateTime()
Check date time string validity.
NSString * getImageSourceID()
Get the image ID of the input source image.
NSString * imageTag
App defined tag name to associate with this image.
Definition: kfxKEDImage.h:412
NSString * ISO8601DateTime()
Generate a compliant date-time string for use in this object.
Definition: kfxKEDImage.h:70
float getImageGPSLon()
Get the GPS longitude associated with this image.
Definition: kfxKEDImage.h:40
kfxKEDBasicSettingsProfile * getBasicSettingsProfileUsed()
Get the basic settings profile used in the last image processing operation.
NSString * imageSourceID
Identifies the source image used to generate this image.
Definition: kfxKEDImage.h:193
enum kedImageRep KEDImageRepresentation
Image Representation enumeration.
NSMutableArray * classificationResults
Image classification results.
Definition: kfxKEDImage.h:500
KEDImageRepresentation imageRepresentation
Defines how the image is represented in this object.
Definition: kfxKEDImage.h:315
kedFileImageRep
File storage method.
Definition: kfxKEDImage.h:52
NSString * imageMicrData
MICR data extracted from the image metadata.
Definition: kfxKEDImage.h:219
float attitudeRoll
Image Attitude for the roll when the image was taken.
Definition: kfxKEDImage.h:397
KEDFileRepresentation fileRepresentation
Defines how the file is represented.
Definition: kfxKEDImage.h:327
Definition: kfxKEDImage.h:26
kedImageRep
Image Representation enumeration.
Definition: kfxKEDImage.h:24
UIImage * getImageBitmap()
Get the current bitmap image.
int jpegQuality
jpeg Quality setting
Definition: kfxKEDImage.h:434
FILE_RESTRICTION
File Format restriction.
Definition: kfxKEDImage.h:67
int deleteFile()
Delete the file specified in the file path contained in this object.
NSString * getFilePath()
Get the current file path.
float getImageGPSLat()
Get the GPS latitude associated with this image.
Definition: kfxKEDImage.h:38
kfxKEDImagePerfectionProfile * imagePerfectionProfileUsed
Image perfection profile used to specify detailed image processing options.
Definition: kfxKEDImage.h:291
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:158
Basic Settings Profile Specifies Image Processing options.
Definition: kfxKEDBasicSettingsProfile.h:68
enum kedImageMimetype KEDImageMimeType
Image Mimetype enumeration.
int imageWriteToFile()
Write the image contained in the UIImage to the file path specified in the object.
Definition: kfxKEDImage.h:53
Definition: kfxKEDImage.h:41
const char * getImageFileBuffer()
Get a reference to the image file buffer.
int imageFileBufferSize
Defines how large the file buffer is in bytes.
Definition: kfxKEDImage.h:339
Definition: kfxKEDImage.h:37
Definition: kfxKEDImage.h:56
Definition: kfxKEDImage.h:69
NSMutableArray * imageBarCodes
Array of image barcodes found by processing.
Definition: kfxKEDImage.h:489
Definition: kfxKEDImage.h:39
int imageHeight
Image Height in pixels for the image bitmap.
Definition: kfxKEDImage.h:361
int imageWriteToFileBuffer()
Write the UIImage object in this kfxKEDImage object to file buffer.
NSString * imageMetaData
Image metadata created by the image processing process.
Definition: kfxKEDImage.h:210
float getAttitudePitch()
Get the pitch attitude of the camera when the picture was taken.
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.