google-cloud-vision 0.30.4 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe3749e507b7805dca06c8a3def8d9a8b9ef304db045cbc3cfafbb909d60198f
-  data.tar.gz: 4a4249af10a0a2bc4720d1de86d1b5b913f7e0542358cdfd1c2310b4f03f9a20
+  metadata.gz: b97dd452706561fd304da05cf2572636618d8695e0d13e9db8fe0e000cd3a876
+  data.tar.gz: d1c466ff99ff655bb881d382e444846605a927a5820e2645f2068cd5a8e053b3
 SHA512:
-  metadata.gz: 8e40b6316cce217c6d546e269981cf3cbbdb5fe2cf99e14985308370839e90fccb26584ca96993e083935401f037c25bcd2c29afde59f392c8610bdc94814b90
-  data.tar.gz: 42ea947494ff179667fc0a62d54e49d74558b22417dd793e257bd4f0e3a8a197f6a6e598e0e031d5622242a1646f0bc68a6d3223b458a70c97223077c90bd0fb
+  metadata.gz: d12d2ecd9e3c996af934dff0ae9508a377cb373ba92852d2b7c3aff0e6e34039403f0f54c5ba15f05c911ea490c80794aef2d3a7eac70ab5842377bec9567260
+  data.tar.gz: ed0e16cb06817bb8cecaf574247e44466db8c4f1f96d2c064ef3bfb17c5e37b6df75310bacebc2f58bc7841fd25bce38f27ce5bd2e6fbe52d2c8a0c22a304cc2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History
 
+### 0.31.0 / 2018-09-26
+
+* Add Object Localization.
+
 ### 0.30.4 / 2018-09-20
 
 * Update documentation.

data/lib/google-cloud-vision.rb

@@ -142,4 +142,5 @@ Google::Cloud.configure.add_config! :vision do |config|
   config.add_field! :default_max_labels, 100
   config.add_field! :default_max_crop_hints, 100
   config.add_field! :default_max_web, 100
+  config.add_field! :default_max_object_localizations, 100
 end

data/lib/google/cloud/vision.rb

@@ -442,6 +442,14 @@ module Google
         def default_max_web
           configure.default_max_web
         end
+
+        def default_max_object_localizations= value
+          configure.default_max_object_localizations = value
+        end
+
+        def default_max_object_localizations
+          configure.default_max_object_localizations
+        end
       end
 
       ##

data/lib/google/cloud/vision/annotate.rb

@@ -116,6 +116,7 @@ module Google
         #   feature. Optional.
         # @param [Boolean, Integer] web Whether to perform the web annotation
         #   feature. Optional.
+        # @param [Boolean, Integer] object_localizations TODO! Optional.
         #
         # @return [Annotation, Array<Annotation>] The results for all image
         #   detections, returned as a single {Annotation} instance for one
@@ -145,9 +146,10 @@ module Google
         def annotate *images, faces: false, landmarks: false, logos: false,
                      labels: false, text: false, document: false,
                      safe_search: false, properties: false, crop_hints: false,
-                     web: false
+                     web: false, object_localizations: false
           add_requests(images, faces, landmarks, logos, labels, text, document,
-                       safe_search, properties, crop_hints, web)
+                       safe_search, properties, crop_hints, web,
+                       object_localizations)
         end
 
         protected
@@ -158,10 +160,11 @@ module Google
         end
 
         def add_requests images, faces, landmarks, logos, labels, text,
-                         document, safe_search, properties, crop_hints, web
+                         document, safe_search, properties, crop_hints, web,
+                         object_localizations
           features = annotate_features(faces, landmarks, logos, labels, text,
                                        document, safe_search, properties,
-                                       crop_hints, web)
+                                       crop_hints, web, object_localizations)
 
           Array(images).flatten.each do |img|
             i = image(img)
@@ -174,38 +177,54 @@ module Google
         end
 
         def annotate_features faces, landmarks, logos, labels, text, document,
-                              safe_search, properties, crop_hints, web
+                              safe_search, properties, crop_hints, web,
+                              object_localizations
           return default_features if default_features?(
             faces, landmarks, logos, labels, text, document, safe_search,
-            properties, crop_hints, web
+            properties, crop_hints, web, object_localizations
           )
 
-          faces, landmarks, logos, labels, crop_hints, web = validate_max_args(
-            faces, landmarks, logos, labels, crop_hints, web
-          )
+          faces, landmarks, logos, labels, crop_hints, web, \
+            object_localizations = validate_max_args(
+              faces, landmarks, logos, labels, crop_hints, web,
+              object_localizations
+            )
 
-          f = value_features faces, landmarks, logos, labels, crop_hints, web
+          f = value_features faces, landmarks, logos, labels, crop_hints, web,
+                             object_localizations
           f + boolean_features(text, document, safe_search, properties)
         end
 
