Cloud Vision V1 Client - Class Symbol (1.9.4)

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

A single symbol representation.

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

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ property Google\Cloud\Vision\V1\TextAnnotation\TextProperty

Additional information detected for the symbol.
↳ bounding_box Google\Cloud\Vision\V1\BoundingPoly

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 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).
↳ text string

The actual UTF-8 representation of the symbol.
↳ confidence float

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

getProperty

Additional information detected for the symbol.

Returns
Type Description
Google\Cloud\Vision\V1\TextAnnotation\TextProperty|null

hasProperty

clearProperty

setProperty

Additional information detected for the symbol.

Parameter
Name Description
var Google\Cloud\Vision\V1\TextAnnotation\TextProperty
Returns
Type Description
$this

getBoundingBox

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 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
Google\Cloud\Vision\V1\BoundingPoly|null

hasBoundingBox

clearBoundingBox

setBoundingBox

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 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
var Google\Cloud\Vision\V1\BoundingPoly
Returns
Type Description
$this

getText

The actual UTF-8 representation of the symbol.

Returns
Type Description
string

setText

The actual UTF-8 representation of the symbol.

Parameter
Name Description
var string
Returns
Type Description
$this

getConfidence

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

Returns
Type Description
float

setConfidence

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

Parameter
Name Description
var float
Returns
Type Description
$this