Atalasoft MobileImage API Reference
kfxKEDBasicSettingsProfile.h
Go to the documentation of this file.
1 // API Reference
2 //
3 // kfxKEDBasicSettingsProfile.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 <Foundation/Foundation.h>
10 #ifndef KEDBASICSETTNGSPROFILE
11 #define KEDBASICSETTNGSPROFILE
12 
14 
15 
16 typedef enum {
23 
24 typedef enum {
29 
31 
38 typedef enum {
45 
47 
69 __deprecated_msg("This class was deprecated in SDK 3.3. Please use KFXImageProcessorConfiguration instead.")
70 @interface kfxKEDBasicSettingsProfile : NSObject <NSCoding>
71 
72 // ==========================================================
74 
78 @property (assign, nonatomic) KEDRotationOptions doRotate;
79 
80 // ==========================================================
82 
89 @property (assign, nonatomic) KEDCroppingOptions doCrop;
90 
91 // ==========================================================
93 
97 @property (assign, nonatomic) bool doDeskew;
98 
99 // ==========================================================
101 
105 @property (assign, nonatomic) float inputDocShortEdge;
106 
107 // ==========================================================
109 
113 @property (assign, nonatomic) float inputDocLongEdge;
114 
115 // ==========================================================
117 
121 @property (strong, nonatomic) kfxKEDBoundingTetragon *croppingTetragon;
122 
123 // ==========================================================
125 
129 @property (assign, nonatomic) int outputDPI;
130 
131 // ==========================================================
133 
136 @property (assign, nonatomic) KEDOutputColor outputBitDepth;
137 
138 // ==========================================================
140 
145 - (int)specifyOutputBitDepth:(KEDOutputColor)outputBitDepth;
146 
147 // ==========================================================
149 
154 - (int)specifyOutputDPI:(int)dpi;
155 
156 // ==========================================================
158 
175 - (instancetype)init;
176 
177 // ==========================================================
179 
196 - (instancetype)initForStandardBitonalWithDPI:(int)dpi;
197 
198 // ==========================================================
200 
217 - (instancetype)initForStandardGrayscaleWithDPI:(int)dpi;
218 
219 // ==========================================================
221 
238 - (instancetype)initForStandardColorWithDPI:(int)dpi;
239 
240 // ==========================================================
242 
248 
249 // ==========================================================
251 
256 + (NSString *)decodeBitDepth:(KEDOutputColor)option;
257 
258 // ==========================================================
260 
265 + (NSString *)decodeRotateOpt:(KEDRotationOptions)option;
266 
267 @end
268 #endif
269 
int specifyOutputBitDepth
Desired Output Bitdepth.
Definition: kfxKEDBasicSettingsProfile.h:145
Definition: kfxKEDBasicSettingsProfile.h:21
NSString * decodeRotateOpt
Generate a string from rotations option given.
Definition: kfxKEDBasicSettingsProfile.h:265
Definition: kfxKEDBasicSettingsProfile.h:43
kfxKEDBoundingTetragon * croppingTetragon
Tetragon corner points defining the image cropping limits.
Definition: kfxKEDBasicSettingsProfile.h:121
instancetype initForStandardBitonalWithDPI
Init defaults for a bitonal image.
Definition: kfxKEDBasicSettingsProfile.h:196
bool doDeskew
Deskew an output image.
Definition: kfxKEDBasicSettingsProfile.h:97
KEDOutputColor
Definition: kfxKEDBasicSettingsProfile.h:24
Definition: kfxKEDBasicSettingsProfile.h:39
float inputDocLongEdge
Length of the longest edge of the original.
Definition: kfxKEDBasicSettingsProfile.h:113
Definition: kfxKEDBasicSettingsProfile.h:25
Definition: kfxKEDBasicSettingsProfile.h:19
KEDOutputColor outputBitDepth
Desired Output Bitdepth.
Definition: kfxKEDBasicSettingsProfile.h:136
int specifyOutputDPI
Desired Output DPI.
Definition: kfxKEDBasicSettingsProfile.h:154
__deprecated_msg("This class was deprecated in SDK 3.3. Please use KFXImageProcessorConfiguration instead.") @interface kfxKEDBasicSettingsProfile KEDCroppingOptions doCrop
Basic Settings Profile Specifies Image Processing options.
Definition: kfxKEDBasicSettingsProfile.h:69
KEDCroppingOptions
Cropping Options enumeration.
Definition: kfxKEDBasicSettingsProfile.h:38
Definition: kfxKEDBasicSettingsProfile.h:42
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
Definition: kfxKEDBasicSettingsProfile.h:18
int outputDPI
Desired Output image DPI.
Definition: kfxKEDBasicSettingsProfile.h:129
Definition: kfxKEDBasicSettingsProfile.h:27
KEDRotationOptions
Definition: kfxKEDBasicSettingsProfile.h:16
Definition: kfxKEDBasicSettingsProfile.h:26
Definition: kfxKEDBasicSettingsProfile.h:41
float inputDocShortEdge
Length of the shortest edge of the original.
Definition: kfxKEDBasicSettingsProfile.h:105
Definition: kfxKEDBasicSettingsProfile.h:40
instancetype initForStandardColorWithDPI
Init defaults for a color image.
Definition: kfxKEDBasicSettingsProfile.h:238
Definition: kfxKEDBasicSettingsProfile.h:17
instancetype initForStandardGrayscaleWithDPI
Init defaults for a grayscale image.
Definition: kfxKEDBasicSettingsProfile.h:217
instancetype init
Init defaults for a basic settings profile.
Definition: kfxKEDBasicSettingsProfile.h:175
NSString * decodeCroppingOption
Generate a string from cropping option given.
Definition: kfxKEDBasicSettingsProfile.h:247
Definition: kfxKEDBasicSettingsProfile.h:20
NSString * decodeBitDepth
Generate a string from the bitDepth option given.
Definition: kfxKEDBasicSettingsProfile.h:256
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.