Cloud Vision V1 Client - Class Word (2.1.1)

Reference documentation and code samples for the Cloud Vision V1 Client class Word.

A word representation.

Generated from protobuf message google.cloud.vision.v1.Word

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ property
TextAnnotation\TextProperty

Additional information detected for the word.

↳ bounding_box
BoundingPoly

The bounding box for the word. 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 it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).

↳ symbols
array< Symbol >

List of symbols in the word. The order of the symbols follows the natural reading order.

↳ confidence
float

Confidence of the OCR results for the word. Range [0, 1].

getProperty

Additional information detected for the word.

Returns
Type
Description

hasProperty

clearProperty

setProperty

Additional information detected for the word.

Parameter
Name
Description
Returns
Type
Description
$this

getBoundingBox

The bounding box for the word.

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 it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).
Returns
Type
Description
BoundingPoly |null

hasBoundingBox

clearBoundingBox

setBoundingBox

The bounding box for the word.

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 it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertex order will still be (0, 1, 2, 3).
Parameter
Name
Description
Returns
Type
Description
$this

getSymbols

List of symbols in the word.

The order of the symbols follows the natural reading order.

Returns
Type
Description

setSymbols

List of symbols in the word.

The order of the symbols follows the natural reading order.

Parameter
Name
Description
var
array< Symbol >
Returns
Type
Description
$this

getConfidence

Confidence of the OCR results for the word. Range [0, 1].

Returns
Type
Description
float

setConfidence

Confidence of the OCR results for the word. Range [0, 1].

Parameter
Name
Description
var
float
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: