Skip to content
This repository was archived by the owner on Mar 19, 2026. It is now read-only.

Commit 60eae9a

Browse files
authored
Update README.md
1 parent ceec91e commit 60eae9a

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,30 @@
11
# Flutter PixelMatching
22

3-
| Module to perform feature matching using OpenCV
4-
## Example
3+
> Module to perform feature matching using OpenCV
54
5+
An image comparison module written as an exercise in Flutter FFI and out of a need for that functionality. It is called PixelMatching, but it is actually a FeatureMatching module utilizing OpenCV. Isolate was utilized for asynchronous processing.
6+
For the internal functionality, it was written in C++.
7+
8+
The matching algorithm is using **FLannBasedMatcher**, and for the detector, **Andorid uses SIFT** **iOS uses KAZE**.
9+
10+
There is currently no method to change the algorithm, so if you want to change the algorithm and test it, please refer to `ios/Classes/src/ImageProcessor.cpp` and change it.
11+
```c++
12+
ImageProcessor::ImageProcessor() : stateCode(NotInitialized) {
13+
14+
compare.setMatchers(cv::DescriptorMatcher::create(DescriptorMatcher::MatcherType::FLANNBASED));
15+
#ifdef __ANDROID__
16+
compare.setDetector(cv::SIFT::create());
17+
#elif __APPLE__
18+
compare.setDetector(cv::KAZE::create());
19+
#endif
20+
}
21+
```
22+
23+
## Sample Application
24+
25+
This is a simple sample application. It is written just enough to make it simple to use.
26+
27+
![sample](https://user-images.githubusercontent.com/26740046/234154847-d3199f18-b262-45f1-8b9f-4153e11b5f80.png)
628
729
## How to install
830
1. Navigate to the root directory of your project.

0 commit comments

Comments
 (0)