Class: CloudmersiveOcrApiClient::PreprocessingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PreprocessingApi

Returns a new instance of PreprocessingApi.



19
20
21
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#preprocessing_binarize(image_file, opts = {}) ⇒ String

Convert an image of text into a binarized (light and dark) view Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 27

def preprocessing_binarize(image_file, opts = {})
  data, _status_code, _headers = preprocessing_binarize_with_http_info(image_file, opts)
  data
end

#preprocessing_binarize_advanced(image_file, opts = {}) ⇒ String

Convert an image of text into a binary (light and dark) view with ML Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations. Provides enhanced accuracy than adaptive binarization. Image will be upsampled to 300 DPI if it has a DPI below 300.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


82
83
84
85
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 82

def preprocessing_binarize_advanced(image_file, opts = {})
  data, _status_code, _headers = preprocessing_binarize_advanced_with_http_info(image_file, opts)
  data
end

#preprocessing_binarize_advanced_with_http_info(image_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Convert an image of text into a binary (light and dark) view with ML Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations. Provides enhanced accuracy than adaptive binarization. Image will be upsampled to 300 DPI if it has a DPI below 300.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 92

def preprocessing_binarize_advanced_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreprocessingApi.preprocessing_binarize_advanced ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_binarize_advanced"
  end
  # resource path
  local_var_path = '/ocr/preprocessing/image/binarize/advanced'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_binarize_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#preprocessing_binarize_with_http_info(image_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Convert an image of text into a binarized (light and dark) view Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 37

def preprocessing_binarize_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreprocessingApi.preprocessing_binarize ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_binarize"
  end
  # resource path
  local_var_path = '/ocr/preprocessing/image/binarize'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_binarize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#preprocessing_get_page_angle(image_file, opts = {}) ⇒ GetPageAngleResult

Get the angle of the page / document / receipt Analyzes a photo or image of a document and identifies the rotation angle of the page.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



137
138
139
140
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 137

def preprocessing_get_page_angle(image_file, opts = {})
  data, _status_code, _headers = preprocessing_get_page_angle_with_http_info(image_file, opts)
  data
end

#preprocessing_get_page_angle_with_http_info(image_file, opts = {}) ⇒ Array<(GetPageAngleResult, Fixnum, Hash)>

Get the angle of the page / document / receipt Analyzes a photo or image of a document and identifies the rotation angle of the page.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetPageAngleResult, Fixnum, Hash)>) —

    GetPageAngleResult data, response status code and response headers



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 147

def preprocessing_get_page_angle_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreprocessingApi.preprocessing_get_page_angle ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_get_page_angle"
  end
  # resource path
  local_var_path = '/ocr/preprocessing/image/get-page-angle'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetPageAngleResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_get_page_angle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#preprocessing_unrotate(image_file, opts = {}) ⇒ String

Detect and unrotate a document image Detect and unrotate an image of a document (e.g. that was scanned at an angle). Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


192
193
194
195
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 192

def preprocessing_unrotate(image_file, opts = {})
  data, _status_code, _headers = preprocessing_unrotate_with_http_info(image_file, opts)
  data
end

#preprocessing_unrotate_advanced(image_file, opts = {}) ⇒ String

Detect and unrotate a document image (advanced) Detect and unrotate an image of a document (e.g. that was scanned at an angle) using deep learning. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


247
248
249
250
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 247

def preprocessing_unrotate_advanced(image_file, opts = {})
  data, _status_code, _headers = preprocessing_unrotate_advanced_with_http_info(image_file, opts)
  data
end

#preprocessing_unrotate_advanced_with_http_info(image_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Detect and unrotate a document image (advanced) Detect and unrotate an image of a document (e.g. that was scanned at an angle) using deep learning. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 257

def preprocessing_unrotate_advanced_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreprocessingApi.preprocessing_unrotate_advanced ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_unrotate_advanced"
  end
  # resource path
  local_var_path = '/ocr/preprocessing/image/unrotate/advanced'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unrotate_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#preprocessing_unrotate_with_http_info(image_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Detect and unrotate a document image Detect and unrotate an image of a document (e.g. that was scanned at an angle). Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 202

def preprocessing_unrotate_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreprocessingApi.preprocessing_unrotate ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_unrotate"
  end
  # resource path
  local_var_path = '/ocr/preprocessing/image/unrotate'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unrotate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#preprocessing_unskew(image_file, opts = {}) ⇒ String

Detect and unskew a photo of a document Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


302
303
304
305
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 302

def preprocessing_unskew(image_file, opts = {})
  data, _status_code, _headers = preprocessing_unskew_with_http_info(image_file, opts)
  data
end

#preprocessing_unskew_with_http_info(image_file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Detect and unskew a photo of a document Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.

Parameters:

  • image_file —

    Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb', line 312

def preprocessing_unskew_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PreprocessingApi.preprocessing_unskew ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_unskew"
  end
  # resource path
  local_var_path = '/ocr/preprocessing/image/unskew'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_unskew\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end