GetCharacterTop Method (GdPictureSegmenter)

In This Topic

Returns the top y-coordinate of the bounding box of the specified character, 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

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function GetCharacterTop( _
   ByVal SegmentationResultID As String, _
   ByVal CharacterIdx As Integer _
) As Integer

public int GetCharacterTop( 
   string SegmentationResultID,
   int CharacterIdx
)

public function GetCharacterTop( 
    SegmentationResultID: String;
    CharacterIdx: Integer
): Integer;

public function GetCharacterTop( 
   SegmentationResultID : String,
   CharacterIdx : int
) : int;

public: int GetCharacterTop( 
   string* SegmentationResultID,
   int CharacterIdx
)

public:
int GetCharacterTop( 
   String^ SegmentationResultID,
   int CharacterIdx
)

Parameters

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

Return Value

The top y-coordinate of the character'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 characters within the segmentation result. All characters are subsequently color-coded and saved into the output file.

VB.NET
C#

Dim caption As String = "Example: GetCharacterTop"
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 characterCount As Integer = gdpictureSegmenter.GetCharacterCount(resultID)
                If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                    Dim message As String = "The number of detected characters: "
                    message = message + characterCount.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 characterCount - 1
                        top = gdpictureSegmenter.GetCharacterTop(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then left = gdpictureSegmenter.GetCharacterLeft(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then bottom = gdpictureSegmenter.GetCharacterBottom(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then right = gdpictureSegmenter.GetCharacterRight(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 characterCount = 0 Then
                        message = message + "The resulting image HAS NOT been created."
                    Else
                        If save = characterCount 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 GetCharacterCount() 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

string caption = "Example: GetCharacterTop";
using (GdPictureSegmenter gdpictureSegmenter = new GdPictureSegmenter())
{
    //Set up the image you want to process.
    using (GdPictureImaging gdpictureImaging = new GdPictureImaging())
    {
        //The standard open file dialog displays to allow you to select the file.
        int image = gdpictureImaging.CreateGdPictureImageFromFile("input.tif");
        if ((gdpictureImaging.GetStat() == GdPictureStatus.OK) &&
            (gdpictureSegmenter.SetImage(image) == GdPictureStatus.OK))
        {
            //Set the segmentation mode.
            gdpictureSegmenter.SegmentationMode = SegmentationMode.ConnectedComponents4;
            //Run the segmentation process.
            string resultID = gdpictureSegmenter.RunSegmentation();
            if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
            {
                //Check the results.
                int characterCount = gdpictureSegmenter.GetCharacterCount(resultID);
                if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                {
                    string message = "The number of detected characters: ";
                    message = message + characterCount.ToString() + "\n";
                    int top = 0, left = 0, bottom = 0, right = 0, save = 0;
                    for (int i = 0; i < characterCount; i++)
                    {
                        top = gdpictureSegmenter.GetCharacterTop(resultID, i);
                        if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                            left = gdpictureSegmenter.GetCharacterLeft(resultID, i);
                        if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                            bottom = gdpictureSegmenter.GetCharacterBottom(resultID, i);
                        if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                            right = gdpictureSegmenter.GetCharacterRight(resultID, i);
                        if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                        {
                            if (gdpictureImaging.DrawRectangle(image, left, top, right - left, bottom - top, 5, Color.Brown, true) == GdPictureStatus.OK)
                            {
                                message = message + (i + 1).ToString() + ".rectangle has been drawn.\n";
                                save++;
                            }
                            else
                                message = message + (i + 1).ToString() + ".rectangle HAS NOT been drawn. Status: " + gdpictureSegmenter.GetStat().ToString() + "\n";
                        }
                        else
                            message = message + i.ToString() + ".word has failed to get its position. Status: " + gdpictureSegmenter.GetStat().ToString() + "\n";
                    }
                    if (characterCount == 0)
                    {
                        message = message + "The resulting image HAS NOT been created.";
                    }
                    else
                    {
                        if (save == characterCount)
                        {
                            if (gdpictureImaging.SaveAsTIFF(image, "output.tiff", TiffCompression.TiffCompressionAUTO) == GdPictureStatus.OK)
                                message = message + "The resulting image HAS been saved successfully.";
                            else
                                message = message + "The resulting image HAS NOT been saved. Status: " + gdpictureImaging.GetStat().ToString();
                        }
                    }
                    MessageBox.Show(message, caption);
                }
                else
                    MessageBox.Show("The GetCharacterCount() method has failed with the status: " + gdpictureSegmenter.GetStat().ToString(), caption);
            }
            else
                MessageBox.Show("The segmentation process has failed with the status: " + gdpictureSegmenter.GetStat().ToString(), caption);
            //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);
    }
    //Release resources.
    gdpictureSegmenter.ReleaseSegmentationResults();
}

Reference

GdPictureSegmenter Class
GdPictureSegmenter Members
GetCharacterCount Method
GetCharacterBottom Method
GetCharacterLeft Method
GetCharacterRight Method
RunSegmentation Method