image-js 1.0.0-alpha.3 → 1.0.0

package/lib/correctColor/utils/formatData.js

@@ -0,0 +1,60 @@
+import { colord, extend } from 'colord';
+import labPlugin from 'colord/plugins/lab';
+import { getRegressionVariables } from '../correctColor.js';
+// We can't use ts-expect-error because it's not an error when compiling for CJS.
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore Module exports are not correctly typed.
+extend([labPlugin]);
+/**
+ * Convert RGB array colors to RGB object colors. Used to get the properly formatted measured colors.
+ * @param arrayColors - Array of RGB colors as 3 elements array.
+ * @returns Array of RGB objects.
+ */
+export function getMeasuredColors(arrayColors) {
+    const objectColors = [];
+    for (const color of arrayColors) {
+        objectColors.push({ r: color[0], g: color[1], b: color[2] });
+    }
+    return objectColors;
+}
+/**
+ * Extract the colors from a QP card and convert them to RGB.
+ * @param qpCard - QP card containing the color reference values in L*a*b*.
+ * @returns Array of reference RGB colors.
+ */
+export function getReferenceColors(qpCard) {
+    const result = [];
+    for (const square of qpCard) {
+        result.push(colord(square.lab).toRgb());
+    }
+    return result;
+}
+/**
+ * Format and normalize data from a QP card to use as a reference in a multivariate linear regression.
+ * @param referenceColors - Array of RGB colors used as a reference.
+ * @param maxValue - Maximal acceptable value for the image to process.
+ * @returns The formatted data.
+ */
+export function formatReferenceForMlr(referenceColors, maxValue) {
+    const referenceData = { r: [], g: [], b: [] };
+    for (const color of referenceColors) {
+        referenceData.r.push([color.r / maxValue]);
+        referenceData.g.push([color.g / maxValue]);
+        referenceData.b.push([color.b / maxValue]);
+    }
+    return referenceData;
+}
+/**
+ * Compute the variables for the multivariate linear regression based on the the input colors. Values are normalized between 0 and 1.
+ * @param inputColors - The input colors as an array of rgb objects.
+ * @param maxValue - Maximal acceptable value for the image to process.
+ * @returns The formatted input data for the regression.
+ */
+export function formatInputForMlr(inputColors, maxValue) {
+    const inputData = [];
+    for (const color of inputColors) {
+        inputData.push(getRegressionVariables(color.r, color.g, color.b, maxValue));
+    }
+    return inputData;
+}
+//# sourceMappingURL=formatData.js.map

package/lib/correctColor/utils/formatData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatData.js","sourceRoot":"","sources":["../../../src/correctColor/utils/formatData.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAI5D,iFAAiF;AACjF,6DAA6D;AAC7D,qDAAqD;AACrD,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AAWpB;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,WAAuB;IACvD,MAAM,YAAY,GAAG,EAAE,CAAC;IACxB,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAiB;IAClD,MAAM,MAAM,GAAe,EAAE,CAAC;IAC9B,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,eAA2B,EAC3B,QAAgB;IAEhB,MAAM,aAAa,GAAwB,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;IAEnE,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;QACpC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;QAC3C,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;QAC3C,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,WAAuB,EACvB,QAAgB;IAEhB,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/lib/correctColor/utils/getImageColors.d.ts

@@ -0,0 +1,9 @@
+import type { RgbColor } from 'colord';
+import type { Image } from '../../Image.js';
+/**
+ * Extract the colors of an image in order to use them for color correction. Should be used on small images only (smaller than 10x10 pixels), because it is these colors that will be used in the model (MLR).
+ * @param image - Image from which to get the colors.
+ * @returns Array of colors.
+ */
+export declare function getImageColors(image: Image): RgbColor[];
+//# sourceMappingURL=getImageColors.d.ts.map

package/lib/correctColor/utils/getImageColors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getImageColors.d.ts","sourceRoot":"","sources":["../../../src/correctColor/utils/getImageColors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAEvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,QAAQ,EAAE,CAavD"}

package/lib/correctColor/utils/getImageColors.js

