image-js 1.5.0 → 1.6.1

package/src/maskAnalysis/utils/getExternalContourUtils.ts

@@ -0,0 +1,33 @@
+import type { Mask } from '../../Mask.ts';
+/**
+ * Gets point's row and column from their index and mask width.
+ * @param index - point's index.
+ * @param maskWidth - mask width.
+ * @returns array of point's row and column.
+ */
+export function getCoordsFromIndex(index: number, maskWidth: number) {
+  return [Math.floor(index / maskWidth), index % maskWidth];
+}
+
+/**
+ * Safely get the bit value at the given column and row in the mask, returning 0 if out of bounds.
+ * @param mask - Mask to get the bit from.
+ * @param col - Column index.
+ * @param row - Row index.
+ * @returns the bit value.
+ */
+export function getBitSafe(mask: Mask, col: number, row: number): number {
+  if (!isInBounds(mask, col, row)) return 0;
+  return mask.getBit(col, row);
+}
+
+/**
+ * Checks if the given column and row are within the bounds of the mask.
+ * @param mask - Mask to check against.
+ * @param col - Column index.
+ * @param row - Row index.
+ * @returns whether the given column and row are within the bounds of the mask.
+ */
+function isInBounds(mask: Mask, col: number, row: number): boolean {
+  return col >= 0 && col < mask.width && row >= 0 && row < mask.height;
+}

package/src/roi/Roi.ts

@@ -1,5 +1,6 @@
 import type { Mask } from '../Mask.js';
 import { getConvexHull } from '../maskAnalysis/getConvexHull.js';
+import type { GetExternalContourOptions } from '../maskAnalysis/getExternalContour.ts';
 import { getFeret } from '../maskAnalysis/getFeret.js';
 import { getMbr } from '../maskAnalysis/getMbr.js';
 import type {
@@ -11,6 +12,7 @@ import type { Point } from '../utils/geometry/points.js';
 
 import type { RoiMap } from './RoiMapManager.js';
 import { getBorderPoints } from './getBorderPoints.js';
+import { getExternalContour } from './getExternalContour.ts';
 import type { GetMaskOptions } from './getMask.js';
 import { getMask } from './getMask.js';
 import { getEllipse } from './properties/getEllipse.js';
@@ -129,6 +131,15 @@ export class Roi {
     return getBorderPoints(this, options);
   }
 
+  /**
+   * Finds external contour of the roi from its mask.
+   * @param options - GetExternalContourOptions.
+   * @returns Array of contour points.
+   */
+  public getExternalContour(options?: GetExternalContourOptions): Point[] {
+    return getExternalContour(this, options);
+  }
+
   /**
    * Returns an array of ROIs IDs that are included in the current ROI.
    * This will be useful to know if there are some holes in the ROI.

package/src/roi/getExternalContour.ts

@@ -0,0 +1,17 @@
+import type { GetExternalContourOptions } from '../maskAnalysis/getExternalContour.ts';
+
+import type { Roi } from './Roi.ts';
+
+/**
+ * Finds external contour of the roi from its mask.
+ * @param roi - roi to find contour from.
+ * @param options - GetExternalContourOptions.
+ * @returns Array of contour points.
+ */
+export function getExternalContour(
+  roi: Roi,
+  options?: GetExternalContourOptions,
+) {
+  const mask = roi.getMask();
+  return mask.getExternalContour(options);
+}