Skip to content

Commit f610577

Browse files
committed
docs: update filenames for proper link format
1 parent f0822d5 commit f610577

File tree

142 files changed

+974
-620
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+974
-620
lines changed

blog/releases/1.0.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ The new `blackRois` and `whiteRois` properties provide more intuitive access to
149149

150150
For more information, please visit these tutorials:
151151

152-
- [Image segmentation with `threshold()` and `fromMask()`](../../docs/Tutorials/Image%20segmentation%20with%20threshold)
153-
- [Image segmentation with `watershed()`](../../docs/Tutorials/Image%20segmentation%20with%20watershed)
152+
- [Image segmentation with `threshold()` and `fromMask()`](../../docs/tutorials/image-segmentation-with-threshold)
153+
- [Image segmentation with `watershed()`](../../docs/tutorials/image-segmentation-with-watershed)
154154

155155
### Sobel and Scharr filters
156156

@@ -266,7 +266,7 @@ The following deprecated features have been removed:
266266

267267
- `countAlphaPixel()` - Use custom pixel counting with [`getPixel()`](https://api.image-js.org/classes/index.Image.html#getpixel 'API link on getPixel').
268268
- `paintLabels()` and `roi.paint()` - Features have been removed due to dependency issues. We plan to add it back in future updates.
269-
- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on getPerspectiveWarp') + [`transform()`](#transform) instead.
269+
- `warpingFourPoints()` - Use [`getPerspectiveWarpMatrix()`](../../docs/features/geometry/get-perspective-warp-matrix 'internal link on getPerspectiveWarp') + [`transform()`](#transform) instead.
270270
- 32-bit color depth support and `abs()` have been removed.
271271
- `CMYK` and `HSL` color models have been removed.
272272
- `paintMasks()` has been removed. Use [`paintMask()`](https://api.image-js.org/classes/index.Image.html#paintmask 'API link on paintMask')+ a `for` loop.
@@ -303,7 +303,7 @@ const matrix = getPerspectiveWarp(sourcePoints);
303303
const warped = img.transform(matrix);
304304
```
305305

306-
For more details, [visit our tutorial](../../docs/Tutorials/Applying%20transform%20function%20on%20images 'internal link on transform function tutorial') on how image transformations work how they can be used.
306+
For more details, [visit our tutorial](../../docs/tutorials/applying-transform-function-on-images 'internal link on transform function tutorial') on how image transformations work how they can be used.
307307

308308
### Bicubic interpolation
309309

@@ -323,11 +323,11 @@ const resized = img.resize(800, 600, { interpolation: 'bicubic' });
323323
const prewitt = img.derivative({ filter: 'prewitt' });
324324
```
325325

326-
**Use cases**: Object detection, image segmentation, feature extraction. You can [learn more about it here](../../docs/Features/Morphology/Morphological%20Gradient 'internal link on morphological gradient').
326+
**Use cases**: Object detection, image segmentation, feature extraction. You can [learn more about it here](../../docs/features/morphology/morphological-gradient 'internal link on morphological gradient').
327327

328328
### Migration from deprecated methods
329329

330-
`warpingFourPoints()` has been removed. Now you have [`getPerspectiveWarp()`](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp') that returns a matrix that can be applied on the image of interest in a new `transform()`.
330+
`warpingFourPoints()` has been removed. Now you have [`getPerspectiveWarp()`](../../docs/features/geometry/get-perspective-warp-matrix 'internal link on perspective warp') that returns a matrix that can be applied on the image of interest in a new `transform()`.
331331

332332
```ts
333333
// Before
@@ -338,7 +338,7 @@ const matrix = getPerspectiveWarp(corners);
338338
const warped = img.transform(matrix);
339339
```
340340

341-
**Use cases**: Rectification of a perspective angle of an image. You can learn more about it [here](../../docs/Features/Geometry/Get%20Perspective%20Warp%20Matrix 'internal link on perspective warp').
341+
**Use cases**: Rectification of a perspective angle of an image. You can learn more about it [here](../../docs/features/geometry/get-perspective-warp-matrix 'internal link on perspective warp').
342342

343343
### `merge()`
344344

docs/Basics/Basics.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
import DocCardList from '@theme/DocCardList';
22

3+
# Basics
4+
35
<DocCardList />

docs/Basics/Working with Images.md renamed to docs/Basics/working-with-images.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,28 +47,28 @@ In ImageJS main properties of an image are:
4747

4848
- data: typed array with information about image's pixels.
4949

50-
- [Color model](../Glossary.md#color-model 'internal link on color model'): the abstract model of how pixel colors are formed.
50+
- [Color model](../glossary.md#color-model 'internal link on color model'): the abstract model of how pixel colors are formed.
5151

52-
- [Bit depth](../Glossary.md#bit-depth 'internal link on bit depth'): number of bits allocated to each channel.
52+
- [Bit depth](../glossary.md#bit-depth 'internal link on bit depth'): number of bits allocated to each channel.
5353

54-
- [Number of channels](../Glossary.md#channel 'internal link on channels'): number of color channels that each pixel has. Grey image has one, RGB-type of image has three.
54+
- [Number of channels](../glossary.md#channel 'internal link on channels'): number of color channels that each pixel has. Grey image has one, RGB-type of image has three.
5555

56-
- [Number of components](../Glossary.md#component 'internal link on components'): number of color channels that each pixel has but without alpha channel.
56+
- [Number of components](../glossary.md#component 'internal link on components'): number of color channels that each pixel has but without alpha channel.
5757

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

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

6262
### Features
6363

6464
Currently, there are several ways of processing an image:
6565

66-
- [Filtering](../Features/Filters/Filters.md 'internal link on filters'): filters usually apply some sort of [kernel](../Glossary.md#kernel 'internal link on kernel') to change an image.
66+
- [Filtering](../features/filters/filters.md 'internal link on filters'): filters usually apply some sort of [kernel](../glossary.md#kernel 'internal link on kernel') to change an image.
6767

68-
- [Comparison](../Features/Comparison/Comparison.md 'internal link on comparison'): these features compare two images for further feature matching between the two.
68+
- [Comparison](../features/comparison/comparison.md 'internal link on comparison'): these features compare two images for further feature matching between the two.
6969

70-
- [Geometry](../Features/Geometry/Geometry.md 'internal link on geometry'): this part of ImageJS allows rotating and resizing an image.
70+
- [Geometry](../features/geometry/geometry.md 'internal link on geometry'): this part of ImageJS allows rotating and resizing an image.
7171

72-
- [Morphology](../Features/Morphology/Morphology.md 'internal link on morphology'): enables shape analysis and shape identification.
72+
- [Morphology](../features/morphology/morphology.md 'internal link on morphology'): enables shape analysis and shape identification.
7373

74-
- [ROI analysis](../Features/Regions%20of%20interest/Regions%20of%20interest.md 'internal link on roi analysis'): these features allow targeting and extracting relevant information from specific regions of interest.
74+
- [ROI analysis](../features/regions-of-interest/regions-of-interest.md 'internal link on roi analysis'): these features allow targeting and extracting relevant information from specific regions of interest.

docs/Basics/Working with Masks.md renamed to docs/Basics/working-with-masks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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.md '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%20Edge%20Detector.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.md 'internal link on canny edge detector').
4343

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

docs/Basics/Working with ROIs.md renamed to docs/Basics/working-with-rois.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ _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%20with%20Masks.md 'internal link on working with mask') by identifying contiguous black or white pixels within it.
7+
- From [masks](./working-with-masks.md '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 -->
9-
- 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.
10-
- 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.
9+
- 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.
10+
- 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.
1111

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

docs/Features/Filters/Filters.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/Features/Geometry/Geometry.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/Features/Morphology/Morphology.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/Features/Operations/Operations.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/Features/Regions of interest/Regions of interest.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)