@@ -0,0 +1,19 @@
+/**
+ * Extract the colors of an image in order to use them for color correction. Should be used on small images only (smaller than 10x10 pixels), because it is these colors that will be used in the model (MLR).
+ * @param image - Image from which to get the colors.
+ * @returns Array of colors.
+ */
+export function getImageColors(image) {
+    const colors = [];
+    for (let row = 0; row < image.height; row++) {
+        for (let column = 0; column < image.width; column++) {
+            colors.push({
+                r: image.getValue(column, row, 0),
+                g: image.getValue(column, row, 1),
+                b: image.getValue(column, row, 2),
+            });
+        }
+    }
+    return colors;
+}
+//# sourceMappingURL=getImageColors.js.map

package/lib/correctColor/utils/getImageColors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getImageColors.js","sourceRoot":"","sources":["../../../src/correctColor/utils/getImageColors.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAAY;IACzC,MAAM,MAAM,GAAe,EAAE,CAAC;IAE9B,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAC5C,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;YACpD,MAAM,CAAC,IAAI,CAAC;gBACV,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;gBACjC,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;gBACjC,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;aAClC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/correctColor/utils/referenceColorCard.d.ts

@@ -0,0 +1,42 @@
+import type { LabColor } from 'colord';
+export interface ColorCardSquare {
+    /**
+     * Name of the color.
+     */
+    name: string;
+    /**
+     * Color of the square in the L*a*b* format.
+     *   - l in range [0,100] (percents)
+     *   - a and b as a value in range [-128, 127]
+     *   - a is green to red and b is blue to yellow.
+     */
+    lab: LabColor;
+    /**
+     * Row of the square.
+     */
+    row: number;
+    /**
+     * Color of the square.
+     */
+    column: number;
+    /**
+     * Index in the squares matrix.
+     */
+    index: number;
+}
+export type ColorCard = ColorCardSquare[];
+/**
+ * The color card reference values in the L*a*b* format.
+ */
+export declare const referenceColorCard: {
+    name: string;
+    lab: {
+        l: number;
+        a: number;
+        b: number;
+    };
+    row: number;
+    column: number;
+    index: number;
+}[];
+//# sourceMappingURL=referenceColorCard.d.ts.map

package/lib/correctColor/utils/referenceColorCard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenceColorCard.d.ts","sourceRoot":"","sources":["../../../src/correctColor/utils/referenceColorCard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAEvC,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,GAAG,EAAE,QAAQ,CAAC;IACd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,EAAE,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;GA6I9B,CAAC"}

package/lib/correctColor/utils/referenceColorCard.js

@@ -0,0 +1,146 @@
+/**
+ * The color card reference values in the L*a*b* format.
+ */
+export const referenceColorCard = [
+    {
+        name: 'Cyan',
+        lab: { l: 51.9, a: -31.8, b: -50.4 },
+        row: 0,
+        column: 0,
+        index: 0,
+    },
+    {
+        name: 'P.485',
+        lab: { l: 54.2, a: 67.5, b: 40.3 },
+        row: 0,
+        column: 1,
+        index: 1,
+    },
+    {
+        name: 'P.130',
+        lab: { l: 79.1, a: 20, b: 69.1 },
+        row: 0,
+        column: 2,
+        index: 2,
+    },
+    {
+        name: 'P.477',
+        lab: { l: 33.5, a: 15.2, b: 12.5 },
+        row: 0,
+        column: 3,
+        index: 3,
+    },
+    {
+        name: 'P.7451',
+        lab: { l: 64.7, a: -4.7, b: -28 },
+        row: 0,
+        column: 4,
+        index: 4,
+    },
+    {
+        name: 'Magenta',
+        lab: { l: 50, a: 73.8, b: 4.1 },
+        row: 1,
+        column: 0,
+        index: 5,
+    },
+    {
+        name: 'P.361',
+        lab: { l: 56.4, a: -48.2, b: 41.8 },
+        row: 1,
+        column: 1,
+        index: 6,
+    },
+    {
+        name: 'P.520',
+        lab: { l: 29.5, a: 28.2, b: -18.4 },
+        row: 1,
+        column: 2,
+        index: 7,
+    },
+    {
+        name: 'P.575',
+        lab: { l: 48.3, a: -11, b: 30.9 },
+        row: 1,
+        column: 3,
+        index: 8,
+    },
+    {
+        name: 'P.710',
+        lab: { l: 56.3, a: 56.6, b: 27.2 },
+        row: 1,
+        column: 4,
+        index: 9,
+    },
+    {
+        name: 'Yellow',
+        lab: { l: 91.7, a: -5.4, b: 80.6 },
+        row: 2,
+        column: 0,
+        index: 10,
+    },
+    {
+        name: 'Reflex Blue',
+        lab: { l: 23.3, a: 24.2, b: -68.1 },
+        row: 2,
+        column: 1,
+        index: 11,
+    },
+    {
+        name: 'P.646',
+        lab: { l: 54.7, a: -7.3, b: -24.2 },
+        row: 2,
+        column: 2,
+        index: 12,
+    },
+    {
+        name: 'P.151',
+        lab: { l: 72.6, a: 44.7, b: 64 },
+        row: 2,
+        column: 3,
+        index: 13,
+    },
+    {
+        name: 'White',
+        lab: { l: 97.7, a: -1, b: 0.1 },
+        row: 2,
+        column: 4,
+        index: 14,
+    },
+    {
+        name: 'Black',
+        lab: { l: 16.7, a: -2.2, b: 2 },
+        row: 3,
+        column: 0,
+        index: 15,
+    },
+    {
+        name: 'P.CG 10',
+        lab: { l: 43.8, a: -0.8, b: -0.8 },
+        row: 3,
+        column: 1,
+        index: 16,
+    },
+    {
+        name: 'P.CG 8',
+        lab: { l: 60.6, a: -0.5, b: -2 },
+        row: 3,
+        column: 2,
+        index: 17,
+    },
+    {
+        name: 'P.CG 5',
+        lab: { l: 72.6, a: -1, b: 0.6 },
+        row: 3,
+        column: 3,
+        index: 18,
+    },
+    {
+        name: 'P.CG 2',
+        lab: { l: 86.1, a: -1.7, b: 3 },
+        row: 3,
+        column: 4,
+        index: 19,
+    },
+];
+//# sourceMappingURL=referenceColorCard.js.map

