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 - 2016 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 
68 @interface kfxKEDBasicSettingsProfile : NSObject <NSCoding>
69 
70 // ==========================================================
72 
76 @property (assign, nonatomic) KEDRotationOptions doRotate;
77 
78 // ==========================================================
80 
87 @property (assign, nonatomic) KEDCroppingOptions doCrop;
88 
89 // ==========================================================
91 
95 @property (assign, nonatomic) bool doDeskew;
96 
97 // ==========================================================
99 
103 @property (assign, nonatomic) float inputDocShortEdge;
104 
105 // ==========================================================
107 
111 @property (assign, nonatomic) float inputDocLongEdge;
112 
113 // ==========================================================
115 
119 @property (strong, nonatomic) kfxKEDBoundingTetragon *croppingTetragon;
120 
121 // ==========================================================
123 
127 @property (assign, nonatomic) int outputDPI;
128 
129 // ==========================================================
131 
134 @property (assign, nonatomic) KEDOutputColor outputBitDepth;
135 
136 // ==========================================================
138 
143 - (int)specifyOutputBitDepth:(KEDOutputColor)outputBitDepth;
144 
145 // ==========================================================
147 
152 - (int)specifyOutputDPI:(int)dpi;
153 
154 // ==========================================================
156 
173 - (instancetype)init;
174 
175 // ==========================================================
177 
194 - (instancetype)initForStandardBitonalWithDPI:(int)dpi;
195 
196 // ==========================================================
198 
215 - (instancetype)initForStandardGrayscaleWithDPI:(int)dpi;
216 
217 // ==========================================================
219 
236 - (instancetype)initForStandardColorWithDPI:(int)dpi;
237 
238 // ==========================================================
240 
245 + (NSString *)decodeCroppingOption:(KEDCroppingOptions)option;
246 
247 // ==========================================================
249 
254 + (NSString *)decodeBitDepth:(KEDOutputColor)option;
255 
256 // ==========================================================
258 
263 + (NSString *)decodeRotateOpt:(KEDRotationOptions)option;
264 
265 @end
266 #endif
267 
float inputDocLongEdge
Length of the longest edge of the original.
Definition: kfxKEDBasicSettingsProfile.h:111
Definition: kfxKEDBasicSettingsProfile.h:21
bool doDeskew
Deskew an output image.
Definition: kfxKEDBasicSettingsProfile.h:95
Definition: kfxKEDBasicSettingsProfile.h:43
KEDOutputColor
Definition: kfxKEDBasicSettingsProfile.h:24
Definition: kfxKEDBasicSettingsProfile.h:39
int outputDPI
Desired Output image DPI.
Definition: kfxKEDBasicSettingsProfile.h:127
Definition: kfxKEDBasicSettingsProfile.h:25
Definition: kfxKEDBasicSettingsProfile.h:19
KEDOutputColor outputBitDepth
Desired Output Bitdepth.
Definition: kfxKEDBasicSettingsProfile.h:134
KEDCroppingOptions
Cropping Options enumeration.
Definition: kfxKEDBasicSettingsProfile.h:38
Definition: kfxKEDBasicSettingsProfile.h:42
Bounding Tetragon class holds four point data.
Definition: kfxKEDBoundingTetragon.h:38
KEDCroppingOptions doCrop
Crop image to a user specified option.
Definition: kfxKEDBasicSettingsProfile.h:87
Definition: kfxKEDBasicSettingsProfile.h:18
kfxKEDBoundingTetragon * croppingTetragon
Tetragon corner points defining the image cropping limits.
Definition: kfxKEDBasicSettingsProfile.h:119
Definition: kfxKEDBasicSettingsProfile.h:27
KEDRotationOptions
Definition: kfxKEDBasicSettingsProfile.h:16
KEDRotationOptions doRotate
Rotate automatically or by 90 degree options.
Definition: kfxKEDBasicSettingsProfile.h:76
float inputDocShortEdge
Length of the shortest edge of the original.
Definition: kfxKEDBasicSettingsProfile.h:103
Definition: kfxKEDBasicSettingsProfile.h:26
instancetype init()
Init defaults for a basic settings profile.
Definition: kfxKEDBasicSettingsProfile.h:41
Basic Settings Profile Specifies Image Processing options.
Definition: kfxKEDBasicSettingsProfile.h:68
Definition: kfxKEDBasicSettingsProfile.h:40
Definition: kfxKEDBasicSettingsProfile.h:17
Definition: kfxKEDBasicSettingsProfile.h:20
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.