wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-07-05 11:09:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix and improve doc string

Browse Source
This commit is contained in:
Johannes Schönberger
2013-12-11 06:46:42 +01:00
parent c1b2d5159d
commit 7b098ce35d
1 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/feature/template.py
+15 -14
View File
@@ -34,21 +34,24 @@ def match_template(image, template, pad_input=False, mode='constant',
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.
and the template.
For `pad_input=True` matches correspond to the center and otherwise to the
top-left corner of the template. To find the best match you must search for
peaks in the response (output) image.
Parameters
----------
image : (N, M[, D]) array
image : (M, N[, D]) array
2-D or 3-D input image.
template : (N, M[, D]) array
Template to locate.
template : (m, n[, d]) array
Template to locate. It must be `(m <= M, n <= N[, d <= D])`.
pad_input : bool
If True, pad `image` with image mean so that output is the same size as
the image, and output values correspond to the template center.
Otherwise, the output is an array with shape `(M - m + 1, N - n + 1)`
for an `(M, N)` image and an `(m, n)` template, and matches correspond
to origin (top-left corner) of the template.
If True, pad `image` so that output is the same size as the image, and
output values correspond to the template center. Otherwise, the output
is an array with shape `(M - m + 1, N - n + 1)` for an `(M, N)` image
and an `(m, n)` template, and matches correspond to origin
(top-left corner) of the template.
mode : see `numpy.pad`, optional
Padding mode.
constant_values : see `numpy.pad`, optional
@@ -56,10 +59,8 @@ def match_template(image, template, pad_input=False, mode='constant',
Returns
-------
output : ndarray
Correlation results between -1.0 and 1.0. For an `(M, N)` image and an
`(m, n)` template, the `output` is `(M - m + 1, N - n + 1)` when
`pad_input = False` and `(M, N)` when `pad_input = True`.
output : array
Response image with correlation coefficients.
References
----------