package/lib/correctColor/utils/referenceColorCard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenceColorCard.js","sourceRoot":"","sources":["../../../src/correctColor/utils/referenceColorCard.ts"],"names":[],"mappings":"AA8BA;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC;QACE,IAAI,EAAE,MAAM;QACZ,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE;QACpC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE;QAClC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE;QAChC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE;QAClC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;QACjC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE;QAC/B,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE;QACnC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE;QACnC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE;QACjC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE;QAClC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,CAAC;KACT;IACD;QACE,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE;QAClC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,aAAa;QACnB,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE;QACnC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE;QACnC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE;QAChC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAC/B,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE;QAC/B,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,SAAS;QACf,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE;QAClC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE;QAChC,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAC/B,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;IACD;QACE,IAAI,EAAE,QAAQ;QACd,GAAG,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE;QAC/B,GAAG,EAAE,CAAC;QACN,MAAM,EAAE,CAAC;QACT,KAAK,EAAE,EAAE;KACV;CACF,CAAC"}

package/lib/draw/drawCircleOnImage.d.ts

@@ -0,0 +1,28 @@
+import type { Image } from '../Image.js';
+import type { Point } from '../utils/geometry/points.js';
+export interface DrawCircleOnImageOptions {
+    /**
+     * Circle border color - An array of numerical values, one for each channel of the image. If less values are defined than there are channels in the image, the remaining channels will be set to 0.
+     * @default A black pixel.
+     */
+    strokeColor?: number[];
+    /**
+     * Circle fill color - An array of numerical values, one for each channel of the image. If less values are defined than there are channels in the image, the remaining channels will be set to 0.
+     *
+     */
+    fillColor?: number[];
+    /**
+     * Image to which the resulting image has to be put.
+     */
+    out?: Image;
+}
+/**
+ * Draw a circle defined by center and radius.
+ * @param image - Image to process.
+ * @param center - Circle center point.
+ * @param radius - Circle radius.
+ * @param options - Draw circle options.
+ * @returns The original drawn image.
+ */
+export declare function drawCircleOnImage(image: Image, center: Point, radius: number, options?: DrawCircleOnImageOptions): Image;
+//# sourceMappingURL=drawCircleOnImage.d.ts.map

package/lib/draw/drawCircleOnImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawCircleOnImage.d.ts","sourceRoot":"","sources":["../../src/draw/drawCircleOnImage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAWzD,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;CACb;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,KAAK,EACb,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,wBAA6B,GACrC,KAAK,CA6EP"}

package/lib/draw/drawCircleOnImage.js

