Atalasoft MobileImage API Reference
kfxKIPImageProcessor.h
Go to the documentation of this file.
1 // API Reference
2 //
3 // KMCEngines framework
4 //
5 // kfxKIPImageProcessor.h
6 //
7 // Copyright (c) 2012 - 2016 Kofax. Use of this code is with permission pursuant to Kofax license terms.
8 //
9 #import <Foundation/Foundation.h>
10 
11 #ifndef KMCKEDIMAGEPROCESSOR
12 #define KMCKEDIMAGEPROCESSOR 1
13 
17 #import "kfxKEDImage.h"
18 #import "kfxKIPDelegate.h"
19 
20 
22 
32 @interface kfxKENImageProcessor : NSObject
33 
34 
36 
39 @property (atomic, weak) id<kfxKIPDelegate> delegate;
40 
41 
43 
50 
51 
52 // ====================================================
54 
59 
60 
61 #ifdef INCLUDE_GRAYSCALE_ENHANCEMENT
62 // ==========================================================
64 
68 @property (nonatomic, assign) bool preProcessAsGrayscale;
69 #endif
70 
71 // ==========================================================
73 
93 
94 // ==========================================================
96 
107 @property (assign, atomic) KEDImageMimeType processedImageMimetype;
108 
109 // ==========================================================
111 
118 - (int) specifyProcessedImageFilePath: (NSString*) fullFilePath;
119 
120 // ==========================================================
122 
125 - (NSString *) getProcesedImageFilePath;
126 
127 
128 // ==========================================================
130 
135 @property (assign, atomic) int processedImageJpegQuality;
136 
137 
138 // ====================================================
140 
146 
147 
148 // ====================================================
150 
183 -(int) processImage: (kfxKEDImage *) imageToProcess;
184 
185 
186 // ====================================================
188 
218 -(int) doQuickAnalysis: (kfxKEDImage *) imageToAnalyze andGenerateImage: (bool) generateRefImage;
219 -(int) doQuickAnalysis: (kfxKEDImage *) imageToAnalyze andGenerateImage: (bool) generateRefImage withSettings: (kfxKEDQuickAnalysisSettings*) settings;
220 
221 
222 // ====================================================
224 
234 -(void) cancelProcessing;
235 
236 // ====================================================
238 
243 - (void) SessionCreate;
244 
245 // ====================================================
247 
251 - (void) SessionDismiss;
252 
253 
254 @end
255 
256 #endif
257 
KEDImageMimeType processedImageMimetype
Set the the file storage mimetype configuration.
Definition: kfxKIPImageProcessor.h:107
kfxKENImageProcessor * instance()
The Image Processor Engine factory method.
void SessionDismiss()
End an AppStats session.
Image Perfection Profile specifies advanced Image Processing options.
Definition: kfxKEDImagePerfectionProfile.h:34
Definition: kfxKEDQuickAnalysisSettings.h:12
void SessionCreate()
Begin an AppStats session.
id< kfxKIPDelegate > delegate
kfxKIPDelegate that notifies you about progress and completion of image processing operations ...
Definition: kfxKIPImageProcessor.h:39
NSString * getProcesedImageFilePath()
Get the current processed image file path.
enum kedImageRep KEDImageRepresentation
Image Representation enumeration.
int processedImageJpegQuality
Set the processed Image jpeg Quality.
Definition: kfxKIPImageProcessor.h:135
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.
The Image Processor Class.
Definition: kfxKIPImageProcessor.h:32
kfxKEDBasicSettingsProfile * basicSettingsProfile
Basic settings profile specifies Image Processing options.
Definition: kfxKIPImageProcessor.h:145
void cancelProcessing()
Use the cancel processing method to stop image processing.
kfxKEDImagePerfectionProfile * imagePerfectionProfile
Image Perfection Profile specifies advanced Image Processing options.
Definition: kfxKIPImageProcessor.h:58
KEDImageRepresentation processedImageRepresentation
Set the desired output image representation format.
Definition: kfxKIPImageProcessor.h:92
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.