Class: Google::Apis::VisionV1::ReferenceImage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1/classes.rb,
generated/google/apis/vision_v1/representations.rb,
generated/google/apis/vision_v1/representations.rb

Overview

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReferenceImage

Returns a new instance of ReferenceImage



11931
11932
11933
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11931

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bounding_polys ⇒ Array<Google::Apis::VisionV1::BoundingPoly>

Bounding polygons around the areas of interest in the reference image. Optional. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). Corresponds to the JSON property boundingPolys

Returns:



11913
11914
11915
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11913

def bounding_polys
  @bounding_polys
end

#name ⇒ String

The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ IMAGE_ID. This field is ignored when creating a reference image. Corresponds to the JSON property name

Returns:

  • (String) 


11922
11923
11924
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11922

def name
  @name
end

#uri ⇒ String

The Google Cloud Storage URI of the reference image. The URI must start with gs://. Required. Corresponds to the JSON property uri

Returns:

  • (String) 


11929
11930
11931
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11929

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11936
11937
11938
11939
11940
 
# File 'generated/google/apis/vision_v1/classes.rb', line 11936

def update!(**args)
  @bounding_polys = args[:bounding_polys] if args.key?(:bounding_polys)
  @name = args[:name] if args.key?(:name)
  @uri = args[:uri] if args.key?(:uri)
end