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

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

Overview

Face

The results of face detection.

See #faces and #face.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
vision = gcloud.vision

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

face = image.face
face.confidence #=> 0.86162376

Defined Under Namespace

Classes: Angles, Bounds, Features, Likelihood

Instance Method Summary collapse

Instance Method Details

#angles ⇒ Angles

The angles of the face, including roll, yaw, and pitch.

Returns:



56
57
58
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 56

def angles
  @angles ||= Angles.from_gapi @gapi
end

#bounds ⇒ Bounds

The bounds of the face, including the polygons for the head and face.

Returns:



66
67
68
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 66

def bounds
  @bounds ||= Bounds.from_gapi @gapi
end

#confidence ⇒ Float

The confidence of the facial detection.

Returns:

  • (Float) —

    A value in the range [0, 1].



95
96
97
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 95

def confidence
  @gapi.detection_confidence
end

#features ⇒ Features

The landmarks of the face, including the points for the eyes, ears, nose and mouth.

Returns:



76
77
78
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 76

def features
  @features ||= Features.from_gapi @gapi
end

#likelihood ⇒ Likelihood

The likelihood of the facial detection, including joy, sorrow, anger, surprise, under_exposed, blurred, and headwear.

Returns:



86
87
88
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 86

def likelihood
  @likelihood ||= Likelihood.from_gapi @gapi
end

#to_h ⇒ Hash

Deeply converts object to a hash. All keys will be symbolized.

Returns:

  • (Hash) 


104
105
106
107
 
# File 'lib/google/cloud/vision/annotation/face.rb', line 104

def to_h
  { angles: angles.to_h, bounds: bounds.to_h, features: features.to_h,
    likelihood: likelihood.to_h }
end