@@ -0,0 +1,75 @@
+import { circle } from 'bresenham-zingl';
+import { getDefaultColor } from '../utils/getDefaultColor.js';
+import { getOutputImage } from '../utils/getOutputImage.js';
+import { setBlendedVisiblePixel } from '../utils/setBlendedVisiblePixel.js';
+import checkProcessable from '../utils/validators/checkProcessable.js';
+import { validateColor } from '../utils/validators/validators.js';
+import { roundPoint } from './utils/roundPoint.js';
+/**
+ * Draw a circle defined by center and radius.
+ * @param image - Image to process.
+ * @param center - Circle center point.
+ * @param radius - Circle radius.
+ * @param options - Draw circle options.
+ * @returns The original drawn image.
+ */
+export function drawCircleOnImage(image, center, radius, options = {}) {
+    const newImage = getOutputImage(image, options, { clone: true });
+    const { strokeColor = getDefaultColor(newImage), fillColor } = options;
+    validateColor(strokeColor, newImage);
+    checkProcessable(newImage, {
+        bitDepth: [8, 16],
+    });
+    if (radius < 0) {
+        throw new RangeError('circle radius must be positive');
+    }
+    center = roundPoint(center);
+    radius = Math.round(radius);
+    if (radius === 0) {
+        setBlendedVisiblePixel(newImage, center.column, center.row, strokeColor);
+        return newImage;
+    }
+    if (!fillColor) {
+        circle(center.column, center.row, radius, (column, row) => {
+            setBlendedVisiblePixel(newImage, column, row, strokeColor);
+        });
+    }
+    else {
+        if (radius === 1) {
+            setBlendedVisiblePixel(newImage, center.column, center.row, fillColor);
+        }
+        //Starting points for the top and bottom row of the circle.
+        let prevRow = center.row + radius;
+        let index = 0;
+        circle(center.column, center.row, radius, (column, row) => {
+            setBlendedVisiblePixel(newImage, column, row, strokeColor);
+            // Filling the first line of the circle.
+            if (index === 0) {
+                newImage.drawLine({ row, column: column - 1 }, {
+                    row,
+                    column: center.column - (column - center.column - 1),
+                }, { strokeColor: fillColor, out: newImage });
+            }
+            // The algorithm used is Bresenham's circle algorithm (@link https://www.geeksforgeeks.org/bresenhams-circle-drawing-algorithm/) to find points that constitute the circle outline. However, in this algorithm The circle is divided in 4 parts instead of 8: top, right, bottom and left.
+            // The algorithm draws a point per quadrant until the circle is complete.
+            // We use bottom (index % 4 === 1, quadrant 2) point of the outline to fill the circle with color.
+            // Filling half of the circle.
+            if (index % 4 === 1 && prevRow !== row) {
+                // For quadrant 2, column < center.column
+                newImage.drawLine({ row, column: column + 1 }, {
+                    row,
+                    column: center.column - (column - center.column + 1),
+                }, { strokeColor: fillColor, out: newImage });
+                prevRow = row;
+                // Filling top half of the circle.
+                newImage.drawLine({ row: center.row - (row - center.row), column: column + 1 }, {
+                    row: center.row - (row - center.row),
+                    column: center.column - (column - center.column + 1),
+                }, { strokeColor: fillColor, out: newImage });
+            }
+            index++;
+        });
+    }
+    return newImage;
+}
+//# sourceMappingURL=drawCircleOnImage.js.map

