image-js 0.0.0-next-e30968a2d8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 image-js
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# image-js
+
+[![NPM version][npm-image]][npm-url]
+[![build status][ci-image]][ci-url]
+[![Test coverage][codecov-image]][codecov-url]
+[![npm download][download-image]][download-url]
+
+Image processing and manipulation in JavaScript.
+
+## Installation
+
+`$ npm i image-js`
+
+## API
+
+Look at the [examples](./examples) directory for how the API is being designed.
+
+## License
+
+[MIT](./LICENSE)
+
+[npm-image]: https://img.shields.io/npm/v/image-js.svg
+[npm-url]: https://www.npmjs.com/package/image-js
+[ci-image]: https://github.com/image-js/image-js/workflows/Node.js%20CI/badge.svg?branch=main
+[ci-url]: https://github.com/image-js/image-js/actions?query=workflow%3A%22Node.js+CI%22
+[codecov-image]: https://img.shields.io/codecov/c/github/image-js/image-js.svg
+[codecov-url]: https://codecov.io/gh/image-js/image-js
+[download-image]: https://img.shields.io/npm/dm/image-js.svg
+[download-url]: https://www.npmjs.com/package/image-js

package/lib/IJS.d.ts

@@ -0,0 +1,316 @@
+import { Mask } from './Mask';
+import { BlurOptions, ConvolutionOptions, GaussianBlurOptions, SubtractImageOptions, HypotenuseOptions, GradientFilterOptions, DerivativeFilterOptions } from './filters';
+import { InvertOptions } from './filters/invert';
+import { BottomHatOptions, CannyEdgeOptions, CloseOptions, DilateOptions, ErodeOptions, MorphologicalGradientOptions, OpenOptions, TopHatOptions } from './morphology';
+import { ConvertColorOptions } from './operations/convertColor';
+import { CopyToOptions } from './operations/copyTo';
+import { ImageColorModel, colorModels } from './utils/colorModels';
+import { GreyOptions, HistogramOptions, ResizeOptions, RotateOptions, ThresholdOptions, TransformOptions } from '.';
+export { ImageColorModel, colorModels };
+export declare type ImageDataArray = Uint8Array | Uint16Array | Uint8ClampedArray;
+export declare enum ColorDepth {
+    UINT1 = 1,
+    UINT8 = 8,
+    UINT16 = 16
+}
+export declare enum ImageCoordinates {
+    CENTER = "CENTER",
+    TOP_LEFT = "TOP_LEFT",
+    TOP_RIGHT = "TOP_RIGHT",
+    BOTTOM_LEFT = "BOTTOM_LEFT",
+    BOTTOM_RIGHT = "BOTTOM_RIGHT"
+}
+export interface ImageOptions {
+    /**
+     * Number of bits per value in each channel.
+     * Default: `ColorDepth.UINT8`.
+     */
+    depth?: ColorDepth;
+    /**
+     * Typed array holding the image data.
+     */
+    data?: ImageDataArray;
+    /**
+     * Color model of the created image.
+     * Default: `ImageColorModel.RGB`.
+     */
+    colorModel?: ImageColorModel;
+}
+export interface CreateFromOptions extends ImageOptions {
+    width?: number;
+    height?: number;
+}
+export declare type ImageValues = [number, number, number, number];
+export declare class IJS {
+    /**
+     * The number of columns of the image.
+     */
+    readonly width: number;
+    /**
+     * The number of rows of the image.
+     */
+    readonly height: number;
+    /**
+     * The total number of pixels in the image (width × height).
+     */
+    readonly size: number;
+    /**
+     * The number of bits per value in each channel.
+     */
+    readonly depth: ColorDepth;
+    /**
+     * The color model of the image.
+     */
+    readonly colorModel: ImageColorModel;
+    /**
+     * The number of color channels in the image, excluding the alpha channel.
+     * A grey image has 1 component. An RGB image has 3 components.
+     */
+    readonly components: number;
+    /**
+     * The total number of channels in the image, including the alpha channel.
+     */
+    readonly channels: number;
+    /**
+     * Whether the image has an alpha channel or not.
+     */
+    readonly alpha: boolean;
+    /**
+     * The maximum value that a pixel channel can have.
+     */
+    readonly maxValue: number;
+    /**
+     * Typed array holding the image data.
+     */
+    private readonly data;
+    /**
+     * Construct a new IJS knowing its dimensions.
+     *
+     * @param width - Image width.
+     * @param height - Image height.
+     * @param options - Image options.
+     */
+    constructor(width: number, height: number, options?: ImageOptions);
+    /**
+     * Create a new IJS based on the properties of an existing one.
+     *
+     * @param other - Reference image.
+     * @param options - Image options.
+     * @returns New image.
+     */
+    static createFrom(other: IJS | Mask, options?: CreateFromOptions): IJS;
+    /**
+     * Get all the channels of a pixel.
+     *
+     * @param row - Row index.
+     * @param column - Column index.
+     * @returns Channels of the pixel.
+     */
+    getPixel(row: number, column: number): number[];
+    /**
+     * Set all the channels of a pixel.
+     *
+     * @param row - Row index.
+     * @param column - Column index.
+     * @param value - New channel values of the pixel to set.
+     */
+    setPixel(row: number, column: number, value: number[]): void;
+    /**
+     * Get the value of a specific pixel channel. Select pixel using coordinates.
+     *
+     * @param row - Row index.
+     * @param column - Column index.
+     * @param channel - Channel index.
+     * @returns Value of the specified channel of one pixel.
+     */
+    getValue(row: number, column: number, channel: number): number;
+    /**
+     * Set the value of a specific pixel channel. Select pixel using coordinates.
+     *
+     * @param row - Row index.
+     * @param column - Column index.
+     * @param channel - Channel index.
+     * @param value - Value to set.
+     */
+    setValue(row: number, column: number, channel: number, value: number): void;
+    /**
+     * Get the value of a specific pixel channel. Select pixel using index.
+     *
+     * @param index - Index of the pixel.
+     * @param channel - Channel index.
+     * @returns Value of the channel of the pixel.
+     */
+    getValueByIndex(index: number, channel: number): number;
+    /**
+     * Set the value of a specific pixel channel. Select pixel using index.
+     *
+     * @param index - Index of the pixel.
+     * @param channel - Channel index.
+     * @param value - Value to set.
+     */
+    setValueByIndex(index: number, channel: number, value: number): void;
+    /**
+     * Return the raw image data.
+     *
+     * @returns The raw data.
+     */
+    getRawImage(): {
+        width: number;
+        height: number;
+        data: ImageDataArray;
+        channels: number;
+        depth: ColorDepth;
+    };
+    /**
+     * Fill the image with a value or a color.
+     *
+     * @param value - Value or color.
+     * @returns The image instance.
+     */
+    fill(value: number | number[]): this;
+    /**
+     * Fill one channel with a value.
+     *
+     * @param channel - The channel to fill.
+     * @param value - The new value.
+     * @returns The image instance.
+     */
+    fillChannel(channel: number, value: number): this;
+    /**
+     * Fill the alpha channel with the specified value.
+     *
+     * @param value - New channel value.
+     * @returns The image instance.
+     */
+    fillAlpha(value: number): this;
+    /**
+     * Create a copy of this image.
+     *
+     * @returns The image clone.
+     */
+    clone(): IJS;
+    changeEach(cb: (value: number) => number): void;
+    getCoordinates(coordinates: ImageCoordinates, round?: boolean): [number, number];
+    histogram(options?: HistogramOptions): Uint32Array;
+    split(): IJS[];
+    convertColor(colorModel: ImageColorModel, options?: ConvertColorOptions): IJS;
+    convertDepth(newDepth: ColorDepth): IJS;
+    grey(options?: GreyOptions): IJS;
+    copyTo(target: IJS, options?: CopyToOptions): IJS;
+    threshold(options?: ThresholdOptions): Mask;
+    blur(options: BlurOptions): IJS;
+    directConvolution(kernel: number[][], options?: ConvolutionOptions): IJS;
+    /**
+     * Compute direct convolution of an image and return an array with the raw values.
+     *
+     * @param kernel - Kernel used for the convolution.
+     * @param options - Convolution options.
+     * @returns Array with the raw convoluted values.
+     */
+    rawDirectConvolution(kernel: number[][], options?: ConvolutionOptions): Float64Array;
+    separableConvolution(kernelX: number[], kernelY: number[], options?: ConvolutionOptions): IJS;
+    /**
+     * Apply a gaussian filter to an image.
+     *
+     * @param options - Gaussian blur options.
+     * @returns The blurred image.
+     */
+    gaussianBlur(options: GaussianBlurOptions): IJS;
+    /**
+     * Invert the colors of the image.
+     *
+     * @param options - Inversion options
+     * @returns The inverted image.
+     */
+    invert(options?: InvertOptions): IJS;
+    /**
+     * Subtract other from an image.
+     *
+     * @param other - Image to subtract
+     * @param options - Inversion options
+     * @returns The subtracted image.
+     */
+    subtractImage(other: IJS, options?: SubtractImageOptions): IJS;
+    /**
+     * Calculate a new image that is the hypotenuse between the current image and the other.
+     *
+     * @param other - Other image.
+     * @param options - Hypotenuse options.
+     * @returns Hypotenuse of the two images.
+     */
+    hypotenuse(other: IJS, options?: HypotenuseOptions): IJS;
+    /**
+     * Apply a gradient filter to an image.
+     *
+     * @param options - Gradient filter options.
+     * @returns The gradient image.
+     */
+    gradientFilter(options: GradientFilterOptions): IJS;
+    /**
+     * Apply a derivative filter to an image.
+     *
+     * @param options - Derivative filter options.
+     * @returns The processed image.
+     */
+    derivativeFilter(options?: DerivativeFilterOptions): IJS;
+    rotate(angle: number, options?: RotateOptions): IJS;
+    resize(options: ResizeOptions): IJS;
+    transform(transformMatrix: number[][], options?: TransformOptions): IJS;
+    /**
+     * Erode an image.
+     *
+     * @param options - Erode options.
+     * @returns The eroded image.
+     */
+    erode(options?: ErodeOptions): IJS;
+    /**
+     * Dilate an image.
+     *
+     * @param options - Dilate options.
+     * @returns The dilated image.
+     */
+    dilate(options?: DilateOptions): IJS;
+    /**
+     * Open an image.
+     *
+     * @param options - Open options.
+     * @returns The opened image.
+     */
+    open(options?: OpenOptions): IJS;
+    /**
+     * Close an image.
+     *
+     * @param options - Close options.
+     * @returns The closed image.
+     */
+    close(options?: CloseOptions): IJS;
+    /**
+     * Top hat of an image.
+     *
+     * @param options - Top hat options.
+     * @returns The top-hatted image.
+     */
+    topHat(options?: TopHatOptions): IJS;
+    /**
+     * Bottom hat of an image.
+     *
+     * @param options - Bottom hat options.
+     * @returns The bottom-hatted image.
+     */
+    bottomHat(options?: BottomHatOptions): IJS;
+    /**
+     * Apply morphological gradient to an image.
+     *
+     * @param options - morphological gradient options.
+     * @returns The processed image.
+     */
+    morphologicalGradient(options?: MorphologicalGradientOptions): IJS;
+    /**
+     * Apply Canny edge detection to an image.
+     *
+     * @param options - Canny edge detection options.
+     * @returns The processed image.
+     */
+    cannyEdgeDetector(options?: CannyEdgeOptions): Mask;
+}
+//# sourceMappingURL=IJS.d.ts.map

