Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yushulx/dotnet-document-scanner-sdk
https://github.com/yushulx/dotnet-document-scanner-sdk
document-detection document-rectification
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yushulx/dotnet-document-scanner-sdk
- Owner: yushulx
- License: mit
- Created: 2022-09-19T03:11:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T06:28:38.000Z (4 months ago)
- Last Synced: 2024-09-24T06:47:59.308Z (4 months ago)
- Topics: document-detection, document-rectification
- Language: C#
- Homepage: https://www.nuget.org/packages/DocumentScannerSDK
- Size: 38 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# .NET Document Scanner SDK
The .NET Document Scanner SDK is a C# wrapper for [Dynamsoft Document Normalizer SDK](https://www.dynamsoft.com/document-normalizer/docs/core/introduction/). It is used to do document edge detection, image cropping, perspective correction and image enhancement.
## License Activation
Click [here](https://www.dynamsoft.com/customer/license/trialLicense/?product=dcv&package=cross-platform) to get a 30-day trial license key.
## Supported Platforms
- Windows (x64)
- Linux (x64)
- Android
- iOS
## API
- `public static void InitLicense(string license)`: Initialize the license key. It must be called before creating the document scanner object.
- `public static DocumentScanner Create()`: Create the document scanner object.
- `public Result[]? DetectFile(string filename)`: Detect documents from an image file.
- `public Result[]? DetectBuffer(byte[] buffer, int width, int height, int stride, ImagePixelFormat format)`: Detect documents from a buffer.
- `public NormalizedImage NormalizeFile(string filename, int[] points)`: Normalize the detected documents from an image file.
- `public NormalizedImage NormalizeBuffer(byte[] buffer, int width, int height, int stride, ImagePixelFormat format, int[] points)`: Normalize the detected documents from a buffer.
- `public static string? GetVersionInfo()`: Get SDK version number.
- `public void SetParameters(string parameters)`: Customize the parameters. Refer to [Parameter Organization](https://www.dynamsoft.com/document-normalizer/docs/core/parameters/parameter-organization-structure.html) for more details.
## Usage
- Set the license key:
```csharp
DocumentScanner.InitLicense("LICENSE-KEY");
```
- Initialize the document scanner object:
```csharp
DocumentScanner scanner = DocumentScanner.Create();
```
- Detect documents from an image file:
```csharp
Result[]? resultArray = scanner.DetectFile(filename);
```
- Detect documents from a buffer:
```csharp
Result[]? resultArray = scanner.DetectBuffer(bytes, width, height, stride, DocumentScanner.ImagePixelFormat.IPF_RGB_888);
```
- Normalize the detected documents from an image file:
```csharp
if (resultArray != null)
{
foreach (Result result in resultArray)
{
if (result.Points != null)
{
NormalizedImage image = scanner.NormalizeFile(filename, result.Points);
if (image != null)
{
image.Save(DateTime.Now.ToFileTimeUtc() + ".png");
}
}
}
}
```
- Normalize the detected documents from a buffer:
```csharp
if (resultArray != null)
{
foreach (DocumentScanner.Result result in resultArray)
{
if (result.Points != null)
{
int length = mat.Cols * mat.Rows * mat.ElemSize();
byte[] bytes = new byte[length];
Marshal.Copy(mat.Data, bytes, 0, length);
DocumentScanner.NormalizedImage image = scanner.NormalizeBuffer(bytes, mat.Cols, mat.Rows, (int)mat.Step(), DocumentScanner.ImagePixelFormat.IPF_RGB_888, result.Points);
if (image != null && image.Data != null)
{
image.Save(DateTime.Now.ToFileTimeUtc() + ".png");
}
}
}
}
```
- Get SDK version number:
```csharp
string? version = DocumentScanner.GetVersionInfo();
```
- Customize the parameters:
```csharp
// Refer to https://www.dynamsoft.com/document-normalizer/docs/parameters/parameter-organization-structure.html?ver=latest
scanner.SetParameters(DocumentScanner.Templates.color);
```
## Quick Start
```csharp
using System;
using System.Runtime.InteropServices;
using Dynamsoft;
namespace Test
{
class Program
{
static void Main(string[] args)
{
DocumentScanner.InitLicense("LICENSE-KEY"); // Get a license key from https://www.dynamsoft.com/customer/license/trialLicense?product=ddn
DocumentScanner? scanner = null;
try {
scanner = DocumentScanner.Create();
scanner.SetParameters(DocumentScanner.Templates.color);
Console.WriteLine("Please enter an image file: ");
string? filename = Console.ReadLine();
if (filename != null) {
Result[]? resultArray = scanner.DetectFile(filename);
if (resultArray != null)
{
foreach (DocumentScanner.Result result in resultArray)
{
Console.WriteLine("Confidence: " + result.Confidence);
if (result.Points != null)
{
foreach (int point in result.Points)
{
Console.WriteLine("Point: " + point);
}
DocumentScanner.NormalizedImage image = scanner.NormalizeFile("1.png", result.Points);
if (image != null)
{
image.Save(DateTime.Now.ToFileTimeUtc() + ".png");
}
}
}
}
else {
Console.WriteLine("No document detected.");
}
}
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
}
}
```
## Example
- [Command-line Document Scanner](https://github.com/yushulx/dotnet-document-scanner-sdk/tree/main/example/command-line) (**Windows & Linux**)
```bash
dotnet run
```
- [Command-line Document Scanner with OpenCVSharp Windows runtime](https://github.com/yushulx/dotnet-document-scanner-sdk/tree/main/example/command-line-cv). To make it work on Linux, you need to install [OpenCVSharp4.runtime.ubuntu.18.04-x64](https://www.nuget.org/packages/OpenCvSharp4.runtime.ubuntu.18.04-x64) package.
```bash
dotnet run
```
- [WinForms Desktop Document Scanner](https://github.com/yushulx/dotnet-document-scanner-sdk/tree/main/example/desktop-gui) (**Windows Only**)
```bash
dotnet run
```
- [.NET MAUI](https://github.com/yushulx/dotnet-document-scanner-sdk/tree/main/example/MauiApp)
## Building NuGet Package from Source Code
```bash
# build dll for desktop
cd desktop
dotnet build --configuration Release
# build dll for android
cd android
dotnet build --configuration Release
# build dll for iOS
cd ios
dotnet build --configuration Release
# build nuget package
nuget pack .\DocumentScannerSDK.nuspec
```