-        def value_features faces, landmarks, logos, labels, crop_hints, web
-          f = []
-          f << feature(:FACE_DETECTION, faces) unless faces.zero?
-          f << feature(:LANDMARK_DETECTION, landmarks) unless landmarks.zero?
-          f << feature(:LOGO_DETECTION, logos) unless logos.zero?
-          f << feature(:LABEL_DETECTION, labels) unless labels.zero?
-          f << feature(:CROP_HINTS, crop_hints) unless crop_hints.zero?
-          f << feature(:WEB_DETECTION, web) unless web.zero?
-          f
+        def value_features faces, landmarks, logos, labels, crop_hints, web,
+                           object_localizations
+          [
+            value_feature(:FACE_DETECTION, faces),
+            value_feature(:LANDMARK_DETECTION, landmarks),
+            value_feature(:LOGO_DETECTION, logos),
+            value_feature(:LABEL_DETECTION, labels),
+            value_feature(:CROP_HINTS, crop_hints),
+            value_feature(:WEB_DETECTION, web),
+            value_feature(:OBJECT_LOCALIZATION, object_localizations)
+          ].compact
+        end
+
+        def value_feature type, value
+          return if value.zero?
+          feature type, value
         end
 
         def boolean_features text, document, safe_search, properties
-          f = []
-          f << feature(:TEXT_DETECTION, 1) if text
-          f << feature(:DOCUMENT_TEXT_DETECTION, 1) if document
-          f << feature(:SAFE_SEARCH_DETECTION, 1) if safe_search
-          f << feature(:IMAGE_PROPERTIES, 1) if properties
-          f
+          [
+            boolean_feature(:TEXT_DETECTION, text),
+            boolean_feature(:DOCUMENT_TEXT_DETECTION, document),
+            boolean_feature(:SAFE_SEARCH_DETECTION, safe_search),
+            boolean_feature(:IMAGE_PROPERTIES, properties)
+          ].compact
+        end
+
+        def boolean_feature type, value
+          return unless value
+          feature type, 1
         end
 
         def feature type, max_results
@@ -215,11 +234,12 @@ module Google
         end
 
         def default_features? faces, landmarks, logos, labels, text, document,
-                              safe_search, properties, crop_hints, web
+                              safe_search, properties, crop_hints, web,
+                              object_localizations
           faces == false && landmarks == false && logos == false &&
             labels == false && text == false && document == false &&
             safe_search == false && properties == false &&
-            crop_hints == false && web == false
+            crop_hints == false && web == false && object_localizations == false
         end
 
         def default_features
@@ -235,11 +255,14 @@ module Google
             feature(:SAFE_SEARCH_DETECTION, 1),
             feature(:IMAGE_PROPERTIES, 1),
             feature(:CROP_HINTS, Google::Cloud::Vision.default_max_crop_hints),
-            feature(:WEB_DETECTION, Google::Cloud::Vision.default_max_web)
+            feature(:WEB_DETECTION, Google::Cloud::Vision.default_max_web),
+            feature(:OBJECT_LOCALIZATION,
+                    Google::Cloud::Vision.default_max_object_localizations)
           ]
         end
 
-        def validate_max_args faces, landmarks, logos, labels, crop_hints, web
+        def validate_max_args faces, landmarks, logos, labels, crop_hints, web,
+                              object_localizations
           faces = validate_max_value(
             faces, Google::Cloud::Vision.default_max_faces
           )
@@ -258,7 +281,15 @@ module Google
           web = validate_max_value(
             web, Google::Cloud::Vision.default_max_web
           )
-          [faces, landmarks, logos, labels, crop_hints, web]
+          object_localizations = validate_max_value(
+            object_localizations,
+            Google::Cloud::Vision.default_max_object_localizations
+          )
+
+          [
+            faces, landmarks, logos, labels, crop_hints, web,
+            object_localizations
+          ]
         end
 
         def validate_max_value value, default_value

data/lib/google/cloud/vision/annotation.rb

@@ -20,6 +20,7 @@ require "google/cloud/vision/annotation/safe_search"
 require "google/cloud/vision/annotation/properties"
 require "google/cloud/vision/annotation/crop_hint"
 require "google/cloud/vision/annotation/web"
+require "google/cloud/vision/annotation/object_localization"
 
 module Google
   module Cloud
@@ -475,6 +476,44 @@ module Google
           !web.nil?
         end
 
