image-js 0.0.0-next-e30968a2d8

package/lib-esm/utils/borderIterator.js

@@ -0,0 +1,21 @@
+/**
+ * Create function that allows to iterate on the pixels of the border of an image.
+ *
+ * @param image - Image for which to create the border iterator.
+ * @yields - Index of the border pixel.
+ */
+export function* borderIterator(image) {
+    for (let col = 0; col < image.width; col++) {
+        yield col;
+    }
+    for (let row = 2; row < image.height; row++) {
+        yield row * image.width - 1;
+    }
+    for (let col = 0; col < image.width; col++) {
+        yield image.width * image.height - col - 1;
+    }
+    for (let row = image.height - 2; row >= 1; row--) {
+        yield row * image.width;
+    }
+}
+//# sourceMappingURL=borderIterator.js.map

package/lib-esm/utils/borderIterator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"borderIterator.js","sourceRoot":"","sources":["../../src/utils/borderIterator.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,SAAS,CAAC,CAAC,cAAc,CAAC,KAAiB;IAC/C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC1C,MAAM,GAAG,CAAC;KACX;IACD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;KAC7B;IACD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC1C,MAAM,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC;KAC5C;IACD,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE;QAChD,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC;KACzB;AACH,CAAC"}

package/lib-esm/utils/checkKernel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks the that the dimensions of the kernel are odd.
+ *
+ * @param kernel - Kernel passed to a morphology function.
+ * @param functionName - Name of the function.
+ */
+export declare function checkKernel(kernel: number[][], functionName: string): void;
+//# sourceMappingURL=checkKernel.d.ts.map

package/lib-esm/utils/checkKernel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkKernel.d.ts","sourceRoot":"","sources":["../../src/utils/checkKernel.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,QAMnE"}

package/lib-esm/utils/checkKernel.js

@@ -0,0 +1,12 @@
+/**
+ * Checks the that the dimensions of the kernel are odd.
+ *
+ * @param kernel - Kernel passed to a morphology function.
+ * @param functionName - Name of the function.
+ */
+export function checkKernel(kernel, functionName) {
+    if (kernel.length % 2 === 0 || kernel[0].length % 2 === 0) {
+        throw new TypeError(`${functionName}: The number of rows and columns of the kernel must be odd`);
+    }
+}
+//# sourceMappingURL=checkKernel.js.map

package/lib-esm/utils/checkKernel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkKernel.js","sourceRoot":"","sources":["../../src/utils/checkKernel.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,MAAkB,EAAE,YAAoB;IAClE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE;QACzD,MAAM,IAAI,SAAS,CACjB,GAAG,YAAY,4DAA4D,CAC5E,CAAC;KACH;AACH,CAAC"}

package/lib-esm/utils/checkProcessable.d.ts

@@ -0,0 +1,18 @@
+import { ColorDepth, IJS, ImageColorModel } from '..';
+interface CheckOptions {
+    bitDepth?: ColorDepth[] | ColorDepth;
+    alpha?: boolean[] | boolean;
+    colorModel?: ImageColorModel[] | ImageColorModel;
+    components?: number[] | number;
+    channels?: number[] | number;
+}
+/**
+ * This method checks if a process can be applied on the current image
+ *
+ * @param image - Image for which compatibility has to be checked
+ * @param processName - Name of the process to apply
+ * @param options - Check processable options
+ */
+export default function checkProcessable(image: IJS, processName: string, options?: CheckOptions): void;
+export {};
+//# sourceMappingURL=checkProcessable.d.ts.map

package/lib-esm/utils/checkProcessable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkProcessable.d.ts","sourceRoot":"","sources":["../../src/utils/checkProcessable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,IAAI,CAAC;AAKtD,UAAU,YAAY;IACpB,QAAQ,CAAC,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,KAAK,EAAE,GAAG,EACV,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,YAAiB,QAoE3B"}

package/lib-esm/utils/checkProcessable.js

