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 - 2017 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 
18 #import "kfxKEDImage.h"
19 #import "kfxKIPDelegate.h"
20 
21 
23 
33 @interface kfxKENImageProcessor : NSObject
34 
35 
37 
40 @property (atomic, weak) id<kfxKIPDelegate> delegate;
41 
42 
44 
51 
52 
53 // ====================================================
55 
62 @property (atomic, retain) kfxKEDImagePerfectionProfile * imagePerfectionProfile DEPRECATED_ATTRIBUTE;
63 
64 
65 #ifdef INCLUDE_GRAYSCALE_ENHANCEMENT
66 // ==========================================================
68 
72 @property (nonatomic, assign) bool preProcessAsGrayscale;
73 #endif
74 
75 // ==========================================================
77 
97 
98 // ==========================================================
100 
111 @property (assign, atomic) KEDImageMimeType processedImageMimetype;
112 
113 // ==========================================================
115 
122 - (int) specifyProcessedImageFilePath: (NSString*) fullFilePath;
123 
124 // ==========================================================
126 
129 - (NSString *) getProcesedImageFilePath;
130 
131 
132 // ==========================================================
134 
139 @property (assign, atomic) int processedImageJpegQuality;
140 
141 
142 // ====================================================
144 
152 @property (atomic, retain) kfxKEDBasicSettingsProfile * basicSettingsProfile DEPRECATED_ATTRIBUTE;
153 
154 
155 // ====================================================
157 
192 -(int) processImage: (kfxKEDImage *) imageToProcess DEPRECATED_ATTRIBUTE;
193 
194 
195 // ====================================================
197 
221 -(int) processImage: (kfxKEDImage *) imageToProcess withConfiguration: (KFXImageProcessorConfiguration *) configuration;
222 
223 
224 // ====================================================
226 
256 -(int) doQuickAnalysis: (kfxKEDImage *) imageToAnalyze andGenerateImage: (bool) generateRefImage;
257 -(int) doQuickAnalysis: (kfxKEDImage *) imageToAnalyze andGenerateImage: (bool) generateRefImage withSettings: (kfxKEDQuickAnalysisSettings*) settings;
258 
259 
260 // ====================================================
262 
272 -(void) cancelProcessing;
273 
274 // ====================================================
276 
281 - (void) SessionCreate;
282 
283 // ====================================================
285 
289 - (void) SessionDismiss;
290 
291 
292 @end
293 
294 #endif
295 
kfxKEDImagePerfectionProfile *imagePerfectionProfile DEPRECATED_ATTRIBUTE
Image Perfection Profile specifies advanced Image Processing options.
Definition: kfxKIPImageProcessor.h:62
KEDImageMimeType processedImageMimetype
Set the the file storage mimetype configuration.
Definition: kfxKIPImageProcessor.h:111
kfxKENImageProcessor * instance()
The Image Processor Engine factory method.
void SessionDismiss()
End an AppStats session.
Definition: kfxKEDQuickAnalysisSettings.h:14
void SessionCreate()
Begin an AppStats session.
id< kfxKIPDelegate > delegate
kfxKIPDelegate that notifies you about progress and completion of image processing operations ...
Definition: kfxKIPImageProcessor.h:40
NSString * getProcesedImageFilePath()
Get the current processed image file path.
enum kedImageRep KEDImageRepresentation
Image Representation enumeration.
Image Processor Configuration Specifies Image Processing Options.
Definition: KFXImageProcessorConfiguration.h:73
int processedImageJpegQuality
Set the processed Image jpeg Quality.
Definition: kfxKIPImageProcessor.h:139
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:158
enum kedImageMimetype KEDImageMimeType
Image Mimetype enumeration.
The Image Processor Class.
Definition: kfxKIPImageProcessor.h:33
void cancelProcessing()
Use the cancel processing method to stop image processing.
KEDImageRepresentation processedImageRepresentation
Set the desired output image representation format.
Definition: kfxKIPImageProcessor.h:96
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.