Class: Google::Cloud::Vision::Annotation::Text::Page::Symbol

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

Overview

Symbol

A word representation. See Paragraph.

Examples:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "path/to/text.png"
text = image.text
page = text.pages.first

symbol = page.blocks[0].paragraphs[0].words[0].symbols[0]

symbol.languages.first.code #=> "en"
symbol.bounds.count #=> 4
symbol.text #=> "G"

Instance Method Summary collapse

Instance Method Details

#bounds ⇒ Array<Vertex>

The bounding box for the symbol. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

  • when the text is horizontal it might look like: 0----1 | | 3----2
  • when rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

Returns:



873
874
875
876
877
878
 
# File 'lib/google/cloud/vision/annotation/text.rb', line 873

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

#break_type ⇒ ::Symbol

The type of a detected break at the start or end of the page.

Returns:

  • (::Symbol) 


837
838
839
840
 
# File 'lib/google/cloud/vision/annotation/text.rb', line 837

def break_type
  @grpc.property.detected_break &&
    @grpc.property.detected_break.type.to_sym
end

#languages ⇒ Array<Language>

A list of detected languages together with confidence.

Returns:



825
826
827
828
829
830
 
# File 'lib/google/cloud/vision/annotation/text.rb', line 825

def languages
  detected_languages = @grpc.property.detected_languages
  @languages ||= Array(detected_languages).map do |l|
    Language.from_grpc l
  end
end

#prefix_break? ⇒ Boolean

True if a detected break prepends the page.

Returns:

  • (Boolean) 


847
848
849
850
 
# File 'lib/google/cloud/vision/annotation/text.rb', line 847

def prefix_break?
  @grpc.property.detected_break &&
    @grpc.property.detected_break.is_prefix
end

#text ⇒ String

The actual UTF-8 representation of the symbol.

Returns:

  • (String) 


885
886
887
 
# File 'lib/google/cloud/vision/annotation/text.rb', line 885

def text
  @grpc.text
end

#to_h ⇒ Hash

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

Returns:

  • (Hash) 


894
895
896
897
898
 
# File 'lib/google/cloud/vision/annotation/text.rb', line 894

def to_h
  { languages: languages.map(&:to_h), break_type: break_type,
    prefix_break: prefix_break?, bounds: bounds.map(&:to_h),
    text: text }
end