Skip to content

Commit c3a4045

Browse files
EscapedGibbonstropitek
authored andcommitted
docs: minor fixes
1 parent a5160d0 commit c3a4045

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

docs/Features/Filters/Blur.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ This method only works with images.
88

99
Blur, also known as average blur or box blur, is a simple image processing technique used to reduce noise and smooth out images. It involves replacing the color value of a pixel with the average color value of its neighboring pixels within a specified window or kernel. This process effectively blurs the image and reduces high-frequency noise.
1010

11-
Box blur is particularly effective in reducing [salt-and-pepper](https://en.wikipedia.org/wiki/Salt-and-pepper_noise 'wikipedia link on salt and pepper noise') noise (random black and white pixels) and minor imperfections in an image. However, it also leads to loss of finer details, so the choice of [kernel](../../Glossary.md#kernel) size is important.
12-
1311
<BlurDemo />
1412

13+
Box blur is particularly effective in reducing [salt-and-pepper](https://en.wikipedia.org/wiki/Salt-and-pepper_noise 'wikipedia link on salt and pepper noise') noise (random black and white pixels) and minor imperfections in an image. However, it also leads to loss of finer details, so the choice of [kernel](../../Glossary.md#kernel) size is important.
14+
More advanced blurring techniques, such as [Gaussian blur](./gaussianBlur.md 'internal link to gaussian blur') or [bilateral filter](https://en.wikipedia.org/wiki/Bilateral_filter 'wikipedia link on bilateral filters'), are often used for better results in various applications.
15+
1516
### Parameters and default values
1617

1718
- `options`
@@ -26,8 +27,6 @@ Box blur is particularly effective in reducing [salt-and-pepper](https://en.wiki
2627
| [`borderValue`](https://image-js.github.io/image-js-typescript/interfaces/BlurOptions.html#borderValue) | no | `0` |
2728
| [`out`](https://image-js.github.io/image-js-typescript/interfaces/BlurOptions.html#out) | no | - |
2829

29-
More advanced blurring techniques, such as [Gaussian blur](./gaussianBlur.md 'internal link to gaussian blur') or [bilateral filter](https://en.wikipedia.org/wiki/Bilateral_filter 'wikipedia link on bilateral filters'), are often used for better results in various applications.
30-
3130
<details>
3231
<summary>
3332
<b>Implementation</b>

docs/Features/Filters/grayscale.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This method only works with images.
1010

1111
<GrayDemo />
1212

13+
The grayscale filter essentially eliminates the color information from the image and retains only the luminance or brightness values. This type of image is often used in situations where color is not essential for understanding or conveying the visual information. Grayscale images can emphasize the tonal contrast and structural details of a scene, making them particularly useful for tasks like analyzing textures, patterns, and lighting conditions.
14+
1315
### Parameters and default values
1416

1517
- `options`
@@ -57,8 +59,6 @@ This method only works with images.
5759

5860
- **`saturation`** : takes a fraction from difference of minimum and maximum components of a pixel.
5961

60-
The grayscale filter essentially eliminates the color information from the image and retains only the luminance or brightness values. This type of image is often used in situations where color is not essential for understanding or conveying the visual information. Grayscale images can emphasize the tonal contrast and structural details of a scene, making them particularly useful for tasks like analyzing textures, patterns, and lighting conditions.
61-
6262
<details>
6363
<summary>
6464
<b>Implementation</b>

docs/Features/Filters/subtract.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[Check options and parameters of subtract method](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')
1+
[Check options and parameters of subtract method](https://image-js.github.io/image-js-typescript/classes/Image.html#subtract 'github.io link')
22

33
Method called `subtract`, as the name suggests, takes another Image(or Mask) and makes a subtraction between each respective bit.
44
It works like this:
@@ -23,3 +23,9 @@ Both masks must have the same size for compatibility reasons. Images must have t
2323
- [`mask`](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')
2424

2525
- [`options`](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')
26+
27+
#### Options
28+
29+
| Property | Required | Default value |
30+
| ---------------------------------------------------------------------------------------------------------- | -------- | ------------- |
31+
| [`absolute`](https://image-js.github.io/image-js-typescript/interfaces/SubtractImageOptions.html#absolute) | no | `false` |

0 commit comments

Comments
 (0)