Skip to content

Commit 5838a14

Browse files
docs: add checkProcessable tables (#95)
1 parent 4515b03 commit 5838a14

29 files changed

+234
-2
lines changed

docs/Features/Comparison/Addition.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ mask = mask.add(mask2);
2424
Images must have the same size, channel number and bit depth for compatibility reasons.
2525
:::
2626

27+
### Kinds of images compatible with algorithm
28+
29+
| Image property | What it means | Possible values |
30+
| -------------- | -------------------------- | --------------- |
31+
| `bitDepth` | number of bits per channel | `[8,16]` |
32+
| `components` | number of components | any |
33+
| `alpha` | is alpha channel allowed | `false` |
34+
2735
### Parameters and default values
2836

2937
- [`otherImage`](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')

docs/Features/Comparison/Hypotenuse.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ $$
1414

1515
Where $$Value1$$ is a value of the pixel in the first image and $$Value2$$ is the value of the second one. The goal is to identify which points in one image correspond to points in another image, which is essential for various computer vision and image processing applications. Calculating hypotenuse value between two pixels is also necessary for image aligning and feature matching.
1616

17+
### Kinds of images compatible with algorithm
18+
19+
| Image property | What it means | Possible values |
20+
| -------------- | -------------------------- | --------------- |
21+
| `bitDepth` | number of bits per channel | `[8,16]` |
22+
| `components` | number of components | any |
23+
| `alpha` | is alpha channel allowed | `true` |
24+
1725
### Parameters and default values
1826

1927
- `otherImage`

docs/Features/Comparison/Subtraction.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ mask = mask.subtract(mask2);
2525
Both masks must have the same size for compatibility reasons. Images must have the same size, channel number and bit depth.
2626
:::
2727

28+
### Kinds of images compatible with algorithm
29+
30+
| Image property | What it means | Possible values |
31+
| -------------- | -------------------------- | --------------- |
32+
| `bitDepth` | number of bits per channel | `[1,8,16]` |
33+
| `components` | number of components | any |
34+
| `alpha` | is alpha channel allowed | `false` |
35+
2836
### Parameters and default values
2937

3038
:::info

docs/Features/Filters/Blur.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ Blur, also known as average blur or box blur, is a simple image processing techn
1515
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.
1616
More advanced blurring techniques, such as [Gaussian blur](./Gaussian%20Blur.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.
1717

18+
### Kinds of images compatible with algorithm
19+
20+
| Image property | What it means | Possible values |
21+
| -------------- | -------------------------- | --------------- |
22+
| `bitDepth` | number of bits per channel | `[8,16]` |
23+
| `components` | number of components | any |
24+
| `alpha` | is alpha channel allowed | `true` |
25+
1826
### Parameters and default values
1927

2028
- `options`

docs/Features/Filters/Derivative.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ Derivative filter is a special case of a gradient filter, therefore it uses grad
1212

1313
<DerivativeDemo />
1414

15+
### Kinds of images compatible with algorithm
16+
17+
| Image property | What it means | Possible values |
18+
| -------------- | -------------------------- | --------------- |
19+
| `bitDepth` | number of bits per channel | `[8,16]` |
20+
| `components` | number of components | `[1]` |
21+
| `alpha` | is alpha channel allowed | `true` |
22+
1523
### Parameters and default values
1624

1725
- `options`

docs/Features/Filters/Gaussian Blur.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ The key idea behind Gaussian blur is that it simulates a diffusion process, wher
1414

1515
<GaussianBlurDemo />
1616

17+
### Kinds of images compatible with algorithm
18+
19+
| Image property | What it means | Possible values |
20+
| -------------- | -------------------------- | --------------- |
21+
| `bitDepth` | number of bits per channel | `[8,16]` |
22+
| `components` | number of components | any |
23+
| `alpha` | is alpha channel allowed | `true` |
24+
1725
### Parameters and default values
1826

1927
With Gaussian blur there are two ways of passing options: through sigma and through sigmaX and sigmaY. Main difference is that in first case sigma is the same for X and Y directions.

docs/Features/Filters/Gradient.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ The gradient filter enhances edges by detecting abrupt changes in pixel intensit
1818
Keep in mind that gradient filters can be sensitive to noise and might result in false edges or emphasize noise. Smoothing the image (e.g., using Gaussian blur) before applying the gradient filter can help mitigate this issue.
1919
:::
2020

21+
### Kinds of images compatible with algorithm
22+
23+
| Image property | What it means | Possible values |
24+
| -------------- | -------------------------- | --------------- |
25+
| `bitDepth` | number of bits per channel | `[8,16]` |
26+
| `components` | number of components | `[1]` |
27+
| `alpha` | is alpha channel allowed | `true` |
28+
2129
### Parameters and default values
2230

2331
- `options`

docs/Features/Filters/Grayscale.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ _Converts color image into shades of gray._
1414

1515
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.
1616

17+
### Kinds of images compatible with algorithm
18+
19+
| Image property | What it means | Possible values |
20+
| -------------- | -------------------------- | --------------- |
21+
| `bitDepth` | number of bits per channel | `[8,16]` |
22+
| `components` | number of components | `[3]` |
23+
| `alpha` | is alpha channel allowed | `true` |
24+
1725
### Parameters and default values
1826

1927
- `options`

docs/Features/Filters/Invert.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ Parameters and options for Images and Masks are the same.
2323

2424
- `options`
2525

26+
### Kinds of images compatible with algorithm
27+
28+
| Image property | What it means | Possible values |
29+
| -------------- | -------------------------- | --------------- |
30+
| `bitDepth` | number of bits per channel | `[1,8,16]` |
31+
| `components` | number of components | any |
32+
| `alpha` | is alpha channel allowed | `true` |
33+
2634
#### Options
2735

2836
| Property | Required | Default value |

docs/Features/Filters/Level.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ This process can make details in both dark and bright regions of the image more
1414

1515
<LevelDemo />
1616

17+
### Kinds of images compatible with algorithm
18+
19+
| Image property | What it means | Possible values |
20+
| -------------- | -------------------------- | --------------- |
21+
| `bitDepth` | number of bits per channel | `[8,16]` |
22+
| `components` | number of components | any |
23+
| `alpha` | is alpha channel allowed | `true` |
24+
1725
### Parameters and default values
1826

1927
- `options`

0 commit comments

Comments
 (0)