GOMODULES
/
images4
mirror of https://github.com/vitali-fedulov/images4
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

text update

pull/3/head v1.2.0
Vitali Fedulov 2023-04-21 23:06:22 +02:00
parent 29ed7bcd63
commit 3ab82bae8c
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -21,13 +21,15 @@ Release note (v4): simplified func `Icon`; more than 2x reduction of icon memory
- `Similar` gives a verdict whether 2 images are similar with well-tested default thresholds. To see the thresholds use `DefaultThresholds`. Rotations and mirrors are not taken in account.
- `Similar90270` is like `Similar`, but in addition compares to images rotated ±90°. This function is a superset of `Similar`, so you can simply use it instead.
- `Similar90270` is like above, but in addition compares to images rotated ±90°. This function is a superset of `Similar`, so you can simply use it instead.
- `EucMetric` can be used instead of `Similar` when you need different precision or want to sort by similarity. Func `PropMetric` can be used for customization of image proportion threshold. Both functions compare non-rotated images (as `Similar` does).
- `EucMetric` can be used instead of `Similar` when you need different precision or want to sort by similarity.
- `PropMetric` allows customization of image proportion threshold.
- `DefaultThresholds` prints default thresholds used in func `Similar` and `Similar90270`, as a starting point for selecting thresholds on `EucMetric` and `PropMetric`.
- `Rotate90` turns an icon 90° clockwise. This is useful for developing custom similarity function for rotated images with `EucMetric` and `PropMetric`. Or if you compare to images rotated 180° (by applying `Rotate90` twice).
- `Rotate90` turns an icon 90° clockwise. This is useful for developing custom similarity function for rotated images with `EucMetric` and `PropMetric`. With the function you can also compare to images rotated 180° (by applying `Rotate90` twice).
[Go doc](https://pkg.go.dev/github.com/vitali-fedulov/images4) for code reference.