GetKeyValuePairKeyRect Method (GdPictureOCR)

In This Topic

Returns the location of the key part of a specified key-value pair.

Syntax

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

'Declaration
 
Public Function GetKeyValuePairKeyRect( _
   ByVal OCRResultID As String, _
   ByVal PairIdx As Integer, _
   ByRef Left As Integer, _
   ByRef Top As Integer, _
   ByRef Width As Integer, _
   ByRef Height As Integer _
) As GdPictureStatus

public GdPictureStatus GetKeyValuePairKeyRect( 
   string OCRResultID,
   int PairIdx,
   out int Left,
   out int Top,
   out int Width,
   out int Height
)

public function GetKeyValuePairKeyRect( 
    OCRResultID: String;
    PairIdx: Integer;
   Out  Left: Integer;
   Out  Top: Integer;
   Out  Width: Integer;
   Out  Height: Integer
): GdPictureStatus;

public function GetKeyValuePairKeyRect( 
   OCRResultID : String,
   PairIdx : int,
   Left : int,
   Top : int,
   Width : int,
   Height : int
) : GdPictureStatus;

public: GdPictureStatus GetKeyValuePairKeyRect( 
   string* OCRResultID,
   int PairIdx,
   [PARAMFLAG::Out] int Left,
   [PARAMFLAG::Out] int Top,
   [PARAMFLAG::Out] int Width,
   [PARAMFLAG::Out] int Height
)

public:
GdPictureStatus GetKeyValuePairKeyRect( 
   String^ OCRResultID,
   int PairIdx,
   [Out] int Left,
   [Out] int Top,
   [Out] int Width,
   [Out] int Height
)

Parameters

OCRResultID: The unique result identifier of the executed OCR process obtained by the RunOCR method.
PairIdx: The 0-based index of the key-value pair within the specified OCR result. It must be a value between 0 and GetKeyValuePairCount(OCRResultID) - 1.
Left: Returns the left x-coordinate of the key's bounding box, in pixels.
Top: Returns the top y-coordinate of the key's bounding box, in pixels.
Width: Returns the width of the key's bounding box, in pixels.
Height: Returns the width of the key's bounding box, in pixels.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method requires the KVP and Table Processing - Intelligent Redaction component to run.

Example

Extracting key-value pairs from an image.

string caption = "Example: KVP/OCR";
using (GdPictureOCR gdpictureOCR = new GdPictureOCR())
{
    //Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\\GdPicture.Net 14\\redist\\OCR";
    gdpictureOCR.EnableSkewDetection = true;
    if (gdpictureOCR.AddLanguage(OCRLanguage.English) == GdPictureStatus.OK)
    {
        //Set up the image you want to process.
        GdPictureImaging gdpictureImaging = new GdPictureImaging();
        //The standard open file dialog displays to allow you to select the file.
        int image = gdpictureImaging.CreateGdPictureImageFromFile("");
 
         gdpictureOCR.SetImage(image);
 
         string ocrResultID = gdpictureOCR.RunOCR();
 
         if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
         {
             string keyValuePairsData = "";
 
             for (int pairIdx = 0; pairIdx < gdpictureOCR.GetKeyValuePairCount(ocrResultID); pairIdx++)
             {
                 if (pairIdx != 0)
                 {
                      keyValuePairsData += "\n";
                 }
                 keyValuePairsData += "Name: "     + gdpictureOCR.GetKeyValuePairKeyString(ocrResultID, pairIdx) + " | " +
                                      "Value: "    + gdpictureOCR.GetKeyValuePairValueString(ocrResultID, pairIdx) + " | " +
                                      "Type: "     + gdpictureOCR.GetKeyValuePairDataType(ocrResultID, pairIdx).ToString() + " | " +
                                      "Accuracy: " + Math.Round(gdpictureOCR.GetKeyValuePairConfidence(ocrResultID, pairIdx), 1).ToString() + "%";
             }
             MessageBox.Show(keyValuePairsData, caption);
            }
            else
            {
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
            //Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image);
    }
    else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
    gdpictureOCR.ReleaseOCRResults();
}

Reference

GdPictureOCR Class
GdPictureOCR Members
GetKeyValuePairCount()