GetParagraphFirstTextLineIndex Method (GdPictureSegmenter)

In This Topic

Returns the index of the first text line in the specified paragraph, 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 GetParagraphFirstTextLineIndex( _
   ByVal SegmentationResultID As String, _
   ByVal ParagraphIdx As Integer _
) As Integer

public int GetParagraphFirstTextLineIndex( 
   string SegmentationResultID,
   int ParagraphIdx
)

public function GetParagraphFirstTextLineIndex( 
    SegmentationResultID: String;
    ParagraphIdx: Integer
): Integer;

public function GetParagraphFirstTextLineIndex( 
   SegmentationResultID : String,
   ParagraphIdx : int
) : int;

public: int GetParagraphFirstTextLineIndex( 
   string* SegmentationResultID,
   int ParagraphIdx
)

public:
int GetParagraphFirstTextLineIndex( 
   String^ SegmentationResultID,
   int ParagraphIdx
)

Parameters

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

Return Value

The index of the first text line in the specified paragraph. Please always use the GetStat method to determine if this method has beensuccessful.

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 text lines within the paragraph and the index of the first text line.

VB.NET
C#

Dim caption As String = "Example: GetParagraphFirstTextLineIndex"
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 paragraphCount As Integer = gdpictureSegmenter.GetParagraphCount(resultID)
                If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                    Dim textlineCount As Integer = 0, index As Integer = 0
                    For i As Integer = 0 To paragraphCount - 1
                        textlineCount = gdpictureSegmenter.GetParagraphTextLineCount(resultID, i)
                        If gdpictureSegmenter.GetStat() = GdPictureStatus.OK Then
                            index = gdpictureSegmenter.GetParagraphFirstTextLineIndex(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 GetParagraphCount() 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: GetParagraphFirstTextLineIndex";
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 paragraphCount = gdpictureSegmenter.GetParagraphCount(resultID);
                if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                {
                    int textlineCount = 0, index = 0;
                    for (int i = 0; i < paragraphCount; i++)
                    {
                        textlineCount = gdpictureSegmenter.GetParagraphTextLineCount(resultID, i);
                        if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                        {
                            index = gdpictureSegmenter.GetParagraphFirstTextLineIndex(resultID, i);
                            if (gdpictureSegmenter.GetStat() == GdPictureStatus.OK)
                            {
                                //Continue ...
                            }
                            //else handle the error
                        }
                        //else handle the error
                    }
                }
                else
                    MessageBox.Show("The GetParagraphCount() 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
GetParagraphCount Method
GetParagraphTextLineCount Method
RunSegmentation Method