Class: Azure::CognitiveServices::ComputerVision::V2_0::Models::TextRecognitionResult

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb

Overview

An object representing a recognized text region

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#clockwise_orientation ⇒ Float

clockwise direction. Range between [0, 360).

Returns:

  • (Float) —

    The orientation of the image in degrees in the



20
21
22
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 20

def clockwise_orientation
  @clockwise_orientation
end

#height ⇒ Float

Returns The height of the image in pixels or the PDF in inches.

Returns:

  • (Float) —

    The height of the image in pixels or the PDF in inches.



26
27
28
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 26

def height
  @height
end

#lines ⇒ Array<Line>

Returns A list of recognized text lines.

Returns:

  • (Array<Line>) —

    A list of recognized text lines.



34
35
36
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 34

def lines
  @lines
end

#page ⇒ Integer

Returns The 1-based page number of the recognition result.

Returns:

  • (Integer) —

    The 1-based page number of the recognition result.



16
17
18
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 16

def page
  @page
end

#unit ⇒ TextRecognitionResultDimensionUnit

Width, Height and BoundingBox. For images, the unit is ‘pixel’. For PDF, the unit is ‘inch’. Possible values include: ‘pixel’, ‘inch’

Returns:



31
32
33
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 31

def unit
  @unit
end

#width ⇒ Float

Returns The width of the image in pixels or the PDF in inches.

Returns:

  • (Float) —

    The width of the image in pixels or the PDF in inches.



23
24
25
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 23

def width
  @width
end

Class Method Details

.mapper ⇒ Object

Mapper for TextRecognitionResult class as Ruby Hash. This will be used for serialization/deserialization.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/2.0/generated/azure_cognitiveservices_computervision/models/text_recognition_result.rb', line 41

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'TextRecognitionResult',
    type: {
      name: 'Composite',
      class_name: 'TextRecognitionResult',
      model_properties: {
        page: {
          client_side_validation: true,
          required: false,
          serialized_name: 'page',
          type: {
            name: 'Number'
          }
        },
        clockwise_orientation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'clockwiseOrientation',
          type: {
            name: 'Double'
          }
        },
        width: {
          client_side_validation: true,
          required: false,
          serialized_name: 'width',
          type: {
            name: 'Double'
          }
        },
        height: {
          client_side_validation: true,
          required: false,
          serialized_name: 'height',
          type: {
            name: 'Double'
          }
        },
        unit: {
          client_side_validation: true,
          required: false,
          serialized_name: 'unit',
          type: {
            name: 'Enum',
            module: 'TextRecognitionResultDimensionUnit'
          }
        },
        lines: {
          client_side_validation: true,
          required: true,
          serialized_name: 'lines',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LineElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Line'
                }
            }
          }
        }
      }
    }
  }
end