refactor: replace enums with const objects

Closes: #140

Author: targos

demo/components/CameraTransform.tsx

@@ -1,6 +1,6 @@
 import { RefObject, useEffect, useRef, useState } from 'react';
 
-import { Image, ImageColorModel, readCanvas, writeCanvas } from '../../src';
+import { Image, readCanvas, writeCanvas } from '../../src';
 import { convertColor } from '../../src/operations/convertColor';
 import { useCameraContext } from '../contexts/cameraContext';
 
@@ -56,8 +56,8 @@ export default function CameraTransform(props: CameraTransformProps) {
                 image,
                 snapshotImageRef.current,
               );
-              if (result.colorModel !== ImageColorModel.RGBA) {
-                result = convertColor(result, ImageColorModel.RGBA);
+              if (result.colorModel !== 'RGBA') {
+                result = convertColor(result, 'RGBA');
               }
               writeCanvas(result, canvasOutput);
             } catch (err) {

demo/components/comparisonFunctions/testComputeSsim.ts

@@ -1,4 +1,4 @@
-import { Image, ImageColorModel } from '../../../src';
+import { Image } from '../../../src';
 import { computeSsim } from '../../../src/compare/computeSsim';
 
 /**
@@ -21,7 +21,7 @@ export function testComputeSsim(image: Image, snapshot: Image | null): Image {
   }
 
   const ssimMap = new Image(ssim.ssimMap.width, ssim.ssimMap.height, {
-    colorModel: ImageColorModel.GREY,
+    colorModel: 'GREY',
     data,
   });
 

demo/components/testFunctions/testCannyEdge.ts

@@ -1,4 +1,4 @@
-import { convertBinaryToGrey, Image, ImageColorModel } from '../../../src';
+import { convertBinaryToGrey, Image } from '../../../src';
 
 /**
  * Detect the edges in the image using Canny edge detection
@@ -7,7 +7,7 @@ import { convertBinaryToGrey, Image, ImageColorModel } from '../../../src';
  * @returns The treated image.
  */
 export function testCannyEdge(image: Image): Image {
-  let result = image.convertColor(ImageColorModel.GREY);
+  let result = image.convertColor('GREY');
   result = result.gaussianBlur({ size: 7, sigma: 4 });
   const edges = result.cannyEdgeDetector({
     lowThreshold: 0.08,
@@ -24,13 +24,13 @@ export function testCannyEdge(image: Image): Image {
  * @returns The treated image.
  */
 export function testCannyEdgeOverlay(image: Image): Image {
-  let result = image.convertColor(ImageColorModel.GREY);
+  let result = image.convertColor('GREY');
   const edges = result.cannyEdgeDetector({
     lowThreshold: 0.08,
     highThreshold: 0.1,
   });
-  let greyEdges = edges.convertColor(ImageColorModel.GREY);
-  greyEdges = greyEdges.convertColor(ImageColorModel.RGBA);
+  let greyEdges = edges.convertColor('GREY');
+  greyEdges = greyEdges.convertColor('RGBA');
   greyEdges = greyEdges.invert();
   for (let row = 0; row < image.height; row++) {
     for (let column = 0; column < image.width; column++) {

demo/components/testFunctions/testColorRois.ts

@@ -1,6 +1,5 @@
-import { Image, ImageColorModel } from '../../../src';
-import { fromMask, RoisColorMode, colorRois } from '../../../src/roi';
-import { RoiKind } from '../../../src/roi/getRois';
+import { Image } from '../../../src';
+import { fromMask, colorRois } from '../../../src/roi';
 
 /**
  * Make a mask out of the image and detect all ROIs. Returns only the white ROIs on a black background.
@@ -9,19 +8,19 @@ import { RoiKind } from '../../../src/roi/getRois';
  * @returns The treated image.
  */
 export function testColorRois(image: Image): Image {
-  const grey = image.convertColor(ImageColorModel.GREY);
+  const grey = image.convertColor('GREY');
   const mask = grey.threshold();
 
   const roiMapManager = fromMask(mask);
 
   let colorImage = colorRois(roiMapManager, {
-    roiKind: RoiKind.WHITE,
-    mode: RoisColorMode.RAINBOW,
+    roiKind: 'white',
+    mode: 'rainbow',
   });
 
   // create a black image
   const black = new Image(image.width, image.height, {
-    colorModel: ImageColorModel.RGBA,
+    colorModel: 'RGBA',
   });
   // overlay ROIs on the black image
   black.fill([0, 0, 0, 255]);

demo/components/testFunctions/testCopyTo.ts

@@ -1,4 +1,4 @@
-import { Image, ImageColorModel } from '../../../src';
+import { Image } from '../../../src';
 
 /**
  * Copy a black and a red square to the source image.
@@ -13,8 +13,8 @@ export function testCopyTo(image: Image): Image {
       column: image.width / 2,
     },
   });
-  let blackSquare = new Image(50, 50, { colorModel: ImageColorModel.RGBA });
-  let redSquare = new Image(150, 150, { colorModel: ImageColorModel.RGBA });
+  let blackSquare = new Image(50, 50, { colorModel: 'RGBA' });
+  let redSquare = new Image(150, 150, { colorModel: 'RGBA' });
   redSquare.fillChannel(0, 255);
   redSquare.fillAlpha(100);
   result = blackSquare.copyTo(result, {

demo/components/testFunctions/testCrop.ts

@@ -1,4 +1,4 @@
-import { DerivativeFilters, Image, ImageColorModel } from '../../../src';
+import { Image } from '../../../src';
 // options
 const cropImageRatio = 2; // defines the size of the cropped image
 const interval = 2; // defines the speed
@@ -36,10 +36,10 @@ export function testCropBounce(image: Image): Image {
   });
   const grey = cropped.grey();
   const derivative = grey.derivativeFilter({
-    filter: DerivativeFilters.PREWITT,
+    filter: 'prewitt',
   });
 
-  const rgba = derivative.convertColor(ImageColorModel.RGBA);
+  const rgba = derivative.convertColor('RGBA');
 
   return rgba.copyTo(image, { origin: { row, column } });
 }

demo/components/testFunctions/testDerivativeFilter.ts

@@ -1,4 +1,4 @@
-import { DerivativeFilters, Image, ImageColorModel } from '../../../src';
+import { Image } from '../../../src';
 
 /**
  * Apply a derivative filter to the source image.
@@ -7,6 +7,6 @@ import { DerivativeFilters, Image, ImageColorModel } from '../../../src';
  * @returns The treated image.
  */
 export function testDerivativeFilter(image: Image): Image {
-  image = image.convertColor(ImageColorModel.GREY);
-  return image.derivativeFilter({ filter: DerivativeFilters.PREWITT });
+  image = image.convertColor('GREY');
+  return image.derivativeFilter({ filter: 'prewitt' });
 }

demo/components/testFunctions/testExtract.ts

@@ -1,5 +1,4 @@
-import { fromMask, Image, ImageColorModel } from '../../../src';
-import { RoiKind } from '../../../src/roi/getRois';
+import { fromMask, Image } from '../../../src';
 
 /**
  * Extract the pixels of a mask from the image.
@@ -9,12 +8,12 @@ import { RoiKind } from '../../../src/roi/getRois';
  */
 export function testExtract(image: Image): Image {
   const background = new Image(image.width, image.height, {
-    colorModel: ImageColorModel.RGBA,
+    colorModel: 'RGBA',
   });
 
   background.fill([0, 255, 0, 255]);
 
-  const grey = image.convertColor(ImageColorModel.GREY);
+  const grey = image.convertColor('GREY');
   const mask = grey.threshold();
 
   const extracted = image.extract(mask);
@@ -28,11 +27,11 @@ export function testExtract(image: Image): Image {
  * @returns - The extracted ROI.
  */
 export function testExtractRoi(image: Image): Image {
-  const grey = image.convertColor(ImageColorModel.GREY);
+  const grey = image.convertColor('GREY');
   const mask = grey.threshold();
 
   const roiMapManager = fromMask(mask);
-  const rois = roiMapManager.getRois({ kind: RoiKind.WHITE, minSurface: 100 });
+  const rois = roiMapManager.getRois({ kind: 'white', minSurface: 100 });
 
   const roiMask = rois[0].getMask();
 

demo/components/testFunctions/testGetBorderPoints.ts

@@ -1,17 +1,16 @@
-import { fromMask, Image, ImageColorModel, Mask } from '../../../src';
-import { RoiKind } from '../../../src/roi/getRois';
+import { fromMask, Image, Mask } from '../../../src';
 /**
  * Paint the border of the larger black ROI on the image.
  * @param image The image to process
  * @returns The processed image.
  */
 export function testGetBorderPoints(image: Image): Image {
-  const grey = image.convertColor(ImageColorModel.GREY);
+  const grey = image.convertColor('GREY');
   const mask = grey.threshold();
 
   const roiMapManager = fromMask(mask);
 
-  const rois = roiMapManager.getRois({ kind: RoiKind.BLACK });
+  const rois = roiMapManager.getRois({ kind: 'black' });
 
   const roi = rois.sort((a, b) => b.surface - a.surface)[0];
 

demo/components/testFunctions/testGetConvexHull.ts

@@ -1,5 +1,4 @@
-import { fromMask, Image, ImageColorModel } from '../../../src';
-import { RoiKind } from '../../../src/roi/getRois';
+import { fromMask, Image } from '../../../src';
 
 /**
  * Draw the convex Hull polygon of the largest ROI in green and display the filled ROI in purple.
@@ -8,11 +7,11 @@ import { RoiKind } from '../../../src/roi/getRois';
  * @returns The image with the convex Hull.
  */
 export function testGetConvexHull(image: Image): Image {
-  const grey = image.convertColor(ImageColorModel.GREY);
+  const grey = image.convertColor('GREY');
   const mask = grey.threshold({ threshold: 35 });
   const roiMapManager = fromMask(mask);
 
-  const rois = roiMapManager.getRois({ kind: RoiKind.BLACK });
+  const rois = roiMapManager.getRois({ kind: 'black' });
 
   const roi = rois.sort((a, b) => b.surface - a.surface)[0];
   if (roi) {