From 0c81e14bfae2004f7bc517c4f3e05e389c1bdeb0 Mon Sep 17 00:00:00 2001 From: Raphael Ackermann Date: Sun, 1 Dec 2013 23:11:33 +0100 Subject: [PATCH] changing docstring to make clear that only 2-D images are currently supported --- skimage/feature/template.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/skimage/feature/template.py b/skimage/feature/template.py index 5cb4d382..e8f17512 100644 --- a/skimage/feature/template.py +++ b/skimage/feature/template.py @@ -5,7 +5,7 @@ from . import _template def match_template(image, template, pad_input=False): - """Match a template to an image using normalized correlation. + """Match a template to a 2-D image using normalized correlation. The output is an array with values between -1.0 and 1.0, which correspond to the probability that the template is found at that position. @@ -13,7 +13,7 @@ def match_template(image, template, pad_input=False): Parameters ---------- image : array_like - Image to process. + 2-D Image to process. template : array_like Template to locate. pad_input : bool