@@ -0,0 +1,62 @@
+// @ts-expect-error Intl types don't exist yet
+const formatter = new Intl.ListFormat('en', { type: 'disjunction' });
+/**
+ * This method checks if a process can be applied on the current image
+ *
+ * @param image - Image for which compatibility has to be checked
+ * @param processName - Name of the process to apply
+ * @param options - Check processable options
+ */
+export default function checkProcessable(image, processName, options = {}) {
+    let { bitDepth, alpha, colorModel, components, channels } = options;
+    if (bitDepth) {
+        if (!Array.isArray(bitDepth)) {
+            bitDepth = [bitDepth];
+        }
+        if (!bitDepth.includes(image.depth)) {
+            throw new TypeError(`The process "${processName}" can only be applied if bit depth is ${format(bitDepth)}`);
+        }
+    }
+    if (alpha) {
+        if (!Array.isArray(alpha)) {
+            alpha = [alpha];
+        }
+        if (!alpha.includes(image.alpha)) {
+            throw new TypeError(`The process "${processName}" can only be applied if alpha is ${format(alpha)}`);
+        }
+    }
+    if (colorModel) {
+        if (!Array.isArray(colorModel)) {
+            colorModel = [colorModel];
+        }
+        if (!colorModel.includes(image.colorModel)) {
+            throw new TypeError(`The process "${processName}" can only be applied if color model is ${format(colorModel)}`);
+        }
+    }
+    if (components) {
+        if (!Array.isArray(components)) {
+            components = [components];
+        }
+        if (!components.includes(image.components)) {
+            let errorMessage = `The process "${processName}" can only be applied if the number of components is ${format(components)}`;
+            if (components.length === 1 && components[0] === 1) {
+                throw new TypeError(`${errorMessage}.\rYou should transform your image using "image.grey()" before applying the algorithm.`);
+            }
+            else {
+                throw new TypeError(errorMessage);
+            }
+        }
+    }
+    if (channels) {
+        if (!Array.isArray(channels)) {
+            channels = [channels];
+        }
+        if (!channels.includes(image.channels)) {
+            throw new TypeError(`The process "${processName}" can only be applied if the number of channels is ${format(channels)}`);
+        }
+    }
+}
+function format(array) {
+    return formatter.format(array.map((element) => String(element)));
+}
+//# sourceMappingURL=checkProcessable.js.map

package/lib-esm/utils/checkProcessable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkProcessable.js","sourceRoot":"","sources":["../../src/utils/checkProcessable.ts"],"names":[],"mappings":"AAEA,8CAA8C;AAC9C,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;AAUrE;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,KAAU,EACV,WAAmB,EACnB,UAAwB,EAAE;IAE1B,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IACpE,IAAI,QAAQ,EAAE;QACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC5B,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC;SACvB;QACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YACnC,MAAM,IAAI,SAAS,CACjB,gBAAgB,WAAW,yCAAyC,MAAM,CACxE,QAAQ,CACT,EAAE,CACJ,CAAC;SACH;KACF;IACD,IAAI,KAAK,EAAE;QACT,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACzB,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;SACjB;QACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YAChC,MAAM,IAAI,SAAS,CACjB,gBAAgB,WAAW,qCAAqC,MAAM,CACpE,KAAK,CACN,EAAE,CACJ,CAAC;SACH;KACF;IACD,IAAI,UAAU,EAAE;QACd,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC9B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;SAC3B;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAC1C,MAAM,IAAI,SAAS,CACjB,gBAAgB,WAAW,2CAA2C,MAAM,CAC1E,UAAU,CACX,EAAE,CACJ,CAAC;SACH;KACF;IACD,IAAI,UAAU,EAAE;QACd,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC9B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;SAC3B;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAC1C,IAAI,YAAY,GAAG,gBAAgB,WAAW,wDAAwD,MAAM,CAC1G,UAAU,CACX,EAAE,CAAC;YACJ,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;gBAClD,MAAM,IAAI,SAAS,CACjB,GAAG,YAAY,wFAAwF,CACxG,CAAC;aACH;iBAAM;gBACL,MAAM,IAAI,SAAS,CAAC,YAAY,CAAC,CAAC;aACnC;SACF;KACF;IACD,IAAI,QAAQ,EAAE;QACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC5B,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC;SACvB;QACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;YACtC,MAAM,IAAI,SAAS,CACjB,gBAAgB,WAAW,sDAAsD,MAAM,CACrF,QAAQ,CACT,EAAE,CACJ,CAAC;SACH;KACF;AACH,CAAC;AAID,SAAS,MAAM,CAAC,KAAgB;IAC9B,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACnE,CAAC"}