package/lib/draw/drawCircleOnImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawCircleOnImage.js","sourceRoot":"","sources":["../../src/draw/drawCircleOnImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAIzC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,gBAAgB,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAsBnD;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAY,EACZ,MAAa,EACb,MAAc,EACd,UAAoC,EAAE;IAEtC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,EAAE,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAEvE,aAAa,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAErC,gBAAgB,CAAC,QAAQ,EAAE;QACzB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;KAClB,CAAC,CAAC;IAEH,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACf,MAAM,IAAI,UAAU,CAAC,gCAAgC,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;QACjB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACzE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE;YACxE,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACjB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACzE,CAAC;QACD,2DAA2D;QAC3D,IAAI,OAAO,GAAG,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC;QAElC,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE;YACxE,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;YAC3D,wCAAwC;YACxC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAChB,QAAQ,CAAC,QAAQ,CACf,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,EAC3B;oBACE,GAAG;oBACH,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;iBACrD,EACD,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC1C,CAAC;YACJ,CAAC;YACD,0RAA0R;YAC1R,yEAAyE;YACzE,kGAAkG;YAClG,8BAA8B;YAC9B,IAAI,KAAK,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC;gBACvC,yCAAyC;gBACzC,QAAQ,CAAC,QAAQ,CACf,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,EAC3B;oBACE,GAAG;oBACH,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;iBACrD,EACD,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC1C,CAAC;gBACF,OAAO,GAAG,GAAG,CAAC;gBACd,kCAAkC;gBAClC,QAAQ,CAAC,QAAQ,CACf,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,EAC5D;oBACE,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;oBACpC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;iBACrD,EACD,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC1C,CAAC;YACJ,CAAC;YAED,KAAK,EAAE,CAAC;QACV,CAAC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/lib/draw/drawLineOnImage.d.ts

@@ -0,0 +1,28 @@
+import type { Image } from '../Image.js';
+import type { Point } from '../utils/geometry/points.js';
+export interface DrawLineOnImageOptions {
+    /**
+     * Color of the line - An array of numerical values, one for each channel of the image. If less values are defined than there are channels in the image, the remaining channels will be set to 0.
+     * @default A black pixel.
+     */
+    strokeColor?: number[];
+    /**
+     * Origin of the line relative to a parent image (top-left corner).
+     * @default `{row: 0, column: 0}`
+     */
+    origin?: Point;
+    /**
+     * Image to which the resulting image has to be put.
+     */
+    out?: Image;
+}
+/**
+ * Draw a line defined by two points onto an image.
+ * @param image - Image to process.
+ * @param from - Line starting point.
+ * @param to - Line ending point.
+ * @param options - Draw Line options.
+ * @returns The mask with the line drawing.
+ */
+export declare function drawLineOnImage(image: Image, from: Point, to: Point, options?: DrawLineOnImageOptions): Image;
+//# sourceMappingURL=drawLineOnImage.d.ts.map

package/lib/draw/drawLineOnImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawLineOnImage.d.ts","sourceRoot":"","sources":["../../src/draw/drawLineOnImage.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAOzD,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;CACb;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,KAAK,EACX,EAAE,EAAE,KAAK,EACT,OAAO,GAAE,sBAA2B,GACnC,KAAK,CAuBP"}

package/lib/draw/drawLineOnImage.js

@@ -0,0 +1,27 @@
+import { line } from 'bresenham-zingl';
+import { getDefaultColor } from '../utils/getDefaultColor.js';
+import { getOutputImage } from '../utils/getOutputImage.js';
+import { setBlendedVisiblePixel } from '../utils/setBlendedVisiblePixel.js';
+import checkProcessable from '../utils/validators/checkProcessable.js';
+import { validateColor } from '../utils/validators/validators.js';
+/**
+ * Draw a line defined by two points onto an image.
+ * @param image - Image to process.
+ * @param from - Line starting point.
+ * @param to - Line ending point.
+ * @param options - Draw Line options.
+ * @returns The mask with the line drawing.
+ */
+export function drawLineOnImage(image, from, to, options = {}) {
+    const newImage = getOutputImage(image, options, { clone: true });
+    const { strokeColor = getDefaultColor(newImage), origin = { column: 0, row: 0 }, } = options;
+    validateColor(strokeColor, newImage);
+    checkProcessable(newImage, {
+        bitDepth: [8, 16],
+    });
+    line(Math.round(origin.column + from.column), Math.round(origin.row + from.row), Math.round(origin.column + to.column), Math.round(origin.row + to.row), (column, row) => {
+        setBlendedVisiblePixel(newImage, column, row, strokeColor);
+    });
+    return newImage;
+}
+//# sourceMappingURL=drawLineOnImage.js.map

package/lib/draw/drawLineOnImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawLineOnImage.js","sourceRoot":"","sources":["../../src/draw/drawLineOnImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAIvC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,gBAAgB,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAmBlE;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAY,EACZ,IAAW,EACX,EAAS,EACT,UAAkC,EAAE;IAEpC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,EACJ,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,EACvC,MAAM,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAC/B,GAAG,OAAO,CAAC;IAEZ,aAAa,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAErC,gBAAgB,CAAC,QAAQ,EAAE;QACzB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;KAClB,CAAC,CAAC;IAEH,IAAI,CACF,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,EACvC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EACjC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,EACrC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAC/B,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE;QAC9B,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC,CACF,CAAC;IACF,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/lib/draw/drawLineOnMask.d.ts