+        ##
+        # The results of object localizations detection.
+        #
+        # @return [Array<ObjectLocalization>]
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/face.jpg"
+        #
+        #   annotation = vision.annotate image, object_localizations: true
+        #   object_localizations = annotation.object_localizations
+        #
+        def object_localizations
+          @ol ||= @grpc.localized_object_annotations.map do |ol|
+            ObjectLocalization.from_grpc ol
+          end
+        end
+
+        ##
+        # Whether there is a result for object localizations detection.
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/face.jpg"
+        #
+        #   annotation = vision.annotate image, object_localizations: true
+        #   annotation.object_localizations? #=> true
+        #
+        def object_localizations?
+          !object_localizations.empty?
+        end
+
         ##
         # Deeply converts object to a hash. All keys will be symbolized.
         #
@@ -485,16 +524,17 @@ module Google
             logos: logos.map(&:to_h), labels: labels.map(&:to_h),
             text: text.to_h, safe_search: safe_search.to_h,
             properties: properties.to_h, crop_hints: crop_hints.map(&:to_h),
-            web: web.to_h }
+            web: web.to_h, object_localizations: object_localizations.to_h }
         end
 
         # @private
         def to_s
           tmplt = "(faces: %i, landmarks: %i, logos: %i, labels: %i," \
                   " text: %s, safe_search: %s, properties: %s," \
-                  " crop_hints: %s, web: %s)"
+                  " crop_hints: %s, web: %s, object_localizations: %i)"
           format tmplt, faces.count, landmarks.count, logos.count, labels.count,
-                 text?, safe_search?, properties?, crop_hints?, web?
+                 text?, safe_search?, properties?, crop_hints?, web?,
+                 object_localizations.count
         end
 
         # @private

data/lib/google/cloud/vision/annotation/normalized_vertex.rb

@@ -0,0 +1,76 @@
+# Copyright 2016 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Cloud
+    module Vision
+      class Annotation
+        ##
+        # # NormalizedVertex
+        #
+        # A normalized vertex in a set of bounding polygon vertices.
+        #
+        # @attr_reader [Float] x The X coordinate.
+        # @attr_reader [Float] y The Y coordinate.
+        #
+        class NormalizedVertex
+          attr_reader :x, :y
+
+          ##
+          # @private Creates a new NormalizedVertex instance.
+          def initialize x, y
+            @x = x
+            @y = y
+          end
+
+          ##
+          # Returns the object's property values as an array.
+          #
+          # @return [Array]
+          #
+          def to_a
+            [x, y]
+          end
+
+          ##
+          # Converts object to a hash. All keys will be symbolized.
+          #
+          # @return [Hash]
+          #
+          def to_h
+            { x: x, y: y }
+          end
+
+          # @private
+          def to_s
+            "(x: #{x.inspect}, y: #{y.inspect})"
+          end
+
+          # @private
+          def inspect
+            "#<NormalizedVertex #{self}>"
+          end
+
+          ##
+          # @private New Annotation::Entity::Bounds::Vertex from a Google API
+          # Client object.
+          def self.from_grpc grpc
+            new grpc.x, grpc.y
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/vision/annotation/object_localization.rb

@@ -0,0 +1,115 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/vision/annotation/normalized_vertex"
+
+module Google
+  module Cloud
+    module Vision
+      class Annotation
+        class ObjectLocalization
+          ##
+          # @private The LocalizedObjectAnnotation GRPC object.
+          attr_accessor :grpc
+
+          ##
+          # @private Creates a new Web instance.
+          def initialize
+            @grpc = nil
+          end
+
+          ##
+          # Opaque entity ID. Should align with {Entity#mid}.
+          #
+          # @return [String] The opaque entity ID.
+          #
+          def mid
+            @grpc.mid
+          end
+
+          ##
+          # The BCP-47 language code, such as "en-US" or "sr-Latn".
+          #
+          # @see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier
+          #
+          # @return [String] The language code.
+          #
+          def code
+            @grpc.language_code
+          end
+
+          ##
+          # Object name, expressed in its {#code} language.
+          #
+          # @return [String] The object name.
+          #
+          def name
+            @grpc.name
+          end
+
+          ##
+          # The score of the result. Range [0, 1].
+          #
+          # @return [Float] A value in the range [0, 1].
+          #
+          def score
+            @grpc.score
+          end
+
+          ##
+          # Image region to which this entity belongs.
+          #
+          # @return [Array<NormalizedVertex>] An array of normalized vertices.
+          #
+          def bounds
+            return [] unless @grpc.bounding_poly
+            @bounds ||= @grpc.bounding_poly.normalized_vertices.map do |v|
+              NormalizedVertex.from_grpc v
+            end
+          end
+
+          ##
+          # Deeply converts object to a hash. All keys will be symbolized.
+          #
+          # @return [Hash]
+          #
+          def to_h
+            { mid: mid, code: code, name: name, score: score,
+              bounds: bounds.map(&:to_h) }
+          end
+
+          # @private
+          def to_s
+            tmplt = "mid: %s, code: %s, name: %s, score: %s, " \
+                    " bounds: %i"
+            format tmplt, mid.inspect, code.inspect, name.inspect,
+                   score.inspect, bounds.count
+          end
+
+          # @private
+          def inspect
+            "#<#{self.class.name} #{self}>"
+          end
+
+          ##
+          # @private New Annotation::Face from a GRPC object.
+          def self.from_grpc grpc
+            new.tap { |ol| ol.instance_variable_set :@grpc, grpc }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/vision/image.rb