package/lib-esm/utils/clamp.d.ts

@@ -0,0 +1,10 @@
+import { IJS } from '../IJS';
+export declare type ClampFunction = (value: number) => number;
+/**
+ * Get the clamp function for an image (depends on the image bit depth)
+ *
+ * @param image - The image for which the clamp function is needed.
+ * @returns The clamp function.
+ */
+export declare function getClamp(image: IJS): ClampFunction;
+//# sourceMappingURL=clamp.d.ts.map

package/lib-esm/utils/clamp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clamp.d.ts","sourceRoot":"","sources":["../../src/utils/clamp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B,oBAAY,aAAa,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAEtD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,aAAa,CAQlD"}

package/lib-esm/utils/clamp.js

@@ -0,0 +1,34 @@
+/**
+ * Get the clamp function for an image (depends on the image bit depth)
+ *
+ * @param image - The image for which the clamp function is needed.
+ * @returns The clamp function.
+ */
+export function getClamp(image) {
+    if (image.maxValue === 255) {
+        return clamp255;
+    }
+    if (image.maxValue === 65535) {
+        return clamp65535;
+    }
+    throw new Error(`unknown maxValue: ${image.maxValue}`);
+}
+/**
+ * Clamp value for 8-bit images.
+ *
+ * @param value - Value to clamp.
+ * @returns The clamped value.
+ */
+function clamp255(value) {
+    return Math.min(Math.max(value, 0), 255);
+}
+/**
+ * Clamp value for 16-bit images.
+ *
+ * @param value - Value to clamp.
+ * @returns The clamped value.
+ */
+function clamp65535(value) {
+    return Math.min(Math.max(value, 0), 65535);
+}
+//# sourceMappingURL=clamp.js.map

package/lib-esm/utils/clamp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clamp.js","sourceRoot":"","sources":["../../src/utils/clamp.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAU;IACjC,IAAI,KAAK,CAAC,QAAQ,KAAK,GAAG,EAAE;QAC1B,OAAO,QAAQ,CAAC;KACjB;IACD,IAAI,KAAK,CAAC,QAAQ,KAAK,KAAK,EAAE;QAC5B,OAAO,UAAU,CAAC;KACnB;IACD,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAC7C,CAAC"}

package/lib-esm/utils/colorModels.d.ts

@@ -0,0 +1,15 @@
+export declare enum ImageColorModel {
+    GREY = "GREY",
+    GREYA = "GREYA",
+    RGB = "RGB",
+    RGBA = "RGBA",
+    BINARY = "BINARY"
+}
+export declare const colorModels: {
+    [key in ImageColorModel]: {
+        components: number;
+        alpha: boolean;
+        channels: number;
+    };
+};
+//# sourceMappingURL=colorModels.d.ts.map

package/lib-esm/utils/colorModels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorModels.d.ts","sourceRoot":"","sources":["../../src/utils/colorModels.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACzB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,WAAW,EAAE;KACvB,GAAG,IAAI,eAAe,GAAG;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,OAAO,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB;CA2BF,CAAC"}

package/lib-esm/utils/colorModels.js

@@ -0,0 +1,36 @@
+export var ImageColorModel;
+(function (ImageColorModel) {
+    ImageColorModel["GREY"] = "GREY";
+    ImageColorModel["GREYA"] = "GREYA";
+    ImageColorModel["RGB"] = "RGB";
+    ImageColorModel["RGBA"] = "RGBA";
+    ImageColorModel["BINARY"] = "BINARY";
+})(ImageColorModel || (ImageColorModel = {}));
+export const colorModels = {
+    [ImageColorModel.GREY]: {
+        components: 1,
+        alpha: false,
+        channels: 1,
+    },
+    [ImageColorModel.GREYA]: {
+        components: 1,
+        alpha: true,
+        channels: 2,
+    },
+    [ImageColorModel.RGB]: {
+        components: 3,
+        alpha: false,
+        channels: 3,
+    },
+    [ImageColorModel.RGBA]: {
+        components: 3,
+        alpha: true,
+        channels: 4,
+    },
+    [ImageColorModel.BINARY]: {
+        components: 1,
+        alpha: false,
+        channels: 1,
+    },
+};
+//# sourceMappingURL=colorModels.js.map

package/lib-esm/utils/colorModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorModels.js","sourceRoot":"","sources":["../../src/utils/colorModels.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,kCAAe,CAAA;IACf,8BAAW,CAAA;IACX,gCAAa,CAAA;IACb,oCAAiB,CAAA;AACnB,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED,MAAM,CAAC,MAAM,WAAW,GAMpB;IACF,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;QACtB,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,CAAC;KACZ;IACD,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE;QACvB,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,CAAC;KACZ;IACD,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;QACrB,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,CAAC;KACZ;IACD,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;QACtB,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,CAAC;KACZ;IACD,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE;QACxB,UAAU,EAAE,CAAC;QACb,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,CAAC;KACZ;CACF,CAAC"}

package/lib-esm/utils/copyData.d.ts

@@ -0,0 +1,4 @@
+import { IJS, Mask } from '..';
+export declare function copyData(source: IJS, target: IJS): void;
+export declare function copyData(source: Mask, target: Mask): void;
+//# sourceMappingURL=copyData.d.ts.map

package/lib-esm/utils/copyData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyData.d.ts","sourceRoot":"","sources":["../../src/utils/copyData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAE/B,wBAAgB,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;AACzD,wBAAgB,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,IAAI,CAAC"}

package/lib-esm/utils/copyData.js

@@ -0,0 +1,16 @@
+/**
+ * Copy the data of an source to the target image.
+ *
+ * @param source - Image which data is copied.
+ * @param target - Image to which the data must be copied.
+ */
+export function copyData(source, target) {
+    if (target.width !== source.width ||
+        target.height !== source.height ||
+        target.colorModel !== source.colorModel) {
+        throw new Error('copyData: images width, height or color model is different');
+    }
+    // @ts-expect-error Accessing data, which is private
+    target.data = source.data.slice();
+}
+//# sourceMappingURL=copyData.js.map

package/lib-esm/utils/copyData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyData.js","sourceRoot":"","sources":["../../src/utils/copyData.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,MAAkB,EAAE,MAAkB;IAC7D,IACE,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK;QAC7B,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;QAC/B,MAAM,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU,EACvC;QACA,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;KACH;IACD,oDAAoD;IACpD,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;AACpC,CAAC"}

package/lib-esm/utils/getIndex.d.ts

@@ -0,0 +1,12 @@
+import { IJS, Mask } from '..';
+/**
+ * Compute the current data index based on the value coordinates.
+ *
+ * @param row - Row of the value.
+ * @param column - Column of the value.
+ * @param channel - Value channel.
+ * @param image - The image that is being processed.
+ * @returns The value index.
+ */
+export declare function getIndex(row: number, column: number, channel: number, image: IJS | Mask): number;
+//# sourceMappingURL=getIndex.d.ts.map

package/lib-esm/utils/getIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getIndex.d.ts","sourceRoot":"","sources":["../../src/utils/getIndex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAE/B;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,GAAG,GAAG,IAAI,GAChB,MAAM,CAER"}

package/lib-esm/utils/getIndex.js

@@ -0,0 +1,13 @@
+/**
+ * Compute the current data index based on the value coordinates.
+ *
+ * @param row - Row of the value.
+ * @param column - Column of the value.
+ * @param channel - Value channel.
+ * @param image - The image that is being processed.
+ * @returns The value index.
+ */
+export function getIndex(row, column, channel, image) {
+    return (row * image.width + column) * image.channels + channel;
+}
+//# sourceMappingURL=getIndex.js.map

package/lib-esm/utils/getIndex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getIndex.js","sourceRoot":"","sources":["../../src/utils/getIndex.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CACtB,GAAW,EACX,MAAc,EACd,OAAe,EACf,KAAiB;IAEjB,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC;AACjE,CAAC"}

package/lib-esm/utils/getOutputImage.d.ts

