Class: Google::Cloud::Vision::Annotation::Face::Angles

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/vision/annotation/face.rb

Overview

# Angles

The orientation of the face relative to the image.

See Google::Cloud::Vision::Annotation::Face.

Examples:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "path/to/face.jpg"
face = image.face

face.angles.roll #=> -5.1492119
face.angles.yaw #=> -4.0695682
face.angles.pitch #=> -13.083284

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Angles

Returns a new instance of Angles.



151
152
153
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 151

def initialize
  @grpc = nil
end

Instance Attribute Details

#grpc ⇒ Object 



147
148
149
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 147

def grpc
  @grpc
end

Class Method Details

.from_grpc(grpc) ⇒ Object

object.



221
222
223
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 221

def self.from_grpc grpc
  new.tap { |f| f.instance_variable_set :@grpc, grpc }
end

Instance Method Details

#inspect ⇒ Object 



214
215
216
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 214

def inspect
  "#<Angles #{self}>"
end

#pitch ⇒ Float Also known as: tilt

Pitch (tilt) angle. Indicates the upwards/downwards angle that the face is pointing relative to the image’s horizontal plane.

Returns:

  • (Float) —

    A value in the range [-180,180].



184
185
186
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 184

def pitch
  @grpc.tilt_angle
end

#roll ⇒ Float

Roll angle. Indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical, about the axis perpendicular to the face.

Returns:

  • (Float) —

    A value in the range [-180,180].



162
163
164
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 162

def roll
  @grpc.roll_angle
end

#to_a ⇒ Array

Returns the object’s property values as an array.

Returns:

  • (Array) 


194
195
196
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 194

def to_a
  [roll, yaw, pitch]
end

#to_h ⇒ Hash

Converts object to a hash. All keys will be symbolized.

Returns:

  • (Hash) 


203
204
205
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 203

def to_h
  { roll: roll, yaw: yaw, pitch: pitch }
end

#to_s ⇒ Object 



208
209
210
211
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 208

def to_s
  format "(roll: %s, yaw: %s, pitch: %s)", roll.inspect,
         yaw.inspect, pitch.inspect
end

#yaw ⇒ Float Also known as: pan

Yaw (pan) angle. Indicates the leftward/rightward angle that the face is pointing, relative to the vertical plane perpendicular to the image.

Returns:

  • (Float) —

    A value in the range [-180,180].



173
174
175
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 173

def yaw
  @grpc.pan_angle
end