GdPicture.NET.14
GdPicture14 Namespace / GdPictureSegmenter Class / GetWordBottom Method
The unique result identifier of the executed segmentation process obtained by the GdPictureSegmenter.RunSegmentation method.
The 0-based index of the word within the specified segmentation result. It must be a value between 0 and GdPictureSegmenter.GetWordCount(SegmentationResultID)-1.
Example





In This Topic
GetWordBottom Method (GdPictureSegmenter)
In This Topic
Returns the bottom y-coordinate of the bounding box of the specified word, that is a part of the segmentation result specified by its index.

This method uses a coordinate system, where the origin is in the top-left corner of the processed image and the units are pixels.

Syntax
'Declaration
 

Public Function GetWordBottom( _
   ByVal SegmentationResultID As String, _
   ByVal WordIdx As Integer _
) As Integer
 

Parameters

SegmentationResultID
The unique result identifier of the executed segmentation process obtained by the GdPictureSegmenter.RunSegmentation method.
WordIdx
The 0-based index of the word within the specified segmentation result. It must be a value between 0 and GdPictureSegmenter.GetWordCount(SegmentationResultID)-1.

Return Value

The bottom y-coordinate of the word's bounding box, in pixels.

Please always use the GdPictureSegmenter.GetStat method to determine if this method has been successful.

Remarks
It is recommend to use the GdPictureSegmenter.GetStat method to identify the specific reason for the method's failure, if any.

Please note, that the origin of the used coordinate system is in the top-left corner of the processed image and the used units are pixels.

Example
How to find out detected words within the segmentation result. All words are subsequently color-coded and saved into the output file. 
Dim caption As String = "Example: GetWordBottom"
Using gdpictureSegmenter As GdPictureSegmenter = New GdPictureSegmenter()
    Using gdpictureImaging As GdPictureImaging = New GdPictureImaging()
        'Set up the image you want to process.
        Dim image As Integer = gdpictureImaging.CreateGdPictureImageFromFile("input.tif")
        If (gdpictureImaging.GetStat() = GdPictureStatus.OK) AndAlso
           (gdpictureSegmenter.SetImage(image) = GdPictureStatus.OK) Then
            'Set the segmentation mode.
            gdpictureSegmenter.SegmentationMode = SegmentationMode.ConnectedComponents4
            'Run the segmentation process.
            Dim resultID As String = gdpictureSegmenter.RunSegmentation()
            If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                'Check the results.
                Dim wordCount As Integer = gdpictureSegmenter.GetWordCount(resultID)
                If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                    Dim message As String = "The number of detected words: "
                    message = message + wordCount.ToString() + vbCrLf
                    Dim top As Integer = 0, left As Integer = 0, bottom As Integer = 0, right As Integer = 0, save As Integer = 0
                    For i As Integer = 0 To wordCount - 1
                        top = gdpictureSegmenter.GetWordTop(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then left = gdpictureSegmenter.GetWordLeft(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then bottom = gdpictureSegmenter.GetWordBottom(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then right = gdpictureSegmenter.GetWordRight(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                            If gdpictureImaging.DrawRectangle(image, left, top, right - left, bottom - top, 5, Color.Brown, True) = GdPictureStatus.OK Then
                                message = message + (i + 1).ToString() + ".rectangle has been drawn." + vbCrLf
                                save += 1
                            Else
                                message = message + (i + 1).ToString() + ".rectangle HAS NOT been drawn. Status: " + gdpictureSegmenter.GetStat().ToString() + vbCrLf
                            End If
                        Else
                            message = message + i.ToString() + ".word has failed to get its position. Status: " + gdpictureSegmenter.GetStat().ToString() + vbCrLf
                        End If
                    Next
                    If wordCount = 0 Then
                        message = message + "The resulting image HAS NOT been created."
                    Else
                        If save = wordCount Then
                            If gdpictureImaging.SaveAsTIFF(image, "output.tif", TiffCompression.TiffCompressionAUTO) = GdPictureStatus.OK Then
                                message = message + "The resulting image HAS been saved successfully."
                            Else
                                message = message + "The resulting image HAS NOT been saved. Status: " + gdpictureImaging.GetStat().ToString()
                            End If
                        End If
                    End If
                    MessageBox.Show(message, caption)
                Else
                    MessageBox.Show("The GetWordCount() method has failed with the status: " + gdpictureSegmenter.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The segmentation process has failed with the status: " + gdpictureSegmenter.GetStat().ToString(), caption)
            End If
            'Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image)
        Else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat().ToString() + " or " + gdpictureSegmenter.GetStat().ToString(), caption)
        End If
    End Using
    'Release resources.
    gdpictureSegmenter.ReleaseSegmentationResults()
End Using
See Also

Reference

GdPictureSegmenter Class
GdPictureSegmenter Members
GetWordCount Method
GetWordTop Method
GetWordLeft Method
GetWordRight Method
RunSegmentation Method

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved