Skip to content

Commit cda5f17

Browse files
docs: modify extension of files with react components to .mdx (#158)
1 parent 690c078 commit cda5f17

40 files changed

+84
-84
lines changed
File renamed without changes.

docs/basics/working-with-masks.md renamed to docs/basics/working-with-masks.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import ThresholdMaskDemo from './demos/thresholdMask.demo.tsx'
2-
import CannyMaskDemo from './demos/cannyEdgeMask.demo.tsx'
1+
import ThresholdMaskDemo from './demos/thresholdMask.demo.tsx';
2+
import CannyMaskDemo from './demos/cannyEdgeMask.demo.tsx';
33

44
# Working with Masks
55

@@ -23,7 +23,7 @@ const mask = new Mask(500, 500); // Creates a simple mask filled with 0s of size
2323

2424
### Use `threshold()` method
2525

26-
Another approach is to obtain a mask by using [`threshold` method](../features/operations/threshold.md 'internal link on threshold') on an image.
26+
Another approach is to obtain a mask by using [`threshold` method](../features/operations/threshold.mdx 'internal link on threshold') on an image.
2727

2828
```ts
2929
const mask = image.threshold(); // returns a mask
@@ -39,7 +39,7 @@ In most cases, thresholding is your go-to method to get a mask from an image.
3939

4040
### Use `cannyEdgeDetector()` method
4141

42-
There is also a third way to get a mask. It is to use [`cannyEdgeDetector` method](../features/morphology/canny-edge-detector.md 'internal link on canny edge detector').
42+
There is also a third way to get a mask. It is to use [`cannyEdgeDetector` method](../features/morphology/canny-edge-detector.mdx 'internal link on canny edge detector').
4343

4444
```ts
4545
const mask = image.cannyEdgeDetector(); // returns a mask

docs/basics/working-with-rois.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ _A region of interest (ROI) represents an area of contiguous pixels within the d
44

55
There are currently two ways ROIs can be generated in ImageJS:
66

7-
- From [masks](./working-with-masks.md 'internal link on working with mask') by identifying contiguous black or white pixels within it.
7+
- From [masks](./working-with-masks.mdx 'internal link on working with mask') by identifying contiguous black or white pixels within it.
88
<!-- TODO: add links to the relevant sections once they exist -->
99
- By identifying starting points of interest (for example by finding and filtering local extrema) and running the [watershed algorithm](../features/operations/watershed.md 'internal link on watershed') on them.
1010
- By identifying starting points of interest (for example by finding and filtering local extrema) and running the [watershed algorithm](../features/operations/watershed.md 'internal link on watershed') on them.

docs/features/comparison/addition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _Add two images together._
88

99
[🖼️ Image options and parameters of `add` method](https://api.image-js.org/classes/index.Image.html#add)
1010

11-
`add` method, opposed to [subtraction](./subtraction.md 'internal link on subtract'), takes another Image and makes an addition between each respective pixel value.
11+
`add` method, opposed to [subtraction](./subtraction 'internal link on subtract'), takes another Image and makes an addition between each respective pixel value.
1212
It works like this:
1313

1414
```ts
File renamed without changes.

docs/features/filters/blur.md renamed to docs/features/filters/blur.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 30
33
---
44

5-
import BlurDemo from './demos/blur.demo.tsx'
5+
import BlurDemo from './demos/blur.demo.tsx';
66

77
# Blur
88

@@ -15,7 +15,7 @@ Blur, also known as average blur or box blur, is a simple image processing techn
1515
<BlurDemo />
1616

1717
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 'glossary link on kernel') size is important.
18-
More advanced blurring techniques, such as [Gaussian blur](./gaussian-blur.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.
18+
More advanced blurring techniques, such as [Gaussian blur](./gaussian-blur '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.
1919

2020
### Kinds of images compatible with algorithm
2121

docs/features/filters/derivative.md renamed to docs/features/filters/derivative.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 70
33
---
44

5-
import DerivativeDemo from './demos//derivative.demo.tsx'
5+
import DerivativeDemo from './demos//derivative.demo.tsx';
66

77
# Derivative
88

docs/features/filters/filters.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ sidebar_position: 0
88

99
### Methods
1010

11-
| Can be applied on | Images | Masks |
12-
| ------------------------------------------------------------------------------ | ------- | -------- |
13-
| [Invert(`invert`)](./invert.md 'internal link on invert') | &#9989; | &#9989; |
14-
| [Grayscale(`grey`)](./grayscale.md 'internal link on grayscale') | &#9989; | &#10060; |
15-
| [Gradient(`gradient`)](./gradient.md 'internal link on gradient') | &#9989; | &#10060; |
16-
| [Derivative(`derivative`)](./derivative.md 'internal link on derivative') | &#9989; | &#10060; |
17-
| [Median(`median`)](./median.md 'internal link on median') | &#9989; | &#10060; |
18-
| [Pixelate(`pixelate`)](./pixelate.md 'internal link on pixelate') | &#9989; | &#10060; |
19-
| [Blur(`blur`)](./blur.md 'internal link on blur') | &#9989; | &#10060; |
20-
| [Gaussian(`gaussianBlur`)](./gaussian-blur.md 'internal link on gaussianBlur') | &#9989; | &#10060; |
21-
| [Level(`level`)](./level.md 'internal link on level') | &#9989; | &#10060; |
11+
| Can be applied on | Images | Masks |
12+
| ------------------------------------------------------------------------------- | ------- | -------- |
13+
| [Invert(`invert`)](./invert.mdx 'internal link on invert') | &#9989; | &#9989; |
14+
| [Grayscale(`grey`)](./grayscale.mdx 'internal link on grayscale') | &#9989; | &#10060; |
15+
| [Gradient(`gradient`)](./gradient.mdx 'internal link on gradient') | &#9989; | &#10060; |
16+
| [Derivative(`derivative`)](./derivative.mdx 'internal link on derivative') | &#9989; | &#10060; |
17+
| [Median(`median`)](./median.mdx 'internal link on median') | &#9989; | &#10060; |
18+
| [Pixelate(`pixelate`)](./pixelate.mdx 'internal link on pixelate') | &#9989; | &#10060; |
19+
| [Blur(`blur`)](./blur.mdx 'internal link on blur') | &#9989; | &#10060; |
20+
| [Gaussian(`gaussianBlur`)](./gaussian-blur.mdx 'internal link on gaussianBlur') | &#9989; | &#10060; |
21+
| [Level(`level`)](./level.mdx 'internal link on level') | &#9989; | &#10060; |

docs/features/filters/gaussian-blur.md renamed to docs/features/filters/gaussian-blur.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 40
33
---
44

5-
import GaussianBlurDemo from './demos/gaussianBlur.demo.tsx'
5+
import GaussianBlurDemo from './demos/gaussianBlur.demo.tsx';
66

77
# Gaussian Blur
88

@@ -61,7 +61,7 @@ The size of the Gaussian kernel and the standard deviation parameter (which cont
6161

6262
Here's how Gaussian blur is implemented in ImageJS:
6363

64-
_Kernel Definition_: The core concept of Gaussian blur involves [convolving](../../glossary.md#convolution 'glossary link on convolution') the image with a Gaussian [kernel](../../glossary.md#kernel 'glossary link on kernel'), also known as a Gaussian filter or mask. This kernel's values are arranged in a way that creates a symmetric, bell-shaped pattern around the center of the kernel to approximate Gaussian function.
64+
_Kernel Definition_: The core concept of Gaussian blur involves [convolving](../../glossary#convolution 'glossary link on convolution') the image with a Gaussian [kernel](../../glossary.md#kernel 'glossary link on kernel'), also known as a Gaussian filter or mask. This kernel's values are arranged in a way that creates a symmetric, bell-shaped pattern around the center of the kernel to approximate Gaussian function.
6565

6666
_Convolution Operation_: The Gaussian kernel is applied to the image using a convolution operation. This involves placing the kernel's center over each pixel in the image and performing element-wise multiplication of the kernel's values with the corresponding pixel values in the neighborhood. The results of these multiplications are summed up to compute the new value for the central pixel.
6767

docs/features/filters/gradient.md renamed to docs/features/filters/gradient.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 60
33
---
44

5-
import GradientDemo from './demos/gradient.demo.tsx'
5+
import GradientDemo from './demos/gradient.demo.tsx';
66

77
# Gradient
88

@@ -49,7 +49,7 @@ Keep in mind that gradient filters can be sensitive to noise and might result in
4949

5050
Here's how gradient filter is implemented in ImageJS:
5151

52-
_Grayscale Conversion_: Before applying a gradient filter, the color image is converted into [grayscale](./grayscale.md 'internal link on grayscale filter'). This simplifies the processing by reducing the image to a single channel representing pixel intensities.
52+
_Grayscale Conversion_: Before applying a gradient filter, the color image is converted into [grayscale](./grayscale.mdx 'internal link on grayscale filter'). This simplifies the processing by reducing the image to a single channel representing pixel intensities.
5353

5454
_Kernel Operators_: Gradient filter consists of small convolution [kernels](../../glossary.md#kernel 'glossary link on kernel'). Normally, one for detecting horizontal changes and another for vertical changes, however user might indicate only one kernel to check only one of directions. These kernels are usually 3x3 matrices of numerical weights.
5555

@@ -60,7 +60,7 @@ _Gradient Magnitude and Direction_: For each pixel, the gradient magnitude is ca
6060
_Edge Detection_: The gradient magnitude values are used to identify regions of rapid intensity change, which correspond to edges in the image. Higher gradient magnitude values indicate stronger edges.
6161

6262
:::tip
63-
_Thresholding_: To further refine the edges detected, a [thresholding](../operations/threshold.md 'internal link on threshold filter') step is often applied. Pixels with gradient magnitudes below a certain threshold are considered as non-edges, while those above the threshold are considered edges. This helps in reducing noise and emphasizing significant edges.
63+
_Thresholding_: To further refine the edges detected, a [thresholding](../operations/threshold.mdx 'internal link on threshold filter') step is often applied. Pixels with gradient magnitudes below a certain threshold are considered as non-edges, while those above the threshold are considered edges. This helps in reducing noise and emphasizing significant edges.
6464
:::
6565

6666
</details>

0 commit comments

Comments
 (0)