fix(getMask): remove useless option (#292)

*feat(getMask): rename innerBorders option to solidFill

Closes: getMask options and behaviour #252

* test: add tophat test to remove background

* test: fix tophat test script

* fix(getMask): solidFill default value

* test(getmbr): fix solidFill option

* Update .gitignore

Co-authored-by: Michaël Zasso <[email protected]>

Author: opatiny

.gitignore

@@ -130,3 +130,4 @@ src/**/*.png
 
 # ignore images in test scripts folder
 scripts/**.png
+scripts/**.jpg

demo/components/testFunctions/testGetMask.ts

@@ -15,7 +15,7 @@ export function testGetContourMask(image: Image): Image {
   const roi = rois.sort((a, b) => b.surface - a.surface)[0];
 
   let roiMask = roi.getMask({
-    innerBorders: false,
+    solidFill: true,
   });
 
   return image.paintMask(roiMask, {

scripts/tophatTest.ts

@@ -0,0 +1,54 @@
+import { join } from 'path';
+
+import {
+  RoiMapManager,
+  fromMask,
+  read,
+  write,
+  RoiKind,
+  readSync,
+  writeSync,
+} from '../src/index';
+
+const disk12 = [
+  [0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0],
+  [0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0],
+  [0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0],
+  [0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0],
+  [0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0],
+  [0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
+  [0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0],
+  [0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0],
+  [0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0],
+  [0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0],
+  [0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0],
+  [0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0],
+];
+
+const side = 101;
+
+const square = new Array(side).fill(new Array(side).fill(1));
+
+const kernel = square;
+
+const image = readSync('./background.jpg');
+
+const grey = image.grey().invert();
+
+console.log('glaargh');
+const topHat = grey.topHat({ kernel });
+console.log('tophat succeeded');
+
+writeSync(join(__dirname, './background-grey.png'), grey);
+writeSync(join(__dirname, './background-topHat.png'), topHat);

src/maskAnalysis/__tests__/getMbr.test.ts

@@ -215,7 +215,7 @@ test('draw mbr on large image', () => {
 
   const roi = rois.sort((a, b) => b.surface - a.surface)[0];
 
-  const roiMask = roi.getMask({ innerBorders: false });
+  const roiMask = roi.getMask({ solidFill: true });
   let mbr = roiMask.getMbr();
 
   let result = rgbaImage.paintMask(roiMask, {

src/roi/__tests__/getMask.test.ts

@@ -76,7 +76,7 @@ test('innerBorders false', () => {
 
   const roi = roiMapManager.getRois({ kind: 'white' })[0];
   const roiMask = getMask(roi, {
-    innerBorders: false,
+    solidFill: true,
   });
 
   expect(roiMask).toMatchMaskData([
@@ -96,7 +96,7 @@ test('innerBorders true', () => {
 
   const roi = roiMapManager.getRois({ kind: 'white' })[0];
   const roiMask = getMask(roi, {
-    innerBorders: true,
+    solidFill: false,
   });
 
   expect(roiMask).toMatchMaskData([
@@ -118,7 +118,7 @@ test('larger mask, innerBorders false', () => {
 
   const roi = roiMapManager.getRois({ kind: 'white' })[0];
   const roiMask = getMask(roi, {
-    innerBorders: false,
+    solidFill: true,
   });
 
   expect(roiMask).toMatchMaskData([
@@ -140,8 +140,7 @@ test('allowCorners true', () => {
 
   const roi = roiMapManager.getRois({ kind: 'white' })[0];
   const roiMask = getMask(roi, {
-    allowCorners: true,
-    innerBorders: false,
+    solidFill: true,
   });
 
   expect(roiMask).toMatchMaskData([

src/roi/getMask.ts

@@ -4,27 +4,22 @@ import { Roi } from './Roi';
 
 export interface GetMaskOptions {
   /**
-   * Whether the inner borders should be returned too.
+   * Should the ROI holes be filled in the resulting mask?
    *
    * @default false
    */
-  innerBorders?: boolean;
-  /**
-   * Consider pixels connected by corners? This option is only useful if filled = false.
-   *
-   * @default false
-   */
-  allowCorners?: boolean;
+  solidFill?: boolean;
 }
+
 /**
- * Generate a mask of an ROI. You can specify the kind of mask you want using the `kind` option.
+ * Generate a mask of an ROI.
  *
  * @param roi - The ROI to generate a mask for.
  * @param options - Get mask options.
  * @returns The ROI mask.
  */
 export function getMask(roi: Roi, options: GetMaskOptions = {}): Mask {
-  const { innerBorders = true } = options;
+  const { solidFill = false } = options;
   let mask = new Mask(roi.width, roi.height, { origin: roi.origin });
 
   for (let row = 0; row < roi.height; row++) {
@@ -40,7 +35,7 @@ export function getMask(roi: Roi, options: GetMaskOptions = {}): Mask {
     }
   }
 
-  if (!innerBorders) {
+  if (solidFill) {
     mask.solidFill({ out: mask });
   }