GetParagraphCount Method (GdPictureSegmenter)

In This Topic

Returns the number of paragraphs within the segmentation result specified by its index.

Syntax

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

'Declaration
 
Public Function GetParagraphCount( _
   ByVal SegmentationResultID As String _
) As Integer

public int GetParagraphCount( 
   string SegmentationResultID
)

public function GetParagraphCount( 
    SegmentationResultID: String
): Integer;

public function GetParagraphCount( 
   SegmentationResultID : String
) : int;

public: int GetParagraphCount( 
   string* SegmentationResultID
)

public:
int GetParagraphCount( 
   String^ SegmentationResultID
)

Parameters

SegmentationResultID: The unique result identifier of the executed segmentation process obtained by the RunSegmentation method.

Return Value

The number of detected paragraphs. 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 paragraphs within the segmentation result.

VB.NET
C#

Dim caption As String = "Example: GetParagraphCount"
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
                    MessageBox.Show("The number of detected paragraphs: " + paragraphCount.ToString(), caption)
                    'Continue ...
                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: GetParagraphCount";
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)
                {
                    MessageBox.Show("The number of detected paragraphs: " + paragraphCount.ToString(), caption);
                    //Continue ...
                }
                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
GetParagraphTextLineCount Method
GetParagraphFirstTextLineIndex Method
RunSegmentation Method