Changelog plus tidy of code/docs for convolve operation

This commit is contained in:
Lovell Fuller
2016-07-04 22:13:47 +01:00
parent 4c172d25f6
commit a5d85b8a54
6 changed files with 37 additions and 33 deletions

View File

@@ -383,18 +383,27 @@ When a `sigma` is provided, performs a slower, more accurate Gaussian blur. This
#### convolve(kernel)
Convolve the image with the specified `kernel`. The kernel specification takes the following form:
Convolve the image with the specified `kernel`, an Object with the following attributes:
* `kernel = `
`{ 'width': N`
`, 'height': M`
`, 'scale': Z`
`, 'offset': Y`
`, 'kernel':`
` [ 1, 2, 3,`
` 4, 5, 6,`
` 7, 8, 9 ]`
`}`
* `width` is an integral Number representing the width of the kernel in pixels.
* `height` is an integral Number representing the width of the kernel in pixels.
* `kernel` is an Array of length `width*height` containing the kernel values.
* `scale`, if present, is a Number representing the scale of the kernel in pixels, defaulting to the sum of the kernel's values.
* `offset`, if present, is a Number representing the offset of the kernel in pixels, defaulting to 0.
```javascript
sharp(input)
.convolve({
width: 3,
height: 3,
kernel: [-1, 0, 1, -2, 0, 2, -1, 0, 1]
})
.raw()
.toBuffer(function(err, data, info) {
// data contains the raw pixel data representing the input image
// convolved with the horizontal Sobel operator
});
```
#### sharpen([sigma], [flat], [jagged])

View File

@@ -30,6 +30,10 @@ Requires libvips v8.3.1
[#456](https://github.com/lovell/sharp/pull/456)
[@kapouer](https://github.com/kapouer)
* Add convolve operation for kernel-based convolution.
[#479](https://github.com/lovell/sharp/pull/479)
[@mhirsch](https://github.com/mhirsch)
* Add greyscale option to threshold operation for colourspace conversion control.
[#480](https://github.com/lovell/sharp/pull/480)
[@mhirsch](https://github.com/mhirsch)