image-js 1.0.0-alpha.3 → 1.1.0

package/lib/Mask.js

@@ -0,0 +1,557 @@
+import { subtract } from './compare/index.js';
+import { drawLineOnMask, drawPoints, drawPolygonOnMask, drawPolylineOnMask, drawRectangle, } from './draw/index.js';
+import { and, invert, or } from './filters/index.js';
+import { getBorderPoints } from './maskAnalysis/getBorderPoints.js';
+import { getConvexHull } from './maskAnalysis/getConvexHull.js';
+import { getFeret } from './maskAnalysis/getFeret.js';
+import { getMbr } from './maskAnalysis/getMbr.js';
+import { bottomHat, clearBorder, close, dilate, erode, floodFill, morphologicalGradient, open, solidFill, topHat, } from './morphology/index.js';
+import { convertColor, copyTo, paintMaskOnMask } from './operations/index.js';
+import { boolToNumber } from './utils/boolToNumber.js';
+import { colorModels } from './utils/constants/colorModels.js';
+export class Mask {
+    /**
+     * The number of columns of the mask.
+     */
+    width;
+    /**
+     * The number of rows of the mask.
+     */
+    height;
+    /**
+     * The total number of bits in the mask (width × height).
+     */
+    size;
+    /**
+     * The number of bits per value in each channel (always 1).
+     */
+    bitDepth;
+    /**
+     * The color model of the mask (always BINARY).
+     */
+    colorModel;
+    /**
+     * The number of color channels in the image, excluding the alpha channel (always 1).
+     */
+    components;
+    /**
+     * The number of channels in the mask, including the alpha channel (always 1).
+     */
+    channels;
+    /**
+     * Specifying that the mask has no an alpha channel.
+     */
+    alpha;
+    /**
+     * The maximum value that a pixel channel can have.
+     */
+    maxValue;
+    /**
+     * Origin of the image relative to a the parent image.
+     */
+    origin;
+    /**
+     * Typed array holding the mask data.
+     */
+    data;
+    /**
+     * Construct a new Mask knowing its dimensions.
+     * @param width - Image width.
+     * @param height - Image height.
+     * @param options - Image options.
+     */
+    constructor(width, height, options = {}) {
+        const { data, origin = { row: 0, column: 0 } } = options;
+        if (width < 1 || !Number.isInteger(width)) {
+            throw new RangeError(`width must be an integer and at least 1. Received ${width}`);
+        }
+        if (height < 1 || !Number.isInteger(height)) {
+            throw new RangeError(`height must be an integer and at least 1. Received ${height}`);
+        }
+        this.width = width;
+        this.height = height;
+        this.size = width * height;
+        this.bitDepth = 1;
+        this.colorModel = 'BINARY';
+        this.origin = origin;
+        const colorModelDef = colorModels[this.colorModel];
+        this.components = colorModelDef.components;
+        this.alpha = colorModelDef.alpha;
+        this.channels = colorModelDef.channels;
+        this.maxValue = 1;
+        if (data === undefined) {
+            this.data = new Uint8Array(this.size);
+        }
+        else {
+            const expectedLength = this.size * this.channels;
+            if (data.length !== expectedLength) {
+                throw new RangeError(`incorrect data size: ${data.length}. Expected ${expectedLength}`);
+            }
+            this.data = data;
+        }
+    }
+    /**
+     * Create a new Mask based on the properties of an existing one.
+     * @param other - Reference Mask.
+     * @param options - Mask options.
+     * @returns New mask.
+     */
+    static createFrom(other, options = {}) {
+        const { width = other.width, height = other.height, origin = other.origin, } = options;
+        return new Mask(width, height, { origin, ...options });
+    }
+    /**
+     * Get a pixel of the mask.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @returns The pixel.
+     */
+    getPixel(column, row) {
+        const result = [];
+        const index = row * this.width + column;
+        result.push(this.data[index]);
+        return result;
+    }
+    /**
+     * Set a pixel.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @param value - The pixel value.
+     */
+    setPixel(column, row, value) {
+        const index = row * this.width + column;
+        this.data[index] = value[0];
+    }
+    /**
+     * Set a pixel to a given value if the coordinates are inside the mask.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @param value - New color of the pixel to set.
+     */
+    setVisiblePixel(column, row, value) {
+        if (column >= 0 && column < this.width && row >= 0 && row < this.height) {
+            this.setPixel(column, row, value);
+        }
+    }
+    /**
+     * Get a pixel using its index.
+     * @param index - Index of the pixel.
+     * @returns The pixel.
+     */
+    getPixelByIndex(index) {
+        return [this.data[index]];
+    }
+    /**
+     * Set a pixel using its index.
+     * @param index - Index of the pixel.
+     * @param value - New value of the pixel to set.
+     */
+    setPixelByIndex(index, value) {
+        this.data[index] = value[0];
+    }
+    /**
+     * Create a mask from an array of points.
+     * @param width - Width of the mask.
+     * @param height - Height of the mask.
+     * @param points - Reference Mask.
+     * @returns New mask.
+     */
+    static fromPoints(width, height, points) {
+        const mask = new Mask(width, height);
+        for (const point of points) {
+            mask.setBit(point.column, point.row, 1);
+        }
+        return mask;
+    }
+    /**
+     * Create a copy of this mask.
+     * @returns The mask clone.
+     */
+    clone() {
+        return Mask.createFrom(this, { data: this.data.slice() });
+    }
+    /**
+     * Get the value of a bit.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @returns The bit value.
+     */
+    getBit(column, row) {
+        const index = row * this.width + column;
+        return this.data[index];
+    }
+    /**
+     * Set the value of a bit.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @param value - New bit value.
+     */
+    setBit(column, row, value) {
+        const index = row * this.width + column;
+        // @ts-expect-error: we know that value is a boolean
+        this.data[index] = value;
+    }
+    /**
+     * Get the value of a bit using index.
+     * @param index - Index of the pixel.
+     * @returns Value of the bit.
+     */
+    getBitByIndex(index) {
+        return this.data[index * this.channels];
+    }
+    /**
+     * Set the value of a bit using index.
+     * @param index - Index of the pixel.
+     * @param value - Value to set.
+     */
+    setBitByIndex(index, value) {
+        this.data[index * this.channels] = boolToNumber(value);
+    }
+    /**
+     * Get the number of pixels that do not have the value 0.
+     * @returns The number of non-zero pixels.
+     */
+    getNbNonZeroPixels() {
+        let count = 0;
+        for (const datum of this.data) {
+            if (datum) {
+                count++;
+            }
+        }
+        return count;
+    }
+    /**
+     * Get the value of a bit. Function exists for compatibility with Image.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @param channel - Index of the channel, must be zero.
+     * @returns The bit value.
+     */
+    getValue(column, row, channel) {
+        checkChannel(channel);
+        return this.getBit(column, row);
+    }
+    /**
+     * Set the value of a bit. Function exists for compatibility with Image.
+     * @param column - Column index.
+     * @param row - Row index.
+     * @param channel - Index of the channel, must be zero.
+     * @param value - New bit value.
+     */
+    setValue(column, row, channel, value) {
+        checkChannel(channel);
+        this.setBit(column, row, value);
+    }
+    /**
+     * Get the value of a bit using index. Function exists for compatibility with Image.
+     * @param index - Index of the pixel.
+     * @param channel - Index of the channel, must be zero.
+     * @returns Value of the bit.
+     */
+    getValueByIndex(index, channel) {
+        checkChannel(channel);
+        return this.getBitByIndex(index);
+    }
+    /**
+     * Set the value of a bit using index. Function exists for compatibility with Image.
+     * @param index - Index of the pixel.
+     * @param channel - Index of the channel, must be zero.
+     * @param value - Value to set.
+     */
+    setValueByIndex(index, channel, value) {
+        checkChannel(channel);
+        this.setBitByIndex(index, value);
+    }
+    /**
+     * Get the value of a specific bit. Select bit using a point.
+     * @param point - Coordinates of the desired biz.
+     * @returns Value of the bit.
+     */
+    getValueByPoint(point) {
+        return this.getValue(point.column, point.row, 0);
+    }
+    /**
+     * Set the value of a specific bit. Select bit using a point.
+     * @param point - Coordinates of the bit.
+     * @param value - Value to set.
+     */
+    setValueByPoint(point, value) {
+        this.setValue(point.column, point.row, 0, value);
+    }
+    /**
+     * Return the raw mask data.
+     * @returns The raw data.
+     */
+    getRawImage() {
+        return {
+            width: this.width,
+            height: this.height,
+            data: this.data,
+        };
+    }
+    [Symbol.for('nodejs.util.inspect.custom')]() {
+        let dataString;
+        if (this.height > 20 || this.width > 20) {
+            dataString = '[...]';
+        }
+        else {
+            dataString = printData(this);
+        }
+        return `Mask {
+  width: ${this.width}
+  height: ${this.height}
+  data: ${dataString}
+}`;
+    }
+    /**
+     * Fill the mask with a value.
+     * @param value - Value of the bit.
+     * @returns The mask instance.
+     */
+    fill(value) {
+        const result = boolToNumber(value);
+        this.data.fill(result);
+        return this;
+    }
+    convertColor(colorModel) {
+        return convertColor(this, colorModel);
+    }
+    // FILTERS
+    /**
+     * Invert the colors of the mask.
+     * @param options - Inversion options.
+     * @returns The inverted mask.
+     */
+    invert(options) {
+        return invert(this, options);
+    }
+    /**
+     * Subtract other from a mask.
+     * @param other - Image to subtract.
+     * @param options - Inversion options.
+     * @returns The subtracted mask.
+     */
+    subtract(other, options) {
+        return subtract(this, other, options);
+    }
+    /**
+     * Perform an AND operation on two masks.
+     * @param other - Second mask.
+     * @param options - And options.
+     * @returns AND of the two masks.
+     */
+    and(other, options) {
+        return and(this, other, options);
+    }
+    /**
+     * Perform an OR operation on two masks.
+     * @param other - Second mask.
+     * @param options - And options.
+     * @returns OR of the two masks.
+     */
+    or(other, options) {
+        return or(this, other, options);
+    }
+    // MASK ANALYSIS
+    /**
+     * Get the coordinates of the points on the border of a shape defined in a mask.
+     * @param options - Get border points options.
+     * @returns Array of border points.
+     */
+    getBorderPoints(options) {
+        return getBorderPoints(this, options);
+    }
+    /**
+     * Get the vertices of the convex Hull polygon of a mask.
+     * @returns Array of the vertices of the convex Hull in clockwise order.
+     */
+    getConvexHull() {
+        return getConvexHull(this);
+    }
+    /**
+     * Get the corners of the minimum bounding rectangle of a shape defined in a mask.
+     * @returns Array of border points.
+     */
+    getMbr() {
+        return getMbr(this);
+    }
+    /**
+     * Computes the Feret data.
+     * @returns The Feret diameters.
+     */
+    getFeret() {
+        return getFeret(this);
+    }
+    // MORPHOLOGY
+    /**
+     * Erode a Mask.
+     * @param options - Erode options.
+     * @returns The eroded mask.
+     */
+    erode(options) {
+        return erode(this, options);
+    }
+    /**
+     * Dilate an image.
+     * @param options - Dilate options.
+     * @returns The dilated image.
+     */
+    dilate(options) {
+        return dilate(this, options);
+    }
+    /**
+     * Open an image.
+     * @param options - Open options.
+     * @returns The opened image.
+     */
+    open(options) {
+        return open(this, options);
+    }
+    /**
+     * Close an image.
+     * @param options - Close options.
+     * @returns The closed image.
+     */
+    close(options) {
+        return close(this, options);
+    }
+    /**
+     * Top hat of an image.
+     * @param options - Top hat options.
+     * @returns The top-hatted image.
+     */
+    topHat(options) {
+        return topHat(this, options);
+    }
+    /**
+     * Bottom hat of an image.
+     * @param options - Bottom hat options.
+     * @returns The bottom-hatted image.
+     */
+    bottomHat(options) {
+        return bottomHat(this, options);
+    }
+    /**
+     * Apply morphological gradient to an image.
+     * @param options - Morphological gradient options.
+     * @returns The processed image.
+     */
+    morphologicalGradient(options) {
+        return morphologicalGradient(this, options);
+    }
+    /**
+     * Remove elements connected to the borders of an image.
+     * @param options - Clear border options.
+     * @returns The processed image.
+     */
+    clearBorder(options) {
+        return clearBorder(this, options);
+    }
+    /**
+     * Apply flood fill algorithm from a given starting point.
+     * @param options - Flood fill options.
+     * @returns The filled mask.
+     */
+    floodFill(options) {
+        return floodFill(this, options);
+    }
+    /**
+     * Fill holes in regions of interest.
+     * @param options - Flood fill options.
+     * @returns The filled mask.
+     */
+    solidFill(options) {
+        return solidFill(this, options);
+    }
+    // DRAW
+    /**
+     * Draw a set of points on a mask.
+     * @param points - Array of points.
+     * @param options - Draw points on Image options.
+     * @returns New mask.
+     */
+    drawPoints(points, options = {}) {
+        return drawPoints(this, points, options);
+    }
+    /**
+     * Draw a line defined by two points onto a mask.
+     * @param from - Line starting point.
+     * @param to - Line ending point.
+     * @param options - Draw Line options.
+     * @returns The mask with the line drawing.
+     */
+    drawLine(from, to, options = {}) {
+        return drawLineOnMask(this, from, to, options);
+    }
+    /**
+     * Draw a polyline defined by an array of points on a mask.
+     * @param points - Polyline array of points.
+     * @param options - Draw polyline options.
+     * @returns The mask with the polyline drawing.
+     */
+    drawPolyline(points, options = {}) {
+        return drawPolylineOnMask(this, points, options);
+    }
+    /**
+     * Draw a polygon defined by an array of points onto an mask.
+     * @param points - Polygon vertices.
+     * @param options - Draw Line options.
+     * @returns The mask with the polygon drawing.
+     */
+    drawPolygon(points, options = {}) {
+        return drawPolygonOnMask(this, points, options);
+    }
+    /**
+     * Draw a rectangle defined by position of the top-left corner, width and height.
+     * @param options - Draw rectangle options.
+     * @returns The image with the rectangle drawing.
+     */
+    drawRectangle(options = {}) {
+        return drawRectangle(this, options);
+    }
+    // OPERATIONS
+    /**
+     * Copy the mask to another one by specifying the location in the target mask.
+     * @param target - The target mask.
+     * @param options - Options.
+     * @returns The target with the source copied to it.
+     */
+    copyTo(target, options = {}) {
+        return copyTo(this, target, options);
+    }
+    /**
+     * Paint a mask onto another mask and the given position and with the given value.
+     * @param mask - Mask to paint.
+     * @param options - Paint mask options.
+     * @returns The painted mask.
+     */
+    paintMask(mask, options) {
+        return paintMaskOnMask(this, mask, options);
+    }
+}
+/**
+ * Returns all values of a mask as a string.
+ * @param mask - Input mask.
+ * @returns Formatted string with all values of a mask.
+ */
+function printData(mask) {
+    const result = [];
+    for (let row = 0; row < mask.height; row++) {
+        const line = [];
+        for (let column = 0; column < mask.width; column++) {
+            line.push(String(mask.getBit(column, row)));
+        }
+        result.push(`[${line.join(' ')}]`);
+    }
+    return result.join('\n        ');
+}
+/**
+ * Verify the channel value of a mask.
+ * @param channel - The channel value.
+ */
+function checkChannel(channel) {
+    if (channel !== 0) {
+        throw new RangeError(`channel value must be 0 on type Mask. Received ${channel}`);
+    }
+}
+//# sourceMappingURL=Mask.js.map

