Skip to content

Commit

Permalink
Merge branch 'main' into 97-implement-feedback-to-getting-started-and…
Browse files Browse the repository at this point in the history
…-basic-section
  • Loading branch information
EscapedGibbon authored Feb 14, 2024
2 parents f5ee911 + 5838a14 commit 7cf8377
Show file tree
Hide file tree
Showing 48 changed files with 1,544 additions and 5 deletions.
8 changes: 8 additions & 0 deletions docs/Features/Comparison/Addition.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ mask = mask.add(mask2);
Images must have the same size, channel number and bit depth for compatibility reasons.
:::

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

- [`otherImage`](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')
8 changes: 8 additions & 0 deletions docs/Features/Comparison/Hypotenuse.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ $$

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.

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `otherImage`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Comparison/Subtraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ mask = mask.subtract(mask2);
Both masks must have the same size for compatibility reasons. Images must have the same size, channel number and bit depth.
:::

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Blur.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ Blur, also known as average blur or box blur, is a simple image processing techn
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.
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.

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Derivative.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Derivative filter is a special case of a gradient filter, therefore it uses grad

<DerivativeDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Gaussian Blur.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ The key idea behind Gaussian blur is that it simulates a diffusion process, wher

<GaussianBlurDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

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.
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Gradient.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ The gradient filter enhances edges by detecting abrupt changes in pixel intensit
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.
:::

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Grayscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ _Converts color image into shades of gray._

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.

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | `[3]` |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Invert.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ Parameters and options for Images and Masks are the same.

- `options`

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

#### Options

| Property | Required | Default value |
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Level.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ This process can make details in both dark and bright regions of the image more

<LevelDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Median.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ The key advantage of using the median filter, especially for noise reduction, is

However, the median filter also has limitations. It can blur sharp edges and thin lines in the image, as it doesn't consider the spatial relationship between pixels beyond their intensity values. This means that while it's great for removing noise, it might not be suitable for all types of image enhancement tasks.

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Filters/Pixelate.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ _Reduces the level of detail in an image by replacing groups of pixels with a si

<PixelateDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Geometry/Flip.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Flip filter in image processing refers to a transformation that horizontally or

<FlipDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Geometry/Resize.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Image resizing, also known as [image rescaling](https://en.wikipedia.org/wiki/Im

<ResizeDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Geometry/Rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ Rotating images in image processing involves changing the orientation of the ima

<RotateDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and its default values

- `RotateAngle`
8 changes: 8 additions & 0 deletions docs/Features/Geometry/Transform and rotate.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ _Rotates an image by any angle._

<TransRotateDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and its default values

- `angle`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Geometry/Transform.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ Matrix cannot be singular. Otherwise it cannot be inverted. Click [here](https:/

<TransformDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and its default values

- `transformMatrix`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Bottom Hat.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ The purpose of bottom hat(or, as it is also called, _black-hat_) is to enhance a

<BottomHatDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Canny Edge Detector.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ The Canny edge detector is known for its ability to:
- Handle edges with varying levels of intensity (gradient).
- Allow for customization through the selection of appropriate threshold values.

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Closing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ It is a useful process for filling small holes in the image, while preserving th

<CloseDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Dilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ _Enlarges the size of foreground objects by iteratively expanding their boundari

<DilateDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Erosion.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ _Reduces the size of foreground objects by iteratively shrinking their boundarie

<ErodeDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Morphological Gradient.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ The morphological gradient is based on the difference between an image after [di

<MorphGradientDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Opening.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ This process allows removing small objects and thin lines while preserving the s

<OpenDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

:::info
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Morphology/Top Hat.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ The purpose of bottom hat(or as it is also called _black-hat_) is to enhance and

<TopHatDemo />

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[1,8,16]` |
| `components` | number of components | `[1]` |
| `alpha` | is alpha channel allowed | `false` |

### Parameters and default values

- `options`
Expand Down
8 changes: 8 additions & 0 deletions docs/Features/Operations/Get extrema.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ You can add a mask as an option to specify locations where to look for extrema.
| ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| ![Minimum](./images/extremaOutput/CellsOutputcrossMinISODATA5.jpg) | ![Maximum](./images/extremaOutput/CellsOutputcrossMaxISODATA5.jpg) |

### Kinds of images compatible with algorithm

| Image property | What it means | Possible values |
| -------------- | -------------------------- | --------------- |
| `bitDepth` | number of bits per channel | `[8,16]` |
| `components` | number of components | any |
| `alpha` | is alpha channel allowed | `true` |

### Parameters and default values

- `image`
Expand Down
Loading

0 comments on commit 7cf8377

Please sign in to comment.