Docs: changelog and refresh for #3583

This commit is contained in:
Lovell Fuller 2023-03-21 10:16:31 +00:00
parent d7776e3b98
commit cd419a261b
4 changed files with 36 additions and 10 deletions

View File

@ -312,17 +312,32 @@ const output = await sharp(input)
## normalise
Enhance output image contrast by stretching its luminance to cover the full dynamic range.
Enhance output image contrast by stretching its luminance to cover a full dynamic range.
Uses a histogram-based approach, taking a default range of 1% to 99% to reduce sensitivity to noise at the extremes.
Luminance values below the `lower` percentile will be underexposed by clipping to zero.
Luminance values above the `upper` percentile will be overexposed by clipping to the max pixel value.
| Param | Type | Default |
| --- | --- | --- |
| [normalise] | <code>Boolean</code> | <code>true</code> |
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.lower] | <code>number</code> | <code>1</code> | Percentile below which luminance values will be underexposed. |
| [options.upper] | <code>number</code> | <code>99</code> | Percentile above which luminance values will be overexposed. |
**Example**
```js
const output = await sharp(input).normalise().toBuffer();
const output = await sharp(input)
.normalise()
.toBuffer();
```
**Example**
```js
const output = await sharp(input)
.normalise({ lower: 0, upper: 100 })
.toBuffer();
```
@ -331,13 +346,17 @@ Alternative spelling of normalise.
| Param | Type | Default |
| --- | --- | --- |
| [normalize] | <code>Boolean</code> | <code>true</code> |
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | <code>Object</code> | | |
| [options.lower] | <code>number</code> | <code>1</code> | Percentile below which luminance values will be underexposed. |
| [options.upper] | <code>number</code> | <code>99</code> | Percentile above which luminance values will be overexposed. |
**Example**
```js
const output = await sharp(input).normalize().toBuffer();
const output = await sharp(input)
.normalize()
.toBuffer();
```

View File

@ -56,6 +56,10 @@ Requires libvips v8.14.0
* Ensure all async JS callbacks are wrapped to help avoid possible race condition.
[#3569](https://github.com/lovell/sharp/issues/3569)
* Add support to `normalise` for `lower` and `upper` percentiles.
[#3583](https://github.com/lovell/sharp/pull/3583)
[@LachlanNewman](https://github.com/LachlanNewman)
## v0.31 - *eagle*
Requires libvips v8.13.3

View File

@ -269,3 +269,6 @@ GitHub: https://github.com/ejoebstl
Name: Tomasz Janowski
GitHub: https://github.com/janaz
Name: Lachlan Newman
GitHub: https://github.com/LachlanNewman

File diff suppressed because one or more lines are too long