Class: CloudmersiveOcrApiClient::OcrWordElement

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

Overview

A single word in an OCR document

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OcrWordElement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
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
132
133
134
135
136
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 87

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'WordText')
    self.word_text = attributes[:'WordText']
  end

  if attributes.has_key?(:'LineNumber')
    self.line_number = attributes[:'LineNumber']
  end

  if attributes.has_key?(:'WordNumber')
    self.word_number = attributes[:'WordNumber']
  end

  if attributes.has_key?(:'XLeft')
    self.x_left = attributes[:'XLeft']
  end

  if attributes.has_key?(:'YTop')
    self.y_top = attributes[:'YTop']
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.has_key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.has_key?(:'ConfidenceLevel')
    self.confidence_level = attributes[:'ConfidenceLevel']
  end

  if attributes.has_key?(:'BlockNumber')
    self.block_number = attributes[:'BlockNumber']
  end

  if attributes.has_key?(:'ParagraphNumber')
    self.paragraph_number = attributes[:'ParagraphNumber']
  end

  if attributes.has_key?(:'PageNumber')
    self.page_number = attributes[:'PageNumber']
  end
end

Instance Attribute Details

#block_number ⇒ Object

Index of the containing block



43
44
45
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 43

def block_number
  @block_number
end

#confidence_level ⇒ Object

Confidence level of the machine learning result; possible values are 0.0 (lowest accuracy) - 1.0 (highest accuracy)



40
41
42
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 40

def confidence_level
  @confidence_level
end

#height ⇒ Object

Height of the word in pixels



37
38
39
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 37

def height
  @height
end

#line_number ⇒ Object

Line number of the word



22
23
24
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 22

def line_number
  @line_number
end

#page_number ⇒ Object

Index of the containing page



49
50
51
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 49

def page_number
  @page_number
end

#paragraph_number ⇒ Object

Index of the containing paragraph



46
47
48
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 46

def paragraph_number
  @paragraph_number
end

#width ⇒ Object

Width of the word in pixels



34
35
36
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 34

def width
  @width
end

#word_number ⇒ Object

Index of the word in the line



25
26
27
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 25

def word_number
  @word_number
end

#word_text ⇒ Object

Text of the word



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

def word_text
  @word_text
end

#x_left ⇒ Object

X location of the left edge of the word in pixels



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

def x_left
  @x_left
end

#y_top ⇒ Object

Y location of the top edge of the word in pixels



31
32
33
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 31

def y_top
  @y_top
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 52

def self.attribute_map
  {
    :'word_text' => :'WordText',
    :'line_number' => :'LineNumber',
    :'word_number' => :'WordNumber',
    :'x_left' => :'XLeft',
    :'y_top' => :'YTop',
    :'width' => :'Width',
    :'height' => :'Height',
    :'confidence_level' => :'ConfidenceLevel',
    :'block_number' => :'BlockNumber',
    :'paragraph_number' => :'ParagraphNumber',
    :'page_number' => :'PageNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 69

def self.swagger_types
  {
    :'word_text' => :'String',
    :'line_number' => :'Integer',
    :'word_number' => :'Integer',
    :'x_left' => :'Integer',
    :'y_top' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'confidence_level' => :'Float',
    :'block_number' => :'Integer',
    :'paragraph_number' => :'Integer',
    :'page_number' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      word_text == o.word_text &&
      line_number == o.line_number &&
      word_number == o.word_number &&
      x_left == o.x_left &&
      y_top == o.y_top &&
      width == o.width &&
      height == o.height &&
      confidence_level == o.confidence_level &&
      block_number == o.block_number &&
      paragraph_number == o.paragraph_number &&
      page_number == o.page_number
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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/models/ocr_word_element.rb', line 205

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CloudmersiveOcrApiClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 271

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 184

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


171
172
173
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 177

def hash
  [word_text, line_number, word_number, x_left, y_top, width, height, confidence_level, block_number, paragraph_number, page_number].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



140
141
142
143
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 251

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 257

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



245
246
247
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 245

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
 
# File 'lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb', line 147

def valid?
  true
end