Class: Google::Cloud::Vision::Annotation::Entity

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

Overview

# Entity

Represents characteristics of an entity detected in an image. May describe a real-world entity such as a person, place, or thing. May be identified with an entity ID as an entity in the Knowledge Graph (KG).

Examples:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

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

landmark = image.landmark
landmark.score #=> 0.91912264
landmark.description #=> "Mount Rushmore"
landmark.mid #=> "/m/019dvv"
require "google/cloud/vision"

vision = Google::Cloud::Vision.new

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

 = image.
.score #=> 0.70057315
.description #=> "Google"
.mid #=> "/m/0b34hf"
require "google/cloud/vision"

vision = Google::Cloud::Vision.new

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

labels = image.labels
labels.count #=> 4

label = labels.first
label.score #=> 0.9481349
label.description #=> "person"
label.mid #=> "/m/01g317"

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Entity

Returns a new instance of Entity.



78
79
80
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 78

def initialize
  @grpc = nil
end

Instance Attribute Details

#grpc ⇒ Object 



74
75
76
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 74

def grpc
  @grpc
end

Class Method Details

.from_grpc(grpc) ⇒ Object 



218
219
220
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 218

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

Instance Method Details

#bounds ⇒ Array<Vertex>

Image region to which this entity belongs. Not filled currently for ‘labels` detection.

Returns:

  • (Array<Vertex>) —

    An array of vertices.



154
155
156
157
158
159
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 154

def bounds
  return [] unless @grpc.bounding_poly
  @bounds ||= Array(@grpc.bounding_poly.vertices).map do |v|
    Vertex.from_grpc v
  end
end

#confidence ⇒ Float

The accuracy of the entity detection in an image. For example, for an image containing ‘Eiffel Tower,’ this field represents the confidence that there is a tower in the query image.

Returns:

  • (Float) —

    A value in the range [0, 1].



131
132
133
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 131

def confidence
  @grpc.confidence
end

#description ⇒ String

Entity textual description, expressed in the #locale language.

Returns:

  • (String) —

    A description of the entity.



111
112
113
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 111

def description
  @grpc.description
end

#inspect ⇒ Object 



212
213
214
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 212

def inspect
  "#<#{self.class.name} #{self}>"
end

#locale ⇒ String

The language code for the locale in which the ‘description` is expressed.

Returns:



102
103
104
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 102

def locale
  @grpc.locale
end

#locations ⇒ Array<Location>

The location information for the detected entity. Multiple Location elements can be present since one location may indicate the location of the scene in the query image, and another the location of the place where the query image was taken. Location information is usually present for landmarks.

Returns:

  • (Array<Location>) —

    An array of locations containing latitude and longitude.



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

def locations
  @locations ||= Array(@grpc.locations).map do |l|
    Location.from_grpc l.lat_lng
  end
end

#mid ⇒ String

Opaque entity ID. Some IDs might be available in Knowledge Graph (KG).

Returns:

  • (String) —

    The opaque entity ID.

See Also:



90
91
92
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 90

def mid
  @grpc.mid
end

#properties ⇒ Hash

Some entities can have additional optional Property fields. For example a different kind of score or string that qualifies the entity. present for landmarks.

Returns:

  • (Hash) —

    A hash containing property names and values.



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

def properties
  @properties ||=
    Hash[Array(@grpc.properties).map { |p| [p.name, p.value] }]
end

#score ⇒ Float

Overall score of the result.

Returns:

  • (Float) —

    A value in the range [0, 1].



120
121
122
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 120

def score
  @grpc.score
end

#to_h ⇒ Hash

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

Returns:

  • (Hash) 


194
195
196
197
198
199
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 194

def to_h
  { mid: mid, locale: locale, description: description,
    score: score, confidence: confidence, topicality: topicality,
    bounds: bounds.map(&:to_h), locations: locations.map(&:to_h),
    properties: properties }
end

#to_s ⇒ Object 



202
203
204
205
206
207
208
209
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 202

def to_s
  tmplt = "mid: %s, locale: %s, description: %s, score: %s, " \
          "confidence: %s, topicality: %s, bounds: %i, " \
          "locations: %i, properties: %s"
  format tmplt, mid.inspect, locale.inspect, description.inspect,
         score.inspect, confidence.inspect, topicality.inspect,
         bounds.count, locations.count, properties.inspect
end

#topicality ⇒ Float

The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of ‘tower’ to an image containing ‘Eiffel Tower’ is likely higher than an image containing a distant towering building, though the confidence that there is a tower may be the same.

Returns:

  • (Float) —

    A value in the range [0, 1].



144
145
146
 
# File 'lib/google/cloud/vision/annotation/entity.rb', line 144

def topicality
  @grpc.topicality
end