Skip to content

Commit 4fd09df

Browse files
committed
Update README.md
1 parent 3d74c02 commit 4fd09df

1 file changed

Lines changed: 49 additions & 3 deletions

File tree

examples/official/comparison_tool/README.md

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# Version Comparison Tool for Dynamsoft Python Barcode SDK
1+
# Multi-Modal Detection Comparison Tool for Dynamsoft Capture Vision SDK
22

3-
This comparison tool allows you to compare 1D/2D barcode detection performance between different versions of the Dynamsoft Capture Vision SDK. The tool provides a comprehensive graphical interface with side-by-side visual comparisons, detailed results analysis, and performance metrics.
3+
This comprehensive comparison tool allows you to compare detection performance between different versions of the Dynamsoft Capture Vision SDK across multiple detection modes. The tool provides an intuitive graphical interface with side-by-side visual comparisons, detailed results analysis, and performance metrics for **Barcode**, **MRZ (Machine Readable Zone)**, and **Document** detection.
44

55
https://github.com/user-attachments/assets/b69ab922-1cf4-4385-b61f-3988c1147296
66

77
## Features
88

9+
### 🎯 **Multi-Modal Detection Support**
10+
- **Barcode Detection**: 1D/2D barcodes with format identification and confidence scores
11+
- **MRZ Detection**: Machine Readable Zone text from passports and ID documents
12+
- **Document Detection**: Document boundary detection with edge visualization
13+
14+
915
### 🔍 **Dynamic SDK Configuration**
1016
- Configure and compare multiple SDK versions
1117
- Automatic SDK version detection from virtual environments
@@ -17,9 +23,22 @@ https://github.com/user-attachments/assets/b69ab922-1cf4-4385-b61f-3988c1147296
1723
- **Format Support**: PNG, JPG, JPEG, BMP, TIFF
1824
- **File Filtering**: Automatic validation of image file existence
1925
- **Progress Tracking**: Real-time processing progress indicators
26+
- **Mode-Based Clearing**: Automatic cleanup when switching detection modes
2027

2128
### 🖼️ **Visual Comparison Interface**
2229
- **Side-by-Side Views**: Compare detection results visually
30+
- **Dynamic Overlays**: Different visualization for each detection mode:
31+
- Barcode: Colored rectangles with text and format labels
32+
- MRZ: Text line highlighting and boundaries
33+
- Document: Edge contour visualization
34+
- **Real-time Updates**: Instant visual feedback as processing completes
35+
36+
### 📊 **Enhanced Results Analysis**
37+
- **Mode-Aware Metrics**: Performance comparison tailored to detection type
38+
- **Result Counting**: Accurate counts for barcodes, MRZ lines, or documents
39+
- **Processing Speed**: Timing comparisons between SDK versions
40+
- **Export Capabilities**: CSV export of comparison results
41+
- **Detailed Text Display**: Comprehensive result information with confidence scores and coordinates
2342

2443
## Installation
2544

@@ -48,10 +67,37 @@ D:/envs/sdk_v2/Scripts/activate
4867
pip install dynamsoft-capture-vision-bundle==3.0.6000
4968
```
5069

51-
## Usage
70+
## Quick Start
5271

72+
### Basic Usage
5373
```bash
5474
python sdk_comparison.py
5575
```
5676

77+
### Detection Modes
78+
79+
The tool supports three distinct detection modes, easily selectable via the dropdown menu:
80+
81+
#### 🏷️ **Barcode Mode**
82+
- Detects 1D and 2D barcodes (QR codes, Data Matrix, Code 128, etc.)
83+
- Displays barcode text, format, and confidence scores
84+
- Visual overlay shows detected barcode boundaries with colored rectangles
85+
86+
#### 📄 **MRZ Mode**
87+
- Detects Machine Readable Zone text from passports and ID documents
88+
- Extracts text lines from MRZ areas
89+
- Visual overlay highlights detected text regions
90+
91+
#### 📋 **Document Mode**
92+
- Detects document boundaries and edges
93+
- Useful for document scanning and preprocessing
94+
- Visual overlay shows detected document contours
95+
96+
### Workflow
97+
1. **Configure SDKs**: Click "🔧 Configure SDKs" to set up different SDK versions
98+
2. **Select Detection Mode**: Choose from Barcode, MRZ, or Document in the dropdown
99+
3. **Add Images**: Use "📁 Add Images" button or drag & drop images/folders
100+
4. **View Results**: Compare detection results side-by-side with visual overlays
101+
5. **Export Data**: Use "📤 Export to CSV" to save comparison results
102+
57103
![version comparison tool](https://www.dynamsoft.com/codepool/img/2025/09/python-sdk-comparison-tool.png)

0 commit comments

Comments
 (0)