@@ -0,0 +1,61 @@
+import { CreateFromOptions, IJS } from '../IJS';
+import { Mask } from '../Mask';
+export interface OutOptions {
+    /**
+     * Image to use as the output.
+     * The image must have compatible properties or the method will throw.
+     */
+    out?: IJS | Mask;
+}
+declare type NewImageParameters = Omit<CreateFromOptions, 'data'>;
+interface OutInternalOptions {
+    /**
+     * Parameters that will be combined with the ones from
+     * `thisImage`.
+     */
+    newParameters?: NewImageParameters;
+    /**
+     * Specify if the values of the original image should be cloned.
+     */
+    clone?: boolean;
+}
+/**
+ * Use this function to support getting the output image of an algorithm from
+ * user-supplied options.
+ *
+ * @param thisImage - Current image on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @param internalOptions - Some additional private options.
+ * @returns The output image.
+ */
+export declare function getOutputImage(thisImage: IJS, options?: OutOptions, internalOptions?: OutInternalOptions): IJS;
+/**
+ * Use this function to support getting the output image of an algorithm from
+ * user-supplied options when the input is a mask.
+ *
+ * @param mask - Current mask on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @returns The output image.
+ */
+export declare function maskToOutputImage(mask: Mask, options?: OutOptions): IJS;
+/**
+ * Use this function to support getting the output mask of an algorithm from
+ * user-supplied options when the input is an image.
+ *
+ * @param image - Current image on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @returns The output mask.
+ */
+export declare function imageToOutputMask(image: IJS, options?: OutOptions): Mask;
+/**
+ * Use this function to support getting the output mask of an algorithm from
+ * user-supplied options when the input is an mask.
+ *
+ * @param mask - Current mask on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @param internalOptions - Additional private options.
+ * @returns The output mask.
+ */
+export declare function maskToOutputMask(mask: Mask, options?: OutOptions, internalOptions?: OutInternalOptions): Mask;
+export {};
+//# sourceMappingURL=getOutputImage.d.ts.map

package/lib-esm/utils/getOutputImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOutputImage.d.ts","sourceRoot":"","sources":["../../src/utils/getOutputImage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAmB,MAAM,QAAQ,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAI/B,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAClB;AAED,aAAK,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAE1D,UAAU,kBAAkB;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,SAAS,EAAE,GAAG,EACd,OAAO,GAAE,UAAe,EACxB,eAAe,GAAE,kBAAuB,GACvC,GAAG,CA4BL;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,GAAE,UAAe,GAAG,GAAG,CAoB3E;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,GAAE,UAAe,GAAG,IAAI,CAiB5E;AAiBD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,UAAe,EACxB,eAAe,GAAE,kBAAuB,GACvC,IAAI,CAyBN"}

package/lib-esm/utils/getOutputImage.js

@@ -0,0 +1,143 @@
+import { ColorDepth } from '..';
+import { IJS, ImageColorModel } from '../IJS';
+import { Mask } from '../Mask';
+import { copyData } from './copyData';
+/**
+ * Use this function to support getting the output image of an algorithm from
+ * user-supplied options.
+ *
+ * @param thisImage - Current image on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @param internalOptions - Some additional private options.
+ * @returns The output image.
+ */
+export function getOutputImage(thisImage, options = {}, internalOptions = {}) {
+    const { out } = options;
+    const { newParameters, clone } = internalOptions;
+    if (out === undefined) {
+        if (clone) {
+            return thisImage.clone();
+        }
+        else {
+            return IJS.createFrom(thisImage, newParameters);
+        }
+    }
+    else {
+        if (!(out instanceof IJS)) {
+            throw new TypeError('out must be an IJS object');
+        }
+        const requirements = Object.assign({
+            width: thisImage.width,
+            height: thisImage.height,
+            depth: thisImage.depth,
+            colorModel: thisImage.colorModel,
+        }, newParameters);
+        checkRequirements(requirements, out);
+        if (clone) {
+            copyData(thisImage, out);
+        }
+        return out;
+    }
+}
+/**
+ * Use this function to support getting the output image of an algorithm from
+ * user-supplied options when the input is a mask.
+ *
+ * @param mask - Current mask on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @returns The output image.
+ */
+export function maskToOutputImage(mask, options = {}) {
+    const { out } = options;
+    if (out === undefined) {
+        return IJS.createFrom(mask, {
+            colorModel: ImageColorModel.GREY,
+        });
+    }
+    else {
+        if (!(out instanceof IJS)) {
+            throw new TypeError('out must be an IJS object');
+        }
+        const requirements = {
+            width: mask.width,
+            height: mask.height,
+            depth: ColorDepth.UINT8,
+            colorModel: ImageColorModel.GREY,
+        };
+        checkRequirements(requirements, out);
+        return out;
+    }
+}
+/**
+ * Use this function to support getting the output mask of an algorithm from
+ * user-supplied options when the input is an image.
+ *
+ * @param image - Current image on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @returns The output mask.
+ */
+export function imageToOutputMask(image, options = {}) {
+    const { out } = options;
+    if (out === undefined) {
+        return Mask.createFrom(image);
+    }
+    else {
+        if (!(out instanceof Mask)) {
+            throw new TypeError('out must be a Mask object');
+        }
+        const requirements = {
+            width: image.width,
+            height: image.height,
+            depth: ColorDepth.UINT1,
+            colorModel: ImageColorModel.BINARY,
+        };
+        checkRequirements(requirements, out);
+        return out;
+    }
+}
+function checkRequirements(requirements, out) {
+    for (const property in requirements) {
+        const prop = property;
+        if (out[prop] !== requirements[prop]) {
+            throw new RangeError(`cannot use out. Its ${property} property must be ${requirements[prop]}. Found ${out[prop]}`);
+        }
+    }
+}
+/**
+ * Use this function to support getting the output mask of an algorithm from
+ * user-supplied options when the input is an mask.
+ *
+ * @param mask - Current mask on which the algorithm is applied.
+ * @param options - Options object received by the algorithm.
+ * @param internalOptions - Additional private options.
+ * @returns The output mask.
+ */
+export function maskToOutputMask(mask, options = {}, internalOptions = {}) {
+    const { out } = options;
+    const { newParameters, clone } = internalOptions;
+    if (out === undefined) {
+        if (clone) {
+            return mask.clone();
+        }
+        else {
+            return Mask.createFrom(mask, newParameters);
+        }
+    }
+    else {
+        if (!(out instanceof Mask)) {
+            throw new TypeError('out must be a Mask object');
+        }
+        const requirements = {
+            width: mask.width,
+            height: mask.height,
+            depth: ColorDepth.UINT1,
+            colorModel: ImageColorModel.BINARY,
+        };
+        checkRequirements(requirements, out);
+        if (clone) {
+            copyData(mask, out);
+        }
+        return out;
+    }
+}
+//# sourceMappingURL=getOutputImage.js.map

package/lib-esm/utils/getOutputImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOutputImage.js","sourceRoot":"","sources":["../../src/utils/getOutputImage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAqB,GAAG,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAwBtC;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAC5B,SAAc,EACd,UAAsB,EAAE,EACxB,kBAAsC,EAAE;IAExC,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC;IACjD,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,IAAI,KAAK,EAAE;YACT,OAAO,SAAS,CAAC,KAAK,EAAE,CAAC;SAC1B;aAAM;YACL,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;SACjD;KACF;SAAM;QACL,IAAI,CAAC,CAAC,GAAG,YAAY,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,SAAS,CAAC,2BAA2B,CAAC,CAAC;SAClD;QACD,MAAM,YAAY,GAAuB,MAAM,CAAC,MAAM,CACpD;YACE,KAAK,EAAE,SAAS,CAAC,KAAK;YACtB,MAAM,EAAE,SAAS,CAAC,MAAM;YACxB,KAAK,EAAE,SAAS,CAAC,KAAK;YACtB,UAAU,EAAE,SAAS,CAAC,UAAU;SACjC,EACD,aAAa,CACd,CAAC;QACF,iBAAiB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;SAC1B;QACD,OAAO,GAAG,CAAC;KACZ;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAU,EAAE,UAAsB,EAAE;IACpE,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IAExB,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE;YAC1B,UAAU,EAAE,eAAe,CAAC,IAAI;SACjC,CAAC,CAAC;KACJ;SAAM;QACL,IAAI,CAAC,CAAC,GAAG,YAAY,GAAG,CAAC,EAAE;YACzB,MAAM,IAAI,SAAS,CAAC,2BAA2B,CAAC,CAAC;SAClD;QACD,MAAM,YAAY,GAAuB;YACvC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,UAAU,EAAE,eAAe,CAAC,IAAI;SACjC,CAAC;QACF,iBAAiB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC;KACZ;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAU,EAAE,UAAsB,EAAE;IACpE,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;KAC/B;SAAM;QACL,IAAI,CAAC,CAAC,GAAG,YAAY,IAAI,CAAC,EAAE;YAC1B,MAAM,IAAI,SAAS,CAAC,2BAA2B,CAAC,CAAC;SAClD;QACD,MAAM,YAAY,GAAuB;YACvC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,UAAU,EAAE,eAAe,CAAC,MAAM;SACnC,CAAC;QACF,iBAAiB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC;KACZ;AACH,CAAC;AAED,SAAS,iBAAiB,CACxB,YAAqB,EACrB,GAAY;IAGZ,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE;QACnC,MAAM,IAAI,GAAG,QAAgB,CAAC;QAC9B,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,YAAY,CAAC,IAAI,CAAC,EAAE;YACpC,MAAM,IAAI,UAAU,CAClB,uBAAuB,QAAQ,qBAAqB,YAAY,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,EAAE,CAC7F,CAAC;SACH;KACF;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAU,EACV,UAAsB,EAAE,EACxB,kBAAsC,EAAE;IAExC,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC;IACjD,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;SACrB;aAAM;YACL,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;SAC7C;KACF;SAAM;QACL,IAAI,CAAC,CAAC,GAAG,YAAY,IAAI,CAAC,EAAE;YAC1B,MAAM,IAAI,SAAS,CAAC,2BAA2B,CAAC,CAAC;SAClD;QACD,MAAM,YAAY,GAAuB;YACvC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,UAAU,EAAE,eAAe,CAAC,MAAM;SACnC,CAAC;QACF,iBAAiB,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE;YACT,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SACrB;QACD,OAAO,GAAG,CAAC;KACZ;AACH,CAAC"}

package/lib-esm/utils/interpolateBorder.d.ts

@@ -0,0 +1,44 @@
+import { IJS } from '../IJS';
+export declare enum BorderType {
+    CONSTANT = "CONSTANT",
+    REPLICATE = "REPLICATE",
+    REFLECT = "REFLECT",
+    WRAP = "WRAP",
+    REFLECT_101 = "REFLECT_101"
+}
+export declare type BorderInterpolationFunction = (column: number, row: number, channel: number, image: IJS) => number;
+/**
+ * Pick the border interpolation algorithm.
+ * The different algorithms are illustrated here:
+ * https://vovkos.github.io/doxyrest-showcase/opencv/sphinx_rtd_theme/enum_cv_BorderTypes.html
+ *
+ * @param type
+ * @param value
+ */
+export declare function getBorderInterpolation(type: BorderType, value: number): BorderInterpolationFunction;
+/**
+ * @param point
+ * @param length
+ */
+export declare function interpolateConstantPoint(point: number, length: number): number;
+/**
+ * @param point
+ * @param length
+ */
+export declare function interpolateReplicatePoint(point: number, length: number): number;
+/**
+ * @param point
+ * @param length
+ */
+export declare function interpolateReflectPoint(point: number, length: number): number;
+/**
+ * @param point
+ * @param length
+ */
+export declare function interpolateWrapPoint(point: number, length: number): number;
+/**
+ * @param point
+ * @param length
+ */
+export declare function interpolateReflect101Point(point: number, length: number): number;
+//# sourceMappingURL=interpolateBorder.d.ts.map

package/lib-esm/utils/interpolateBorder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interpolateBorder.d.ts","sourceRoot":"","sources":["../../src/utils/interpolateBorder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,WAAW,gBAAgB;CAC5B;AAED,oBAAY,2BAA2B,GAAG,CACxC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,GAAG,KACP,MAAM,CAAC;AAEZ;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,UAAU,EAChB,KAAK,EAAE,MAAM,GACZ,2BAA2B,CAiB7B;AA0BD;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,MAAM,CAKR;AAeD;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,MAAM,CAUR;AAeD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAU7E;AAeD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAU1E;AAeD;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,MAAM,CAUR"}