@@ -0,0 +1,23 @@
+import type { Mask } from '../Mask.js';
+import type { Point } from '../utils/geometry/points.js';
+export interface DrawLineOnMaskOptions {
+    /**
+     * Origin of the line relative to a parent image (top-left corner).
+     * @default `{row: 0, column: 0}`
+     */
+    origin?: Point;
+    /**
+     * Mask to which the result has to be put.
+     */
+    out?: Mask;
+}
+/**
+ * Draw a line defined by two points onto a mask.
+ * @param mask - Mask to process.
+ * @param from - Line starting point.
+ * @param to - Line ending point.
+ * @param options - Draw Line options.
+ * @returns The mask with the line drawing.
+ */
+export declare function drawLineOnMask(mask: Mask, from: Point, to: Point, options?: DrawLineOnMaskOptions): Mask;
+//# sourceMappingURL=drawLineOnMask.d.ts.map

package/lib/draw/drawLineOnMask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawLineOnMask.d.ts","sourceRoot":"","sources":["../../src/draw/drawLineOnMask.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAGzD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC;CACZ;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,KAAK,EACX,EAAE,EAAE,KAAK,EACT,OAAO,GAAE,qBAA0B,GAClC,IAAI,CAaN"}

package/lib/draw/drawLineOnMask.js

@@ -0,0 +1,19 @@
+import { line } from 'bresenham-zingl';
+import { maskToOutputMask } from '../utils/getOutputImage.js';
+/**
+ * Draw a line defined by two points onto a mask.
+ * @param mask - Mask to process.
+ * @param from - Line starting point.
+ * @param to - Line ending point.
+ * @param options - Draw Line options.
+ * @returns The mask with the line drawing.
+ */
+export function drawLineOnMask(mask, from, to, options = {}) {
+    const { origin = { column: 0, row: 0 } } = options;
+    const newMask = maskToOutputMask(mask, options, { clone: true });
+    line(Math.round(origin.column + from.column), Math.round(origin.row + from.row), Math.round(origin.column + to.column), Math.round(origin.row + to.row), (column, row) => {
+        newMask.setVisiblePixel(column, row, [1]);
+    });
+    return newMask;
+}
+//# sourceMappingURL=drawLineOnMask.js.map

package/lib/draw/drawLineOnMask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawLineOnMask.js","sourceRoot":"","sources":["../../src/draw/drawLineOnMask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAIvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAc9D;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,IAAU,EACV,IAAW,EACX,EAAS,EACT,UAAiC,EAAE;IAEnC,MAAM,EAAE,MAAM,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC;IACnD,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,IAAI,CACF,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,EACvC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EACjC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC,MAAM,CAAC,EACrC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,EAC/B,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE;QAC9B,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC,CACF,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/draw/drawMarker.d.ts

@@ -0,0 +1,36 @@
+import type { Image } from '../Image.js';
+import type { Point } from '../geometry/index.js';
+export interface DrawMarkerOptions {
+    /**
+     * Marker size, Odd number greater than 1.
+     * @default `1`
+     */
+    size?: number;
+    /**
+     * Marker shape.
+     * @default `'cross'`
+     */
+    shape?: 'circle' | 'triangle' | 'cross' | 'square';
+    /**
+     * Circle border color - An array of numerical values, one for each channel of the image. If less values are defined than there are channels in the image, the remaining channels will be set to 0.
+     */
+    fillColor?: number[];
+    /**
+     * Circle border color - An array of numerical values, one for each channel of the image. If less values are defined than there are channels in the image, the remaining channels will be set to 0.
+     * @default A black pixel.
+     */
+    strokeColor?: number[];
+    /**
+     * Image to which the resulting image has to be put.
+     */
+    out?: Image;
+}
+/**
+ * Draw a marker on the image.
+ * @param image - Image to process.
+ * @param point - Marker center point.
+ * @param options - Draw marker options.
+ * @returns The image with the marker drawing.
+ */
+export declare function drawMarker(image: Image, point: Point, options: DrawMarkerOptions): Image;
+//# sourceMappingURL=drawMarker.d.ts.map