@@ -434,6 +434,34 @@ module Google
           annotation.web
         end
 
+        ##
+        # Performs the `OBJECT_LOCALIZATION` feature on the image.
+        #
+        # @see https://cloud.google.com/vision/docs/pricing Cloud Vision Pricing
+        #
+        # @return [Array<Annotation::ObjectLocalization>] The results of object
+        #   localizations detection.
+        #
+        # @example
+        #   require "google/cloud/vision"
+        #
+        #   vision = Google::Cloud::Vision.new
+        #   image = vision.image "path/to/bicycle.jpg"
+        #
+        #   object_localizations = image.object_localizations
+        #   object_localizations.count #=> 6
+        #   object_localization = object_localizations.first
+        #
+        #   object_localization.name #=> "Bicycle wheel"
+        #   object_localization.bounds.count #=> 4
+        #
+        def object_localizations max_results = \
+                                Vision.default_max_object_localizations
+          ensure_vision!
+          annotation = @vision.mark self, object_localizations: max_results
+          annotation.object_localizations
+        end
+
         ##
         # Performs detection of Cloud Vision
         # [features](https://cloud.google.com/vision/reference/rest/v1/images/annotate#Feature)
@@ -480,6 +508,8 @@ module Google
         #   feature. Optional.
         # @param [Boolean, Integer] web Whether to perform the web annotation
         #   feature. Optional.
+        # @param [Boolean, Integer] object_localizations Whether to perform the
+        #   object localizations feature. Optional.
         #
         # @return [Annotation] The results for all image detections, returned as
         #   a single {Annotation} instance.
@@ -514,12 +544,13 @@ module Google
         def annotate faces: false, landmarks: false, logos: false,
                      labels: false, text: false, document: false,
                      safe_search: false, properties: false, crop_hints: false,
-                     web: false
+                     web: false, object_localizations: false
           @vision.annotate(self, faces: faces, landmarks: landmarks,
                                  logos: logos, labels: labels, text: text,
                                  document: document, safe_search: safe_search,
                                  properties: properties, crop_hints: crop_hints,
-                                 web: web)
+                                 web: web,
+                                 object_localizations: object_localizations)
         end
         alias mark annotate
         alias detect annotate

data/lib/google/cloud/vision/project.rb

@@ -186,6 +186,8 @@ module Google
         #   feature. Optional.
         # @param [Boolean, Integer] web Whether to perform the web annotation
         #   feature. Optional.
+        # @param [Boolean, Integer] object_localizations Whether to perform the
+        #   object localizations feature. Optional.
         #
         # @yield [annotate] A block for requests that involve multiple feature
         #   configurations. See {Annotate#annotate}.
@@ -257,12 +259,13 @@ module Google
         def annotate *images, faces: false, landmarks: false, logos: false,
                      labels: false, text: false, document: false,
                      safe_search: false, properties: false, crop_hints: false,
-                     web: false
+                     web: false, object_localizations: false
           a = Annotate.new self
           a.annotate(*images, faces: faces, landmarks: landmarks, logos: logos,
                               labels: labels, text: text, document: document,
                               safe_search: safe_search, properties: properties,
-                              crop_hints: crop_hints, web: web)
+                              crop_hints: crop_hints, web: web,
+                              object_localizations: object_localizations)
 
           yield a if block_given?
 

data/lib/google/cloud/vision/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Vision
-      VERSION = "0.30.4".freeze
+      VERSION = "0.31.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-vision
 version: !ruby/object:Gem::Version
-  version: 0.30.4
+  version: 0.31.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -203,6 +203,8 @@ files:
 - lib/google/cloud/vision/annotation/crop_hint.rb
 - lib/google/cloud/vision/annotation/entity.rb
 - lib/google/cloud/vision/annotation/face.rb
+- lib/google/cloud/vision/annotation/normalized_vertex.rb
+- lib/google/cloud/vision/annotation/object_localization.rb
 - lib/google/cloud/vision/annotation/properties.rb
 - lib/google/cloud/vision/annotation/safe_search.rb
 - lib/google/cloud/vision/annotation/text.rb