package/lib/IJS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IJS.d.ts","sourceRoot":"","sources":["../src/IJS.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EACL,WAAW,EAEX,kBAAkB,EAIlB,mBAAmB,EAEnB,oBAAoB,EACpB,iBAAiB,EAEjB,qBAAqB,EAGrB,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAU,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAEL,gBAAgB,EAEhB,gBAAgB,EAEhB,YAAY,EAEZ,aAAa,EAEb,YAAY,EAEZ,4BAA4B,EAE5B,WAAW,EAEX,aAAa,EACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAgB,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAE9E,OAAe,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAG5D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGnE,OAAO,EACL,WAAW,EAEX,gBAAgB,EAEhB,aAAa,EAEb,aAAa,EAEb,gBAAgB,EAEhB,gBAAgB,EACjB,MAAM,GAAG,CAAC;AAEX,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;AAExC,oBAAY,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,iBAAiB,CAAC;AAE1E,oBAAY,UAAU;IACpB,KAAK,IAAI;IACT,KAAK,IAAI;IACT,MAAM,KAAK;CACZ;AAED,oBAAY,gBAAgB;IAC1B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,YAAY,iBAAiB;CAC9B;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAE3D,qBAAa,GAAG;IACd;;OAEG;IACH,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,SAAgB,KAAK,EAAE,UAAU,CAAC;IAElC;;OAEG;IACH,SAAgB,UAAU,EAAE,eAAe,CAAC;IAE5C;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,SAAgB,KAAK,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiB;IAEtC;;;;;;OAMG;gBAED,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB;IAyD5B;;;;;;OAMG;WACW,UAAU,CACtB,KAAK,EAAE,GAAG,GAAG,IAAI,EACjB,OAAO,GAAE,iBAAsB,GAC9B,GAAG;IAeN;;;;;;OAMG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE;IAStD;;;;;;OAMG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAOnE;;;;;;;OAOG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAIrE;;;;;;;OAOG;IACI,QAAQ,CACb,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,GACZ,IAAI;IAIP;;;;;;OAMG;IACI,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAG9D;;;;;;OAMG;IACI,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3E;;;;OAIG;IACI,WAAW;;;;;;;IAqBlB;;;;;OAKG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI;IAqB3C;;;;;;OAMG;IACI,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IASxD;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAWrC;;;;OAIG;IACI,KAAK,IAAI,GAAG;IAIZ,UAAU,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI;IAM/C,cAAc,CACnB,WAAW,EAAE,gBAAgB,EAC7B,KAAK,UAAQ,GACZ,CAAC,MAAM,EAAE,MAAM,CAAC;IAyBZ,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAMlD,KAAK,IAAI,GAAG,EAAE;IAId,YAAY,CACjB,UAAU,EAAE,eAAe,EAC3B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,GAAG;IAIC,YAAY,CAAC,QAAQ,EAAE,UAAU,GAAG,GAAG;IAIvC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,GAAG;IAIhC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,GAAE,aAAkB,GAAG,GAAG;IAIrD,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,IAAI;IAK/C,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,GAAG;IAI/B,iBAAiB,CACtB,MAAM,EAAE,MAAM,EAAE,EAAE,EAClB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,GAAG;IAIN;;;;;;OAMG;IACI,oBAAoB,CACzB,MAAM,EAAE,MAAM,EAAE,EAAE,EAClB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,YAAY;IAIR,oBAAoB,CACzB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,GAAG;IAIN;;;;;OAKG;IACI,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,GAAG;IAItD;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,GAAG;IAI3C;;;;;;OAMG;IACI,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,GAAG;IAIrE;;;;;;OAMG;IACI,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,GAAG;IAI/D;;;;;OAKG;IACI,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,GAAG;IAI1D;;;;;OAKG;IACI,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,GAAG;IAMxD,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,GAAG;IAInD,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,GAAG;IAInC,SAAS,CACd,eAAe,EAAE,MAAM,EAAE,EAAE,EAC3B,OAAO,CAAC,EAAE,gBAAgB,GACzB,GAAG;IAKN;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,GAAG;IAGzC;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,GAAG;IAG3C;;;;;OAKG;IACI,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,GAAG;IAIvC;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,GAAG;IAIzC;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,GAAG;IAI3C;;;;;OAKG;IACI,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,GAAG;IAIjD;;;;;OAKG;IACI,qBAAqB,CAAC,OAAO,CAAC,EAAE,4BAA4B,GAAG,GAAG;IAIzE;;;;;OAKG;IACI,iBAAiB,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI;CAG3D"}