package/lib/Mask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mask.js","sourceRoot":"","sources":["../src/Mask.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAQ9C,OAAO,EACL,cAAc,EACd,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,GACd,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAmBlD,OAAO,EACL,SAAS,EACT,WAAW,EACX,KAAK,EACL,MAAM,EACN,KAAK,EACL,SAAS,EACT,qBAAqB,EACrB,IAAI,EACJ,SAAS,EACT,MAAM,GACP,MAAM,uBAAuB,CAAC;AAK/B,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAsB/D,MAAM,OAAO,IAAI;IACf;;OAEG;IACa,KAAK,CAAS;IAE9B;;OAEG;IACa,MAAM,CAAS;IAE/B;;OAEG;IACa,IAAI,CAAS;IAE7B;;OAEG;IACa,QAAQ,CAAW;IAEnC;;OAEG;IACa,UAAU,CAAkB;IAE5C;;OAEG;IACa,UAAU,CAAS;IAEnC;;OAEG;IACa,QAAQ,CAAS;IAEjC;;OAEG;IACa,KAAK,CAAU;IAE/B;;OAEG;IACa,QAAQ,CAAS;IAEjC;;OAEG;IACa,MAAM,CAAQ;IAE9B;;OAEG;IACc,IAAI,CAAa;IAElC;;;;;OAKG;IACH,YAAmB,KAAa,EAAE,MAAc,EAAE,UAAuB,EAAE;QACzE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC;QAEzD,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,UAAU,CAClB,qDAAqD,KAAK,EAAE,CAC7D,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,UAAU,CAClB,sDAAsD,MAAM,EAAE,CAC/D,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,GAAG,MAAM,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QAEvC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAElB,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC;YACjD,IAAI,IAAI,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;gBACnC,MAAM,IAAI,UAAU,CAClB,wBAAwB,IAAI,CAAC,MAAM,cAAc,cAAc,EAAE,CAClE,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CACtB,KAAmB,EACnB,UAAiC,EAAE;QAEnC,MAAM,EACJ,KAAK,GAAG,KAAK,CAAC,KAAK,EACnB,MAAM,GAAG,KAAK,CAAC,MAAM,EACrB,MAAM,GAAG,KAAK,CAAC,MAAM,GACtB,GAAG,OAAO,CAAC;QACZ,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,MAAc,EAAE,GAAW;QACzC,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,MAAc,EAAE,GAAW,EAAE,KAAe;QAC1D,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACxC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,MAAc,EAAE,GAAW,EAAE,KAAe;QACjE,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACxE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAa;QAClC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAa,EAAE,KAAe;QACnD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CACtB,KAAa,EACb,MAAc,EACd,MAAe;QAEf,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAErC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,KAAK;QACV,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAc,EAAE,GAAW;QACvC,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAc,EAAE,GAAW,EAAE,KAAe;QACxD,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACxC,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,KAAa;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,KAAa,EAAE,KAAe;QACjD,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACvB,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC9B,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,EAAE,CAAC;YACV,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,MAAc,EAAE,GAAW,EAAE,OAAe;QAC1D,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CACb,MAAc,EACd,GAAW,EACX,OAAe,EACf,KAAe;QAEf,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,KAAa,EAAE,OAAe;QACnD,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,eAAe,CACpB,KAAa,EACb,OAAe,EACf,KAAe;QAEf,YAAY,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAY;QACjC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAY,EAAE,KAAe;QAClD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,WAAW;QAChB,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;IAEM,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAC/C,IAAI,UAAU,CAAC;QACf,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,CAAC;YACxC,UAAU,GAAG,OAAO,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO;WACA,IAAI,CAAC,KAAK;YACT,IAAI,CAAC,MAAM;UACb,UAAU;EAClB,CAAC;IACD,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,KAAe;QACzB,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,YAAY,CAAC,UAA2B;QAC7C,OAAO,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,UAAU;IACV;;;;OAIG;IACI,MAAM,CAAC,OAAuB;QACnC,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,KAAW,EAAE,OAA8B;QACzD,OAAO,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,KAAW,EAAE,OAAoB;QAC1C,OAAO,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IACD;;;;;OAKG;IACI,EAAE,CAAC,KAAW,EAAE,OAAmB;QACxC,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,gBAAgB;IAChB;;;;OAIG;IACI,eAAe,CAAC,OAAgC;QACrD,OAAO,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,aAAa;IACb;;;;OAIG;IACI,KAAK,CAAC,OAAsB;QACjC,OAAO,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAuB;QACnC,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,OAAqB;QAC/B,OAAO,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAsB;QACjC,OAAO,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAuB;QACnC,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,OAA0B;QACzC,OAAO,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,OAAsC;QACjE,OAAO,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,OAA4B;QAC7C,OAAO,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;OAIG;IACI,SAAS,CAAC,OAA0B;QACzC,OAAO,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IACD;;;;OAIG;IACI,SAAS,CAAC,OAA0B;QACzC,OAAO,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,OAAO;IAEP;;;;;OAKG;IACI,UAAU,CAAC,MAAe,EAAE,UAA6B,EAAE;QAChE,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CACb,IAAW,EACX,EAAS,EACT,UAAiC,EAAE;QAEnC,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,YAAY,CACjB,MAAe,EACf,UAAqC,EAAE;QAEvC,OAAO,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAChB,MAAe,EACf,UAAoC,EAAE;QAEtC,OAAO,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,UAAsC,EAAE;QAC3D,OAAO,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,aAAa;IAEb;;;;;OAKG;IACI,MAAM,CAAC,MAAY,EAAE,UAA+B,EAAE;QAC3D,OAAO,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,IAAU,EAAE,OAAgC;QAC3D,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,IAAU;IAC3B,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAC3C,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;YACnD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAC,OAAe;IACnC,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QAClB,MAAM,IAAI,UAAU,CAClB,kDAAkD,OAAO,EAAE,CAC5D,CAAC;IACJ,CAAC;AACH,CAAC"}

