Reference documentation and code samples for the Cloud Vision V1 Client class Block.
Logical element on the page.
Generated from protobuf message google.cloud.vision.v1.Block
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 block. |
↳ bounding_box |
Google\Cloud\Vision\V1\BoundingPoly
The bounding box for the block. 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). |
↳ paragraphs |
array<Google\Cloud\Vision\V1\Paragraph>
List of paragraphs in this block (if this blocks is of type text). |
↳ block_type |
int
Detected block type (text, image etc) for this block. |
↳ confidence |
float
Confidence of the OCR results on the block. Range [0, 1]. |
getProperty
Additional information detected for the block.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Vision\V1\TextAnnotation\TextProperty|null | |
hasProperty
clearProperty
setProperty
Additional information detected for the block.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Vision\V1\TextAnnotation\TextProperty
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBoundingBox
The bounding box for the block.
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 block.
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 | |
getParagraphs
List of paragraphs in this block (if this blocks is of type text).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setParagraphs
List of paragraphs in this block (if this blocks is of type text).
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Vision\V1\Paragraph>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBlockType
Detected block type (text, image etc) for this block.
| Returns | |
|---|---|
| Type | Description |
int | |
setBlockType
Detected block type (text, image etc) for this block.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConfidence
Confidence of the OCR results on the block. Range [0, 1].
| Returns | |
|---|---|
| Type | Description |
float | |
setConfidence
Confidence of the OCR results on the block. Range [0, 1].
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |