Recognize(String,String,String,OcrDocumentFormatType) Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

[OperationContractAttribute(Name="RecognizeImage", Action="RecognizeImage")]
[WebGetAttribute()]
[FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault, 
   Action="", 
   Name="", 
   Namespace="", 
   ProtectionLevel=ProtectionLevel.None, 
   HasProtectionLevel=false)]
Stream Recognize( 
   string uri,
   string username,
   string password,
   OcrDocumentFormatType format
)

'Declaration
 
<OperationContractAttribute(Name="RecognizeImage", Action="RecognizeImage")>
<WebGetAttribute()>
<FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault, 
   Action="", 
   Name="", 
   Namespace="", 
   ProtectionLevel=ProtectionLevel.None, 
   HasProtectionLevel=False)>
Overloads Function Recognize( _
   ByVal uri As String, _
   ByVal username As String, _
   ByVal password As String, _
   ByVal format As OcrDocumentFormatType _
) As Stream

'Usage
 
Dim instance As IOcrService
Dim uri As String
Dim username As String
Dim password As String
Dim format As OcrDocumentFormatType
Dim value As Stream
 
value = instance.Recognize(uri, username, password, format)

[OperationContractAttribute(Name="RecognizeImage", Action="RecognizeImage")]
[WebGetAttribute()]
[FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault, 
   Action="", 
   Name="", 
   Namespace="", 
   ProtectionLevel=ProtectionLevel.None, 
   HasProtectionLevel=false)]
Stream Recognize( 
   string uri,
   string username,
   string password,
   OcrDocumentFormatType format
)

OperationContractAttribute(Name="RecognizeImage", Action="RecognizeImage")
WebGetAttribute()
FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault, 
   Action="", 
   Name="", 
   Namespace="", 
   ProtectionLevel=ProtectionLevel.None, 
   HasProtectionLevel=)
function Leadtools.Services.Forms.ServiceContracts.IOcrService.Recognize(String,String,String,OcrDocumentFormatType)( 
   uri ,
   username ,
   password ,
   format 
)

[OperationContractAttribute(Name="RecognizeImage", Action="RecognizeImage")]
[WebGetAttribute()]
[FaultContractAttribute(DetailType=Leadtools.Services.Raster.FaultContracts.RasterFault, 
   Action="", 
   Name="", 
   Namespace="", 
   ProtectionLevel=ProtectionLevel.None, 
   HasProtectionLevel=false)]
Stream^ Recognize( 
   String^ uri,
   String^ username,
   String^ password,
   OcrDocumentFormatType format
)

Parameters

uri: The URI of image.
username: The username who has privileges on the the specified URI. Must be passed as (domain/username).
password: The password for the specified user.
format: The output document format.

Return Value

A stream that contains the document data.

This method is designed to be used as a WebGet method, so you can access this method using a browser. For example, you can pass the following query string to IE.

"http://Localhost/LeadtoolsServicesHost/OcrService.svc/recognizeimage?uri=\\computername\Ocr1.tif&format=AsciiText&engineType=plus".

This method is supported when hosting is performed using WebHttpBinding.

The LEADTOOLS OCR engines provide support for recognizing document zones in separate threads. This can improve the performance of the recognition process. Control the number of threads through Leadtools.Services.Forms.ServiceImplementations.dll.config by setting the value for MaximumRecognitionThreads to one of the following:

A value of 0 (zero) instructs LEADTOOLS to use the maximum number of threads equal to the number of cores available in the current machine.
A value of 1, 2, 3, 4, etc. instructs LEADTOOLS to use that maximum number of threads equal to that number.
A value of 1 instructs LEADTOOLS not to use multi-threading
Leave the value of this property at the default value of 1 in WCF applications.

Also, LEADTOOLS OCR engines provide support for auto-zoning in separate threads. This can improve the performance of the recognition process. Disable and enable this option through Leadtools.Services.Forms.ServiceImplementations.dll.config by setting the value for EnableMultiThreadingZoning to one of the following:

use multi-threading when performing auto-zoning
don't use multi-threading when performing auto-zoning
Leave the value of this property to the default of false in WCF applications.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub RecognizeImageExample()
      Dim buffer As Byte() = New Byte(1024 * 64 - 1) {}
      Dim totalBytesRead As Integer = 0
      Dim memoryStream As MemoryStream = New MemoryStream()
      Dim client As OcrServiceClient = New OcrServiceClient()

      Dim stream As Stream = client.RecognizeImage("http://sp2007ep/Ocr/Shared%20Documents/OCR.TIF", "username", "password", OcrDocumentFormatType.TextAnsi)

      Dim bytesRead As Integer
      'TODO: INSTANT VB TODO TASK: Assignments within expressions are not supported in VB.NET
      'ORIGINAL LINE: while ((bytesRead = stream.Read(buffer, 0, buffer.Length)) > 0)
      Do While (bytesRead = stream.Read(buffer, 0, buffer.Length)) > 0
         totalBytesRead += bytesRead
         memoryStream.Write(buffer, 0, bytesRead)
      Loop

      File.WriteAllBytes(Path.Combine(LEAD_VARS.ImagesDir, "ocr.txt"), memoryStream.ToArray())

      client.Close()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void RecognizeImageExample()
   {
      byte[] buffer = new byte[1024 * 64];
      int totalBytesRead = 0;
      MemoryStream memoryStream = new MemoryStream();
      OcrServiceClient client = new OcrServiceClient();

      Stream stream = client.RecognizeImage(@"http://sp2007ep/Ocr/Shared%20Documents/OCR.TIF", "username", "password", OcrDocumentFormatType.TextAnsi);

      int bytesRead;
      while ((bytesRead = stream.Read(buffer, 0, buffer.Length)) > 0)
      {
         totalBytesRead += bytesRead;
         memoryStream.Write(buffer, 0, bytesRead);
      }

      File.WriteAllBytes(Path.Combine(LEAD_VARS.ImagesDir,"ocr.txt"), memoryStream.ToArray());

      client.Close();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IOcrService Interface
IOcrService Members
Overload List