Skip to content

Commit 70e112f

Browse files
committed
docs: resolve conversations
1 parent 871bb4c commit 70e112f

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

blog/release.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ const pixel = img.getPixel(x, y); // any[]
2222
const pixel = img.getPixel(x, y); // number[] with proper channel count
2323
```
2424

25-
This eliminates runtime type errors and provides better IntelliSense, autocomplete, and refactoring support in your IDE. Developers can now catch bugs at compile time rather than discovering them in production.
25+
This helps preventing runtime type errors and enables better IntelliSense, autocomplete, and refactoring support in your IDE. Developers can now catch bugs at compile time rather than discovering them in production.
2626

2727
## ⚠️ Breaking changes
2828

2929
### Images
3030

31-
#### Loading and saving
31+
#### Loading and saving images
3232

3333
`load()` and `save()` have been replaced with dedicated functions `read()` and `write()`.
3434

@@ -56,7 +56,7 @@ writeSync('newCat.jpg', img);
5656

5757
Those changes separates I/O operations from image manipulation for a clearer API design.
5858

59-
#### Creating
59+
#### Creating images
6060

6161
When creating a new image, unlike before, image's width and height must be specified.
6262

@@ -71,7 +71,7 @@ const image2 = new Image(10, 10);
7171

7272
This change makes the Image constructor more explicit by requiring you to specify the dimensions upfront, preventing potential errors from working with uninitialized or undefined-sized images.
7373

74-
#### Coordinate System Changes
74+
#### Coordinate system changes
7575

7676
Coordinates are now represented using `Point` objects instead of arrays. This change affects methods that require coordinate input like cropping, drawing, pixel manipulation etc.
7777

@@ -118,17 +118,13 @@ ROI map creation methods like `fromMask()` and `fromWatershed()` are now standal
118118

119119
```ts
120120
//Before
121-
import { Image } from 'image-js';
122-
123-
const roiManager = mask.getRoiManager();
124-
roiManager.fromMask(mask);
121+
const roiManager = img.getRoiManager();
122+
roiManager.fromMask(img);
125123
const rois = roiManager.getRois();
126124
```
127125

128126
```ts
129127
//After
130-
import { Image, fromMask } from 'image-js';
131-
132128
const roiManager = fromMask(mask);
133129
const rois = roiManager.getRois();
134130
```
@@ -171,7 +167,7 @@ const sobelY = img.derivative({ filter: 'scharr' });
171167

172168
This filter now also accepts only grayscale images, since filters, like Sobel or Scharr, are used mainly on grayscale images to detect edges.
173169

174-
### Method Renaming
170+
### Renamed methods
175171

176172
Several methods have been renamed for consistency:
177173

@@ -293,7 +289,7 @@ The following deprecated features have been removed:
293289
- `findCorrespondingRoi()` has been removed.
294290
- `resetPainted()` has been removed.
295291
- `mergeRoi()` and `mergeRois()` have been removed.
296-
- `minX`,`minY`,`meanX`,`meanY`,`maxX`,`maxY` have been removed. Use [ROI's `position`, combined with its `width` and `height`](https://image-js.github.io/image-js/classes/index.Roi.html 'API link on ROI').
292+
- `minX`,`minY`,`meanX`,`meanY`,`maxX`,`maxY` have been removed. Use [ROI's `origin`, combined with its `width` and `height`](https://image-js.github.io/image-js/classes/index.Roi.html 'API link on ROI').
297293

298294
## 🆕 New Features
299295

@@ -306,7 +302,7 @@ const matrix = getPerspectiveWarp(sourcePoints);
306302
const warped = img.transform(matrix);
307303
```
308304

309-
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.
305+
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.
310306

311307
### Bicubic Interpolation
312308

@@ -326,7 +322,7 @@ const resized = img.resize(800, 600, { interpolation: 'bicubic' });
326322
const prewitt = img.derivative({ filter: 'prewitt' });
327323
```
328324

329-
**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').
325+
**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').
330326

331327
### Migration from deprecated methods
332328

0 commit comments

Comments
 (0)