class CloudmersiveImageRecognitionApiClient::DetectedObject

Single object instance, and associated details, detected in an image

Attributes

height[RW]

Height, in pixels, of the object

object_class_name[RW]

Class of the object. Example values are "person", "car", "dining table", etc.

score[RW]

Confidence score of detected object; possible values are between 0.0 and 1.0; values closer to 1.0 are higher confidence

width[RW]

Width, in pixels, of the object

x[RW]

X location, in pixels, of the left side location of the object, with the right side being X + Width

y[RW]

Y location, in pixels, of the top side location of the object, with the bottom side being Y + Height

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 37
def self.attribute_map
  {
    :'object_class_name' => :'ObjectClassName',
    :'height' => :'Height',
    :'width' => :'Width',
    :'score' => :'Score',
    :'x' => :'X',
    :'y' => :'Y'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 62
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?(:'ObjectClassName')
    self.object_class_name = attributes[:'ObjectClassName']
  end

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

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

  if attributes.has_key?(:'Score')
    self.score = attributes[:'Score']
  end

  if attributes.has_key?(:'X')
    self.x = attributes[:'X']
  end

  if attributes.has_key?(:'Y')
    self.y = attributes[:'Y']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 49
def self.swagger_types
  {
    :'object_class_name' => :'String',
    :'height' => :'Integer',
    :'width' => :'Integer',
    :'score' => :'Float',
    :'x' => :'Integer',
    :'y' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 108
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object_class_name == o.object_class_name &&
      height == o.height &&
      width == o.width &&
      score == o.score &&
      x == o.x &&
      y == o.y
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 155
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 = CloudmersiveImageRecognitionApiClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 221
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 134
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 121
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 127
def hash
  [object_class_name, height, width, score, x, y].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 95
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 201
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 207
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 195
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cloudmersive-image-recognition-api-client/models/detected_object.rb, line 102
def valid?
  true
end