From 598ee3f9ec652a64059af3f6f68296e52952c3aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Tue, 10 Dec 2013 09:19:17 +0100 Subject: [PATCH] Improve description of match_template --- skimage/feature/template.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/skimage/feature/template.py b/skimage/feature/template.py index 7e289711..020bf8f1 100644 --- a/skimage/feature/template.py +++ b/skimage/feature/template.py @@ -32,8 +32,10 @@ def match_template(image, template, pad_input=False, mode='constant', constant_values=0): """Match a template to a 2-D or 3-D image using normalized correlation. - The output is an array with values between -1.0 and 1.0, which correspond - to the correlation coefficient that the template is found at the position. + The output is an array with values between -1.0 and 1.0. The value at a + given position corresponds to the correlation coefficient between the image + and the template. The template is centered around each position. To find + the best match you must search for peaks in the response image. Parameters ----------