Class: OCI::AiVision::Models::Landmark

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_vision/models/landmark.rb

Overview

The landmark on the face.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_LEFT_EYE = 'LEFT_EYE'.freeze,
  TYPE_RIGHT_EYE = 'RIGHT_EYE'.freeze,
  TYPE_NOSE_TIP = 'NOSE_TIP'.freeze,
  TYPE_LEFT_EDGE_OF_MOUTH = 'LEFT_EDGE_OF_MOUTH'.freeze,
  TYPE_RIGHT_EDGE_OF_MOUTH = 'RIGHT_EDGE_OF_MOUTH'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Landmark

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :x (Float) —

    The value to assign to the #x property

  • :y (Float) —

    The value to assign to the #y property



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 64

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 }

  self.type = attributes[:'type'] if attributes[:'type']

  self.x = attributes[:'x'] if attributes[:'x']

  self.y = attributes[:'y'] if attributes[:'y']
end

Instance Attribute Details

#type ⇒ String

[Required] The face landmark type

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 23

def type
  @type
end

#x ⇒ Float

[Required] The X-axis normalized coordinate.

Returns:

  • (Float) 


27
28
29
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 27

def x
  @x
end

#y ⇒ Float

[Required] The Y-axis normalized coordinate.

Returns:

  • (Float) 


31
32
33
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 31

def y
  @y
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'x': :'x',
    'y': :'y'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'x': :'Float',
    'y': :'Float'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



97
98
99
100
101
102
103
104
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 97

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    x == other.x &&
    y == other.y
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 129

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


109
110
111
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 118

def hash
  [type, x, y].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 162

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



156
157
158
 
# File 'lib/oci/ai_vision/models/landmark.rb', line 156

def to_s
  to_hash.to_s
end