GetWordFirstCharacterIndex Method (GdPictureSegmenter)

In This Topic

Returns the index of the first character in the specified word, that is a part of the segmentation result specified by its index.

Syntax

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

'Declaration
 
Public Function GetWordFirstCharacterIndex( _
   ByVal SegmentationResultID As String, _
   ByVal WordIdx As Integer _
) As Integer

public int GetWordFirstCharacterIndex( 
   string SegmentationResultID,
   int WordIdx
)

public function GetWordFirstCharacterIndex( 
    SegmentationResultID: String;
    WordIdx: Integer
): Integer;

public function GetWordFirstCharacterIndex( 
   SegmentationResultID : String,
   WordIdx : int
) : int;

public: int GetWordFirstCharacterIndex( 
   string* SegmentationResultID,
   int WordIdx
)

public:
int GetWordFirstCharacterIndex( 
   String^ SegmentationResultID,
   int WordIdx
)

Parameters

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

Return Value

The index of the first character of the specified word. Please always use the GetStat method to determine if this method has been successful.

Remarks

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

Example

How to find out the number of detected characters within the word and the index of the first character.

VB.NET
C#

Dim caption As String = "Example: GetWordFirstCharacterIndex"
Using gdpictureSegmenter As GdPictureSegmenter = New GdPictureSegmenter()
    'Set up the image you want to process.
    Using gdpictureImaging As GdPictureImaging = New GdPictureImaging()
        'The standard open file dialog displays to allow you to select the file.
        Dim image As Integer = gdpictureImaging.CreateGdPictureImageFromFile("")
        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 characterCount As Integer = 0, index As Integer = 0
                    For i As Integer = 0 To wordCount - 1
                        characterCount = gdpictureSegmenter.GetWordCharacterCount(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                            index = gdpictureSegmenter.GetWordFirstCharacterIndex(resultID, i)
                            If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                                'Continue ...
                            Else
                                'handle the error
                            End If
                        Else
                            'handle the error
                        End If
                    Next
                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

string caption = "Example: GetWordFirstCharacterIndex";
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("");
        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 wordCount = gdpictureSegmenter.GetWordCount(resultID);
                if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                {
                    int characterCount = 0, index = 0;
                    for (int i = 0; i < wordCount; i++)
                    {
                        characterCount = gdpictureSegmenter.GetWordCharacterCount(resultID, i);
                        if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                        {
                            index = gdpictureSegmenter.GetWordFirstCharacterIndex(resultID, i);
                            if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                            {
                                //Continue ...
                            }
                            //else handle the error
                        }
                        //else handle the error
                    }
                }
                else
                    MessageBox.Show("The GetWordCount() 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
GetWordCount Method
GetCharacterCount Method
RunSegmentation Method