Class: OCI::AiVision::Models::VideoFaceDetectionFeature

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

Overview

Video face detection feature

Constant Summary

Constants inherited from VideoFeature

OCI::AiVision::Models::VideoFeature::FEATURE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from VideoFeature

#feature_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from VideoFeature

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ VideoFaceDetectionFeature

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :max_results (Integer) —

    The value to assign to the #max_results property

  • :is_landmark_required (BOOLEAN) —

    The value to assign to the #is_landmark_required property

  • :min_confidence (Float) —

    The value to assign to the #min_confidence property



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 59

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

  attributes['featureType'] = 'FACE_DETECTION'

  super(attributes)

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

  self.max_results = attributes[:'maxResults'] if attributes[:'maxResults']

  raise 'You cannot provide both :maxResults and :max_results' if attributes.key?(:'maxResults') && attributes.key?(:'max_results')

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

  self.is_landmark_required = attributes[:'isLandmarkRequired'] unless attributes[:'isLandmarkRequired'].nil?
  self.is_landmark_required = false if is_landmark_required.nil? && !attributes.key?(:'isLandmarkRequired') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isLandmarkRequired and :is_landmark_required' if attributes.key?(:'isLandmarkRequired') && attributes.key?(:'is_landmark_required')

  self.is_landmark_required = attributes[:'is_landmark_required'] unless attributes[:'is_landmark_required'].nil?
  self.is_landmark_required = false if is_landmark_required.nil? && !attributes.key?(:'isLandmarkRequired') && !attributes.key?(:'is_landmark_required') # rubocop:disable Style/StringLiterals

  self.min_confidence = attributes[:'minConfidence'] if attributes[:'minConfidence']

  raise 'You cannot provide both :minConfidence and :min_confidence' if attributes.key?(:'minConfidence') && attributes.key?(:'min_confidence')

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

Instance Attribute Details

#is_landmark_required ⇒ BOOLEAN

Whether or not return face landmarks.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 18

def is_landmark_required
  @is_landmark_required
end

#max_results ⇒ Integer

The maximum number of results per frame to return.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 14

def max_results
  @max_results
end

#min_confidence ⇒ Float

The minimum confidence score, between 0 and 1, when the value is set, results with lower confidence will not be returned.

Returns:

  • (Float) 


24
25
26
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 24

def min_confidence
  @min_confidence
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'featureType',
    'max_results': :'maxResults',
    'is_landmark_required': :'isLandmarkRequired',
    'min_confidence': :'minConfidence'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'feature_type': :'String',
    'max_results': :'Integer',
    'is_landmark_required': :'BOOLEAN',
    'min_confidence': :'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
105
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 97

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

  self.class == other.class &&
    feature_type == other.feature_type &&
    max_results == other.max_results &&
    is_landmark_required == other.is_landmark_required &&
    min_confidence == other.min_confidence
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



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

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


110
111
112
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 110

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 119

def hash
  [feature_type, max_results, is_landmark_required, min_confidence].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



157
158
159
 
# File 'lib/oci/ai_vision/models/video_face_detection_feature.rb', line 157

def to_s
  to_hash.to_s
end