package/lib/Stack.d.ts

@@ -0,0 +1,127 @@
+import type { BitDepth } from 'fast-png';
+import type { Image } from './Image.js';
+import type { HistogramOptions } from './compute/index.js';
+import type { ImageColorModel } from './utils/constants/colorModels.js';
+export declare class Stack {
+    /**
+     * The array of images.
+     */
+    private readonly images;
+    /**
+     * The stack size.
+     */
+    readonly size: number;
+    /**
+     * Do the images have an alpha channel?
+     */
+    readonly alpha: boolean;
+    /**
+     * The color model of the images.
+     */
+    readonly colorModel: ImageColorModel;
+    /**
+     * The bit depth of the images.
+     */
+    readonly bitDepth: BitDepth;
+    /**
+     * Whether all the images of the stack have the same dimensions.
+     */
+    readonly sameDimensions: boolean;
+    /**
+     * The number of channels of the images.
+     */
+    readonly channels: number;
+    /**
+     * Create a new stack from an array of images.
+     * The images must have the same bit depth and color model.
+     * @param images - Array of images from which to create the stack.
+     */
+    constructor(images: Image[]);
+    [Symbol.iterator](): IterableIterator<Image>;
+    /**
+     * Clone a stack. The images are a copy of the original images.
+     * @returns A new stack with the same images.
+     */
+    clone(): Stack;
+    /**
+     * Get the images of the stack. Mainly for debugging purposes.
+     * @returns The images.
+     */
+    getImages(): Image[];
+    /**
+     * Get the image at the given index.
+     * @param index - The index of the image.
+     * @returns The image.
+     */
+    getImage(index: number): Image;
+    /**
+     * Get a value from an image of the stack.
+     * @param stackIndex - Index of the image in the stack.
+     * @param row - Row index of the pixel.
+     * @param column - Column index of the pixel.
+     * @param channel - The channel to retrieve.
+     * @returns The value at the given position.
+     */
+    getValue(stackIndex: number, row: number, column: number, channel: number): number;
+    /**
+     * Get a value from an image of the stack. Specify the pixel position using its index.
+     * @param stackIndex - Index of the image in the stack.
+     * @param index - The index of the pixel.
+     * @param channel - The channel to retrieve.
+     * @returns The value at the given position.
+     */
+    getValueByIndex(stackIndex: number, index: number, channel: number): number;
+    /**
+     * Return the image containing the minimum values of all the images in the stack for
+     * each pixel. All the images must have the same dimensions.
+     * @returns The minimum image.
+     */
+    minImage(): Image;
+    /**
+     * Return the image containing the maximum values of all the images in the stack for
+     * each pixel. All the images must have the same dimensions.
+     * @returns The maximum image.
+     */
+    maxImage(): Image;
+    /**
+     * Return the image containing the median values of all the images in the stack for
+     * each pixel. All the images must have the same dimensions.
+     * @returns The median image.
+     */
+    medianImage(): Image;
+    /**
+     * Return the image containing the average values of all the images in the stack for
+     * each pixel. All the images must have the same dimensions.
+     * @returns The mean image.
+     */
+    meanImage(): Image;
+    /**
+     * Return a 16 bits depth image containing the sum values of all the images in the stack for
+     * each pixel.
+     * @returns The sum image.
+     */
+    sum(): Image;
+    /**
+     * Get the sum of all the histograms of the stack's images. If no channel is specified in the options, the images must be GREY.
+     * @param options - Histogram options.
+     * @returns The histogram of the stack.
+     */
+    histogram(options?: HistogramOptions): Uint32Array;
+    /**
+     * Align all the images of the stack on the image at the given index.
+     * @param refIndex - The index of the reference image.
+     */
+    /**
+     * Map a function on all the images of the stack.
+     * @param callback - Function to apply on each image.
+     * @returns New stack with the modified images.
+     */
+    map(callback: (image: Image) => Image): Stack;
+    /**
+     * Filter the images in the stack.
+     * @param callback - Function to decide which images to keep.
+     * @returns New filtered stack.
+     */
+    filter(callback: (image: Image) => boolean): Stack;
+}
+//# sourceMappingURL=Stack.d.ts.map