Document order of kernel weights

This commit is contained in:
Andrew Murray 2023-06-09 10:47:20 +10:00
parent e3cca42980
commit da6b2ec285

View File

@ -35,7 +35,7 @@ class BuiltinFilter(MultibandFilter):
class Kernel(BuiltinFilter):
"""
Create a convolution kernel. The current version only
Create a convolution kernel. The current version only
supports 3x3 and 5x5 integer and floating point kernels.
In the current version, kernels can only be applied to
@ -43,9 +43,10 @@ class Kernel(BuiltinFilter):
:param size: Kernel size, given as (width, height). In the current
version, this must be (3,3) or (5,5).
:param kernel: A sequence containing kernel weights.
:param kernel: A sequence containing kernel weights. The kernel will
be flipped vertically before being applied to the image.
:param scale: Scale factor. If given, the result for each pixel is
divided by this value. The default is the sum of the
divided by this value. The default is the sum of the
kernel weights.
:param offset: Offset. If given, this value is added to the result,
after it has been divided by the scale factor.