Class: Gcloud::Vision::Image::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/gcloud/vision/image.rb

Overview

# Image::Context

Represents an image context.

Examples:

require "gcloud"

gcloud = Gcloud.new
vision = gcloud.vision

image = vision.image "path/to/landmark.jpg"
image.context.area.min = { longitude: -122.0862462,
                           latitude: 37.4220041 }
image.context.area.max = { longitude: -122.0762462,
                           latitude: 37.4320041 }

Defined Under Namespace

Classes: Area

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeContext

Returns a new instance of Context.



462
463
464
465
# File 'lib/gcloud/vision/image.rb', line 462

def initialize
  @area = Area.new
  @languages = []
end

Instance Attribute Details

#areaArea (readonly)

Returns a lat/long rectangle that specifies the location of the image.

Returns:

  • (Area)

    The lat/long pairs for latLongRect.



456
457
458
# File 'lib/gcloud/vision/image.rb', line 456

def area
  @area
end

#languagesArray<String>

A list of [ISO 639-1 language codes](en.wikipedia.org/wiki/List_of_ISO_639-1_codes) to use for text (OCR) detection. In most cases, an empty value will yield the best results as it will allow text detection to automatically detect the text language. For languages based on the latin alphabet a hint is not needed. In rare cases, when the language of the text in the image is known in advance, setting this hint will help get better results (although it will hurt a great deal if the hint is wrong).

Returns:

  • (Array<String>)

    the current value of languages



453
454
455
# File 'lib/gcloud/vision/image.rb', line 453

def languages
  @languages
end

Instance Method Details

#empty?Boolean

Returns true if either min or max are not populated.

Returns:

  • (Boolean)


472
473
474
# File 'lib/gcloud/vision/image.rb', line 472

def empty?
  area.empty? && languages.empty?
end

#to_gapiObject



478
479
480
481
482
483
484
# File 'lib/gcloud/vision/image.rb', line 478

def to_gapi
  return nil if empty?
  gapi = {}
  gapi[:latLongRect] = area.to_hash unless area.empty?
  gapi[:languageHints] = languages unless languages.empty?
  gapi
end