Skip to content

Commit 74660d3

Browse files
author
Laurent Thomas
committed
few comments README + update date for release 1.6.4
1 parent 0eb619c commit 74660d3

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ All notable changes to this project will be documented in this file.
33

44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
55

6-
### [1.6.4] - 2023-01-19
6+
### [1.6.4] - 2023-03-03
77

88
### Changed
99
- Improve speed by adding concurrency in the findMatches method, using half the number of cpu cores available.
10+
- Mention installation in editable mode in README
1011

1112
### [1.6.3] - 2021-11-24
1213

MTM/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ def _multi_compute(tempTuple, image, method, N_object, score_threshold, xOffset,
222222

223223
for peak in peaks :
224224
# append to list of potential hit before Non maxima suppression
225+
# no need to lock the list, append is thread-safe
225226
listHit.append({'TemplateName':templateName, 'BBox': ( int(peak[1])+xOffset, int(peak[0])+yOffset, width, height ) , 'Score':corrMap[tuple(peak)]}) # empty df with correct column header
226227

227228

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,23 @@ The main function `MTM.matchTemplates` returns the best predicted locations prov
88

99
The branch opencl contains some test using the UMat object to run on GPU, but it is actually slow, which can be expected for small dataset as the transfer of the data between the CPU and GPU is slow.
1010

11-
__** News **__ : You might be interested to test the newer python implementation which is more object-oriented and only relying on scikit-image and shapely.*
11+
# News
12+
- 03/03/2023 : Version 1.6.4 contributed by @bartleboeuf comes with speed enhancement thanks to parallelizing of the individual template searches.
13+
Thanks for this first PR !!
14+
- 10/11/2021 : You might be interested to test the newer python implementation which is more object-oriented and only relying on scikit-image and shapely.*
1215
https://github.com/multi-template-matching/mtm-python-oop
1316

1417
# Installation
1518
Using pip in a python environment, `pip install Multi-Template-Matching`
1619
Once installed, `import MTM`should work.
1720
Example jupyter notebooks can be downloaded from the tutorial folder of the github repository and executed in the newly configured python environement.
1821

22+
## Install in dev mode
23+
If you want to contribute or experiment with the source code, you can install the package "from source", by first downloading or cloning the repo.
24+
Then opening a command prompt in the repo's root directory (the one containing this README) and calling `pip install -e .` (mind the final dot).
25+
- the `-e` flag stands for editable and make sure that any change to the source code will be directly reflected when you import the package in your script
26+
- the . just tell pip to look for the package to install in the current directory
27+
1928
# Documentation
2029
The [wiki](https://github.com/multi-template-matching/MultiTemplateMatching-Python/wiki) section of the repo contains a mini API documentation with description of the key functions of the package.
2130
The [website](https://multi-template-matching.github.io/Multi-Template-Matching/) of the project contains some more general documentation.

0 commit comments

Comments
 (0)