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 - 2017 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 
278 @property (atomic, readonly) kfxKEDBasicSettingsProfile *basicSettingsProfileUsed DEPRECATED_ATTRIBUTE;
279 
280 
281 // ==========================================================
283 
296 @property (atomic, readonly) kfxKEDImagePerfectionProfile *imagePerfectionProfileUsed DEPRECATED_ATTRIBUTE;
297 
298 
299 // ==========================================================
301 
320 @property (atomic, readonly) KEDImageRepresentation imageRepresentation; // archived
321 
322 
323 // ==========================================================
325 
332 @property (atomic, readonly) KEDFileRepresentation fileRepresentation; //archived
333 
334 
335 // ==========================================================
337 
344 @property (atomic, readonly) int imageFileBufferSize; // archived
345 
346 
347 // ==========================================================
349 
354 @property (atomic, readonly) kfxKEDQuickAnalysisFeedback *imageQuickAnalysisFeedback; // archived
355 
356 
357 // ==========================================================
359 
366 @property (atomic) int imageHeight; // archived
367 
368 
369 // ==========================================================
371 
378 @property (atomic) int imageWidth; // archived
379 
380 
381 // ==========================================================
383 
390 @property (readonly) float attitudePitch; // archived
391 
392 
393 // ==========================================================
395 
402 @property (readonly) float attitudeRoll; // archived
403 
404 
405 // ==========================================================
406 // W R I T E - R E A D P R O P E R T I E S
407 // ==========================================================
408 
409 
410 // ==========================================================
412 
417 @property (retain,atomic) NSString *imageTag; // archived
418 
419 
420 // ==========================================================
422 
428 @property (assign, atomic) int imageDPI; // archived
429 
430 
431 // ==========================================================
433 
439 @property (assign, atomic) int jpegQuality; // archived
440 
441 
442 // ==========================================================
444 
451 @property (assign, atomic) KEDOutputColor imageFileOutputColor; // archived
452 
453 
454 // ==========================================================
456 
462 @property (strong,atomic) NSString *imageCreateDateTime; // archived
463 
464 
465 // ==========================================================
467 
474 @property (assign, atomic) KEDImageMimeType imageMimeType; // archived
475 
476 
477 // ==========================================================
479 
484 @property bool isPositionValid; // archived
485 
486 
487 // ==========================================================
489 
494 @property (nonatomic, retain) NSMutableArray* imageBarCodes; // array of BarCodeResults
495 
496 
497 // ==========================================================
499 
505 @property (nonatomic, retain) NSMutableArray* classificationResults; // array of Classification Results
506 
507 // ==========================================================
509 
514 @property bool isAttitudeValid; // archived
515 
517 
523 @property (nonatomic, assign) CGRect targetFrame;
524 
525 // ==========================================================
526 // M E T H O D S
527 // ==========================================================
528 
529 // ==========================================================
531 
605 - (int) imageWriteToFile;
606 
607 
608 // ==========================================================
610 
649 - (int) imageWriteToFile: (FILE_RESTRICTION) restriction;
650 
651 
652 
653 // =========================================================================
655 
719 - (int) imageWriteToFileBuffer;
720 
721 
722 // =========================================================================
724 
753 - (int) imageWriteToFileBuffer : (FILE_RESTRICTION) restriction;
754 
755 
756 // ==========================================================
758 
767 - (long) getImageSize;
768 
769 // ==========================================================
771 
794 - (int) imageReadFromFile;
795 
796 
797 // ==========================================================================
799 
810 
811 
812 // ==========================================================
814 
827 - (int) deleteFile;
828 
829 
830 // ==========================================================
832 
849 - (int) specifyImageBitmap: (UIImage*) image;
850 
851 
852 // ==========================================================
854 
858 - (UIImage*) getImageBitmap;
859 
860 
861 // ==========================================================
863 
869 - (int) clearImageBitmap;
870 
871 
872 // ==========================================================
874 
881  - (int) clearFileBuffer;
882 
883 
884 // ==========================================================
886 
937 - (const char *) getImageFileBuffer;
938 
939 
940 // ==========================================================
942 
946 - (bool) isValidDateTime;
947 
948 
949 // ==========================================================
951 
957 - (int) specifyImageCreateDateAndtime: (NSString*) dateString;
958 
959 
960 // ==========================================================
962 
970 - (int) specifyFilePath: (NSString*) fullFilePath;
971 
972 
973 // ==========================================================
975 
978 - (NSString *) getFilePath;
979 
980 
981 // ==========================================================
983 
986 - (NSString*) getImageSourceID;
987 
988 
989 // ==========================================================
991 
995 - (NSString*) getImageID;
996 #ifdef USE_MANAGER
997 - (NSString*) getFriendID;
998 #endif
999 
1000 
1001 // ==========================================================
1003 
1012 - (NSString*) getImageMetaData;
1013 
1014 
1015 // ==========================================================
1017 
1021 - (float) getImageGPSLat;
1022 
1023 
1024 // ==========================================================
1026 
1030 - (float) getImageGPSLon;
1031 
1032 
1033 // ==========================================================
1035 
1038 - (float) getAttitudePitch;
1039 
1040 
1041 // ==========================================================
1043 
1046 - (float) getAttitudeRoll;
1047 
1048 
1049 // ==========================================================
1051 
1055 
1056 
1057 // ==========================================================
1059 
1064 - (kfxKEDBasicSettingsProfile *) getBasicSettingsProfileUsed DEPRECATED_ATTRIBUTE;
1065 
1066 
1067 // ==========================================================
1069 
1074 - (kfxKEDImagePerfectionProfile *) getImagePerfectionProfileUsed DEPRECATED_ATTRIBUTE;
1075 
1076 
1077 // ==========================================================
1079 
1082 +(NSString*)simpleDateTimeString:(NSDate*)date;
1083 
1084 // ==========================================================
1086 
1089 +(NSDate*)dateFromSimpleDateString:(NSString*)s;
1090 
1091 // ==========================================================
1093 
1098 +(NSString*) ISO8601DateTime;
1099 
1100 
1101 // ==========================================================
1103 
1108 +(NSString *) decodeImageRep: (KEDImageRepresentation) option;
1109 
1110 
1111 // ==========================================================
1113 
1119 +(NSString *) decodeMimetype: (KEDImageMimeType) option;
1120 
1121 
1122 // ==========================================================
1124 
1129 +(NSString *) decodeFileColor: (KEDOutputColor) color;
1130 
1131 
1132 // ==========================================================
1134 
1142 - (id)init;
1143 
1144 
1145 // ==========================================================
1147 
1158 - (id)initWithImage:(UIImage*)image;
1159 
1160 @end
1161 #endif
1162 
Definition: kfxKEDImage.h:29
int clearFileBuffer()
Clear the buffered file image.
bool isAttitudeValid
Boolean to indicate if the attitude is valid.
Definition: kfxKEDImage.h:514
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:390
bool isPositionValid
Boolean to indicate if the GPS data is valid.
Definition: kfxKEDImage.h:484
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:428
enum kedFileImageRep KEDFileRepresentation
File storage method.
Definition: kfxKEDImage.h:55
NSString * imageCreateDateTime
Object creation date-time string.
Definition: kfxKEDImage.h:462
KEDImageMimeType imageMimeType
Indicates the file storage configuration.
Definition: kfxKEDImage.h:474
KEDOutputColor imageFileOutputColor
Image File Output Color.
Definition: kfxKEDImage.h:451
kfxKEDBasicSettingsProfile * DEPRECATED_ATTRIBUTE()
Get the basic settings profile used in the last image processing operation.
kfxKEDQuickAnalysisFeedback * imageQuickAnalysisFeedback
Image Quick Analysis feedback stores quick analysis results.
Definition: kfxKEDImage.h:354
int imageReadFromFileBuffer()
Read an image from the file buffer into the UIImage imageBitmap property.
KEDOutputColor
Definition: kfxKEDBasicSettingsProfile.h:24
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.
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:378
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:417
CGRect targetFrame
Target frame used for taking a picture.
Definition: kfxKEDImage.h:523
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
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:505
KEDImageRepresentation imageRepresentation
Defines how the image is represented in this object.
Definition: kfxKEDImage.h:320
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:402
KEDFileRepresentation fileRepresentation
Defines how the file is represented.
Definition: kfxKEDImage.h:332
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:439
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
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:158
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:344
Definition: kfxKEDImage.h:37
Definition: kfxKEDImage.h:56
Definition: kfxKEDImage.h:69
NSMutableArray * imageBarCodes
Array of image barcodes found by processing.
Definition: kfxKEDImage.h:494
Definition: kfxKEDImage.h:39
int imageHeight
Image Height in pixels for the image bitmap.
Definition: kfxKEDImage.h:366
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 © 2017 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.