package/lib/draw/drawMarker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawMarker.d.ts","sourceRoot":"","sources":["../../src/draw/drawMarker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAMlD,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;IACnD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;CACb;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,iBAAiB,GACzB,KAAK,CA+DP"}

package/lib/draw/drawMarker.js

@@ -0,0 +1,62 @@
+import { getDefaultColor } from '../utils/getDefaultColor.js';
+import { getOutputImage } from '../utils/getOutputImage.js';
+import checkProcessable from '../utils/validators/checkProcessable.js';
+import { validateColor } from '../utils/validators/validators.js';
+/**
+ * Draw a marker on the image.
+ * @param image - Image to process.
+ * @param point - Marker center point.
+ * @param options - Draw marker options.
+ * @returns The image with the marker drawing.
+ */
+export function drawMarker(image, point, options) {
+    const newImage = getOutputImage(image, options, { clone: true });
+    const { strokeColor = getDefaultColor(newImage), fillColor, shape = 'cross', size: markerSize = 1, } = options;
+    const size = Math.round(markerSize);
+    validateColor(strokeColor, newImage);
+    if (fillColor) {
+        validateColor(fillColor, newImage);
+    }
+    checkProcessable(newImage, {
+        bitDepth: [8, 16],
+    });
+    if (shape === 'circle') {
+        newImage.drawCircle(point, size, {
+            strokeColor,
+            fillColor,
+            out: newImage,
+        });
+    }
+    if (shape === 'triangle') {
+        const points = [
+            { row: point.row - size, column: point.column },
+            { row: point.row, column: point.column + size },
+            { row: point.row, column: point.column - size },
+        ];
+        newImage.drawPolygon(points, {
+            strokeColor,
+            fillColor,
+            out: newImage,
+        });
+    }
+    if (shape === 'cross') {
+        newImage.drawLine({ row: point.row - size, column: point.column }, { row: point.row + size, column: point.column }, { strokeColor, out: newImage });
+        newImage.drawLine({ row: point.row, column: point.column - size }, { row: point.row, column: point.column + size }, { strokeColor, out: newImage });
+    }
+    if (shape === 'square') {
+        const origin = {
+            row: point.row - (size - 1) / 2,
+            column: point.column - (size - 1) / 2,
+        };
+        newImage.drawRectangle({
+            origin,
+            width: size,
+            height: size,
+            strokeColor,
+            fillColor,
+            out: newImage,
+        });
+    }
+    return newImage;
+}
+//# sourceMappingURL=drawMarker.js.map

package/lib/draw/drawMarker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawMarker.js","sourceRoot":"","sources":["../../src/draw/drawMarker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,gBAAgB,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AA4BlE;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CACxB,KAAY,EACZ,KAAY,EACZ,OAA0B;IAE1B,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,MAAM,EACJ,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,EACvC,SAAS,EACT,KAAK,GAAG,OAAO,EACf,IAAI,EAAE,UAAU,GAAG,CAAC,GACrB,GAAG,OAAO,CAAC;IACZ,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpC,aAAa,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrC,IAAI,SAAS,EAAE,CAAC;QACd,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,gBAAgB,CAAC,QAAQ,EAAE;QACzB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;KAClB,CAAC,CAAC;IACH,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvB,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE;YAC/B,WAAW;YACX,SAAS;YACT,GAAG,EAAE,QAAQ;SACd,CAAC,CAAC;IACL,CAAC;IACD,IAAI,KAAK,KAAK,UAAU,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG;YACb,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;YAC/C,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE;YAC/C,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE;SAChD,CAAC;QACF,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE;YAC3B,WAAW;YACX,SAAS;YACT,GAAG,EAAE,QAAQ;SACd,CAAC,CAAC;IACL,CAAC;IACD,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QACtB,QAAQ,CAAC,QAAQ,CACf,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAC/C,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAC/C,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC/B,CAAC;QACF,QAAQ,CAAC,QAAQ,CACf,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,EAC/C,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,EAC/C,EAAE,WAAW,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC/B,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG;YACb,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC;YAC/B,MAAM,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC;SACtC,CAAC;QACF,QAAQ,CAAC,aAAa,CAAC;YACrB,MAAM;YACN,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,WAAW;YACX,SAAS;YACT,GAAG,EAAE,QAAQ;SACd,CAAC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}