Skip to content

Commit b13f977

Browse files
docs: minor fixes in links (#104)
* docs: fix minor issues in basics section * docs: fix minor issues in filters section * docs: fix minor issues in comparison section * docs: fix minor issues in geometry section * docs: minor fixes in morphology section * docs: minor fixes in operations section * docs: minor fixes in roi analysis section * docs: minor fixes in tips section * docs: minor fixes in tutorials section close: #81 * docs: remove invalid link * docs: fix prettier error
1 parent 39636dc commit b13f977

31 files changed

+77
-72
lines changed

docs/Basics/Working with Images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ In ImageJS main properties of an image are:
5555

5656
- [Alpha channel](../Glossary.md#alpha-channel 'internal link on alpha-channel'): channel that represents the transparency or opacity levels of pixels.
5757

58-
- [Metadata](../Glossary.md#metadata 'internal link on metadata'): data about data. A basic example would be date and time when an image was taken
58+
- [Metadata](../Glossary.md#metadata 'internal link on metadata'): data about data. A basic example would be date and time when an image was taken.
5959

6060
### Features
6161

docs/Basics/Working with Masks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ In most cases, thresholding is your go-to method to get a mask from an image.
3737

3838
### Use `cannyEdgeDetector()` method
3939

40-
There is also a third way to get a mask. It is to use [`cannyEdgeDetector` method](../Features/Morphology/Canny%20Edge%20Detector.md).
40+
There is also a third way to get a mask. It is to use [`cannyEdgeDetector` method](../Features/Morphology/Canny%20Edge%20Detector.md 'internal link on canny edge detector').
4141

4242
```ts
4343
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 @@ There are currently two ways ROIs can be generated in ImageJS:
44

55
- From [masks](./Working%20with%20Masks.md 'internal link on working with mask') by identifying contiguous black or white pixels within it.
66
<!-- TODO: add links to the relevant sections once they exist -->
7-
- By identifying starting points of interest (for example by finding and filtering local extrema) and running the watershed algorithm on them.
7+
- 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.
88

99
ROIs identify and characterize regions within images, which has wide applications in image analysis.
1010

docs/Features/Comparison/Addition.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 10
44

55
_Makes an addition between two images._
66

7-
[Check options and parameters of `add` method](https://image-js.github.io/image-js-typescript/classes/Image.html#add 'github.io link')
7+
[🖼️ Image options and parameters of `add` method](https://image-js.github.io/image-js-typescript/classes/Image.html#add 'github.io link')
88

99
`add` method, opposed to [subtraction](./Subtraction.md 'internal link on subtract'), takes another Image and makes an addition between each respective pixel value.
1010
It works like this:
@@ -34,4 +34,4 @@ Images must have the same size, channel number and bit depth for compatibility r
3434

3535
### Parameters and default values
3636

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

docs/Features/Comparison/Comparison.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The specific reasons for comparing images depend on the application and the desi
1010
| Can be applied on | Images | Masks |
1111
| ------------------------------------------------------------------------------- | -------- | -------- |
1212
| [Addition(`add`)](./Addition.md 'internal link on add') | &#9989; | &#10060; |
13-
| [Subtraction( `subtract` )](./Subtraction.md 'internal link on subtract') | &#9989; | &#9989; |
14-
| [Hypotenuse( `hypotenuse` )](./Hypotenuse.md 'internal link on hypotenuse') | &#9989; | &#10060; |
13+
| [Subtraction(`subtract`)](./Subtraction.md 'internal link on subtract') | &#9989; | &#9989; |
14+
| [Hypotenuse(`hypotenuse`)](./Hypotenuse.md 'internal link on hypotenuse') | &#9989; | &#10060; |
1515
| [Logical conjunction(`and`)](./Logical%20conjunction.md 'internal link on and') | &#10060; | &#9989; |
1616
| [Logical disjunction(`or`)](./Logical%20disjunction.md 'internal link on or') | &#10060; | &#9989; |

docs/Features/Comparison/Hypotenuse.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,9 @@ Where $$Value1$$ is a value of the pixel in the first image and $$Value2$$ is th
3030

3131
#### Options
3232

33-
| Property | Required | Default value |
34-
| ------------------------------------------------------------------------------------------------------- | -------- | ---------------- |
35-
| [`bitDepth`](https://image-js.github.io/image-js-typescript/interfaces/HypotenuseOptions.html#bitDepth) | no | `image.bitDepth` |
36-
| [`channels`](https://image-js.github.io/image-js-typescript/interfaces/HypotenuseOptions.html#channels) | no | - |
33+
| Property | Required | Default value |
34+
| ------------------------------------------------------------------------------------------------------- | -------- | ------------- |
35+
| [`channels`](https://image-js.github.io/image-js-typescript/interfaces/HypotenuseOptions.html#channels) | no | - |
3736

3837
:::caution
3938
Images must be compatible by size, bit depth, number of channels and number of alpha channels. However, for the resulting image user can choose the bit depth of the resulting image as well as channels which the algorithm will be applied to.

docs/Features/Filters/Blur.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Blur, also known as average blur or box blur, is a simple image processing techn
1212

1313
<BlurDemo />
1414

15-
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.
15+
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.
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

1818
### Kinds of images compatible with algorithm
@@ -46,7 +46,7 @@ Here's how blur filter is implemented in ImageJS:
4646

4747
_Select a Kernel Size_: The first step is to choose the size of the kernel or window that will be used for the blurring operation. The kernel is typically a square matrix with odd dimensions, such as 3x3, 5x5, 7x7, etc. The larger the kernel, the more intense the blurring effect.
4848

49-
_Iterate through Pixels_: For each pixel in the image, the algorithm applies [convolution](../../Glossary.md#convolution).
49+
_Iterate through Pixels_: For each pixel in the image, the algorithm applies [convolution](../../Glossary.md#convolution 'glossary link on convolution').
5050

5151
_Calculate Average Color_: The algorithm calculates the average color value of all the pixels within the kernel.
5252

docs/Features/Filters/Filters.md

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

99
| Can be applied on | Images | Masks |
1010
| -------------------------------------------------------------------------------- | ------- | -------- |
11-
| [Invert(`add`)](./Invert.md 'internal link on invert') | &#9989; | &#9989; |
12-
| [Grayscale( `grey` )](./Grayscale.md 'internal link on grayscale') | &#9989; | &#10060; |
13-
| [Gradient(`gradient` )](./Gradient.md 'internal link on gradient') | &#9989; | &#10060; |
11+
| [Invert(`invert`)](./Invert.md 'internal link on invert') | &#9989; | &#9989; |
12+
| [Grayscale(`grey`)](./Grayscale.md 'internal link on grayscale') | &#9989; | &#10060; |
13+
| [Gradient(`gradient`)](./Gradient.md 'internal link on gradient') | &#9989; | &#10060; |
1414
| [Derivative(`derivative`)](./Derivative.md 'internal link on derivative') | &#9989; | &#10060; |
1515
| [Median(`median`)](./Median.md 'internal link on median') | &#9989; | &#10060; |
1616
| [Pixelate(`pixelate`)](./Pixelate.md 'internal link on pixelate') | &#9989; | &#10060; |

docs/Features/Filters/Gaussian Blur.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _A blur filter that uses gaussian function for smoothing._
88

99
[🖼️ Image options and parameters of `gaussianBlur` method](https://image-js.github.io/image-js-typescript/classes/Image.html#gaussianBlur 'link on github io')
1010

11-
[Gaussian blur](https://en.wikipedia.org/wiki/Gaussian_blur 'Wikipedia link on gaussian blur') is a widely used image processing technique that smooths an image by reducing high-frequency noise and fine details while preserving the overall structure and larger features. It's named after the [Gaussian function](https://en.wikipedia.org/wiki/Gaussian_function 'wikipedia link on Gaussian function'), which is a mathematical function that represents a bell-shaped curve. Gaussian blur is often applied to images before other processing steps like edge detection to improve their quality and reliability.
11+
[Gaussian blur](https://en.wikipedia.org/wiki/Gaussian_blur 'Wikipedia link on gaussian blur') is a widely used image processing technique that smooths an image by reducing high-frequency noise and fine details while preserving the overall structure and larger features. It's named after the [Gaussian function](https://en.wikipedia.org/wiki/Gaussian_function 'wikipedia link on gaussian function'), which is a mathematical function that represents a bell-shaped curve. Gaussian blur is often applied to images before other processing steps like edge detection to improve their quality and reliability.
1212

1313
The key idea behind Gaussian blur is that it simulates a diffusion process, where each pixel's value is influenced by the values of its neighbors. Because the weights are determined by the Gaussian function, pixels that are closer to the central pixel have a larger impact on the smoothed value, while pixels that are farther away contribute less.
1414

@@ -48,7 +48,7 @@ With Gaussian blur there are two ways of passing options: through sigma and thro
4848
| [`borderType`](https://image-js.github.io/image-js-typescript/interfaces/GaussianBlurXYOptions.html#borderType) | no | `reflect101` |
4949
| [`out`](https://image-js.github.io/image-js-typescript/interfaces/GaussianBlurXYOptions.html#out) | no | - |
5050
| [`sizeX`](https://image-js.github.io/image-js-typescript/interfaces/GaussianBlurXYOptions.html#sizeX) | no | `2 * Math.ceil(2 * sigmaX) + 1` |
51-
| [`sizeX`](https://image-js.github.io/image-js-typescript/interfaces/GaussianBlurXYOptions.html#sizeY) | no | `2 * Math.ceil(2 * sigmaY) + 1` |
51+
| [`sizeY`](https://image-js.github.io/image-js-typescript/interfaces/GaussianBlurXYOptions.html#sizeY) | no | `2 * Math.ceil(2 * sigmaY) + 1` |
5252

5353
The size of the Gaussian kernel and the standard deviation parameter (which controls the spread of the Gaussian curve) influence the degree of smoothing. A larger kernel or a higher standard deviation will produce more pronounced smoothing, but might also result in a loss of fine details.
5454

docs/Features/Filters/Gradient.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ import GradientDemo from './demos/gradient.demo.tsx'
66

77
_Highlights changes in color or intensity within an image by accentuating transitions and edges._
88

9-
[🖼️ Image options and parameters of `gradient` method](https://image-js.github.io/image-js-typescript/functions/gradientFilter.html 'link on github.io')
9+
[🖼️ Image options and parameters of `gradient` method](https://image-js.github.io/image-js-typescript/classes/Image.html#gradientFilter 'link on github.io')
1010

11-
Gradient filter or specifically[ a gradient-based edge detection filter](https://en.wikipedia.org/wiki/Graduated_neutral-density_filter 'Wikipedia link on gradient filter'), is an image processing technique used to highlight edges and boundaries within an image by emphasizing areas of rapid intensity change. The gradient filter operates by calculating the rate of change of pixel intensities across the image. When there's a rapid transition from one intensity level to another, [the convolution operation](../../Glossary.md#convolution 'glossary link on convolution') captures this change as a high gradient magnitude value, indicating the presence of an edge. It's a fundamental step in various computer vision and image analysis tasks, such as edge detection, object recognition, and image segmentation.
11+
Gradient filter or specifically[ a gradient-based edge detection filter](https://en.wikipedia.org/wiki/Graduated_neutral-density_filter 'wikipedia link on gradient filter'), is an image processing technique used to highlight edges and boundaries within an image by emphasizing areas of rapid intensity change. The gradient filter operates by calculating the rate of change of pixel intensities across the image. When there's a rapid transition from one intensity level to another, [the convolution operation](../../Glossary.md#convolution 'glossary link on convolution') captures this change as a high gradient magnitude value, indicating the presence of an edge. It's a fundamental step in various computer vision and image analysis tasks, such as edge detection, object recognition, and image segmentation.
1212

1313
<GradientDemo />
1414

0 commit comments

Comments
 (0)