image-js 0.0.0-next-ce6a4f4a28 → 0.0.0-next-e43ea796e5

package/dist-types/image-js.d.ts

@@ -598,7 +598,7 @@ declare interface DrawPointsOptions {
     /**
      * Image to which the resulting image has to be put.
      */
-    out?: Image_2;
+    out?: Image_2 | Mask;
 }
 
 declare interface DrawPolygonOnImageOptions extends DrawPolylineOnImageOptions {
@@ -1237,7 +1237,6 @@ declare class Image_2 {
     private readonly data;
     /**
      * Construct a new Image knowing its dimensions.
-     *
      * @param width - Image width.
      * @param height - Image height.
      * @param options - Image options.
@@ -1245,7 +1244,6 @@ declare class Image_2 {
     constructor(width: number, height: number, options?: ImageOptions);
     /**
      * Create a new Image based on the properties of an existing one.
-     *
      * @param other - Reference image.
      * @param options - Image options.
      * @returns New image.
@@ -1253,7 +1251,6 @@ declare class Image_2 {
     static createFrom(other: Image_2 | Mask, options?: CreateFromOptions): Image_2;
     /**
      * Get all the channels of a pixel.
-     *
      * @param column - Column index.
      * @param row - Row index.
      * @returns Channels of the pixel.
@@ -1263,7 +1260,6 @@ declare class Image_2 {
     getRow(row: number): number[][];
     /**
      * Set all the channels of a pixel.
-     *
      * @param column - Column index.
      * @param row - Row index.
      * @param value - New color of the pixel to set.
@@ -1271,7 +1267,6 @@ declare class Image_2 {
     setPixel(column: number, row: number, value: number[]): void;
     /**
      * Set all the channels of a pixel if the coordinates are inside the image.
-     *
      * @param column - Column index.
      * @param row - Row index.
      * @param value - New color of the pixel to set.
@@ -1279,21 +1274,18 @@ declare class Image_2 {
     setVisiblePixel(column: number, row: number, value: number[]): void;
     /**
      * Get all the channels of a pixel using its index.
-     *
      * @param index - Index of the pixel.
      * @returns Channels of the pixel.
      */
     getPixelByIndex(index: number): number[];
     /**
      * Set all the channels of a pixel using its index.
-     *
      * @param index - Index of the pixel.
      * @param value - New channel values of the pixel to set.
      */
     setPixelByIndex(index: number, value: number[]): void;
     /**
      * Get the value of a specific pixel channel. Select pixel using coordinates.
-     *
      * @param column - Column index.
      * @param row - Row index.
      * @param channel - Channel index.
@@ -1302,7 +1294,6 @@ declare class Image_2 {
     getValue(column: number, row: number, channel: number): number;
     /**
      * Set the value of a specific pixel channel. Select pixel using coordinates.
-     *
      * @param column - Column index.
      * @param row - Row index.
      * @param channel - Channel index.
@@ -1311,7 +1302,6 @@ declare class Image_2 {
     setValue(column: number, row: 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.
@@ -1319,7 +1309,6 @@ declare class Image_2 {
     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.
@@ -1327,7 +1316,6 @@ declare class Image_2 {
     setValueByIndex(index: number, channel: number, value: number): void;
     /**
      * Get the value of a specific pixel channel. Select pixel using a point.
-     *
      * @param point - Coordinates of the desired pixel.
      * @param channel - Channel index.
      * @returns Value of the channel of the pixel.
@@ -1335,7 +1323,6 @@ declare class Image_2 {
     getValueByPoint(point: Point, channel: number): number;
     /**
      * Set the value of a specific pixel channel. Select pixel using a point.
-     *
      * @param point - Coordinates of the pixel.
      * @param channel - Channel index.
      * @param value - Value to set.
@@ -1343,7 +1330,6 @@ declare class Image_2 {
     setValueByPoint(point: Point, channel: number, value: number): void;
     /**
      * Find the min and max values of each channel of the image.
-     *
      * @returns An object with arrays of the min and max values.
      */
     minMax(): {
@@ -1352,7 +1338,6 @@ declare class Image_2 {
     };
     /**
      * Return the raw image data.
-     *
      * @returns The raw data.
      */
     getRawImage(): {
@@ -1364,14 +1349,12 @@ declare class Image_2 {
     };
     /**
      * 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.
@@ -1379,33 +1362,28 @@ declare class Image_2 {
     fillChannel(channel: number, value: number): this;
     /**
      * Get one channel of the image as an array.
-     *
      * @param channel - The channel to fill.
      * @returns Array with the channel values.
      */
     getChannel(channel: number): number[];
     /**
      * 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(): Image_2;
     /**
      * Modify all the values of the image using the given callback.
-     *
      * @param cb - Callback that modifies a given value.
      */
     changeEach(cb: (value: number) => number): void;
     /**
      * Get the coordinates of a point in the image. The reference is the top-left corner.
-     *
      * @param coordinates - The point for which you want the coordinates.
      * @param round - Whether the coordinates should be rounded. This is useful when you want the center of the image.
      * @returns Coordinates of the point in the format [column, row].
@@ -1413,7 +1391,6 @@ declare class Image_2 {
     getCoordinates(coordinates: ImageCoordinates, round?: boolean): Point;
     /**
      * Subtract other from an image.
-     *
      * @param other - Image to subtract.
      * @param options - Inversion options.
      * @returns The subtracted image.
@@ -1422,25 +1399,21 @@ declare class Image_2 {
     histogram(options?: HistogramOptions): Uint32Array;
     /**
      * Compute the mean pixel of an image.
-     *
      * @returns The mean pixel.
      */
     mean(): number[];
     /**
      * Compute the median pixel of an image.
-     *
      * @returns The median pixel.
      */
     median(): number[];
     /**
      * Compute the variance of each channel of an image.
-     *
      * @returns The variance of the channels of the image.
      */
     variance(): number[];
     /**
      * Draw a set of points on an image.
-     *
      * @param points - Array of points.
      * @param options - Draw points on Image options.
      * @returns New mask.
@@ -1448,7 +1421,6 @@ declare class Image_2 {
     drawPoints(points: Point[], options?: DrawPointsOptions): Image_2;
     /**
      * Draw a line defined by two points onto an image.
-     *
      * @param from - Line starting point.
      * @param to - Line ending point.
      * @param options - Draw Line options.
@@ -1457,14 +1429,12 @@ declare class Image_2 {
     drawLine(from: Point, to: Point, options?: DrawLineOnImageOptions): Image_2;
     /**
      * 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?: DrawRectangleOptions<Image_2>): Image_2;
     /**
      * Draw a polyline defined by an array of points on an image.
-     *
      * @param points - Polyline array of points.
      * @param options - Draw polyline options.
      * @returns The image with the polyline drawing.
@@ -1472,7 +1442,6 @@ declare class Image_2 {
     drawPolyline(points: Point[], options?: DrawPolylineOnImageOptions): Image_2;
     /**
      * Draw a polygon defined by an array of points onto an image.
-     *
      * @param points - Polygon vertices.
      * @param options - Draw Line options.
      * @returns The image with the polygon drawing.
@@ -1480,7 +1449,6 @@ declare class Image_2 {
     drawPolygon(points: Point[], options?: DrawPolygonOnImageOptions): Image_2;
     /**
      * Draw a circle defined by center and radius onto an image.
-     *
      * @param center - Circle center.
      * @param radius - Circle radius.
      * @param options - Draw circle options.
@@ -1489,7 +1457,6 @@ declare class Image_2 {
     drawCircle(center: Point, radius: number, options?: DrawCircleOnImageOptions): Image_2;
     /**
      * Draw a marker on the image.
-     *
      * @param point - Marker center point.
      * @param options - Draw marker options.
      * @returns The image with the marker drawing.
@@ -1497,7 +1464,6 @@ declare class Image_2 {
     drawMarker(point: Point, options?: DrawMarkerOptions): Image_2;
     /**
      * Draw markers on the image.
-     *
      * @param points - Markers center points.
      * @param options - Draw marker options.
      * @returns The image with the markers drawing.
@@ -1511,7 +1477,6 @@ declare class Image_2 {
     threshold(options?: ThresholdOptions): Mask;
     /**
      * Crop the input image to a desired size.
-     *
      * @param [options] - Crop options.
      * @returns The new cropped image.
      */
@@ -1519,14 +1484,12 @@ declare class Image_2 {
     /**
      * Crops the image based on the alpha channel
      * This removes lines and columns where the alpha channel is lower than a threshold value.
-     *
      * @param options - Crop alpha options.
      * @returns The cropped image.
      */
     cropAlpha(options?: CropAlphaOptions): Image_2;
     /**
      * Extract the pixels of an image, as specified in a mask.
-     *
      * @param mask - The mask defining which pixels to keep.
      * @param options - Extract options.
      * @returns The extracted image.
@@ -1534,7 +1497,6 @@ declare class Image_2 {
     extract(mask: Mask, options?: ExtractOptions): Image_2;
     /**
      * Paint a mask onto an image and the given position and with the given color.
-     *
      * @param mask - Mask to paint on the image.
      * @param options - Paint mask options.
      * @returns The painted image.
@@ -1545,7 +1507,6 @@ declare class Image_2 {
     directConvolution(kernel: number[][], options?: ConvolutionOptions): Image_2;
     /**
      * 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.
@@ -1554,28 +1515,24 @@ declare class Image_2 {
     separableConvolution(kernelX: number[], kernelY: number[], options?: ConvolutionOptions): Image_2;
     /**
      * Apply a gaussian filter to an image.
-     *
      * @param options - Gaussian blur options.
      * @returns The blurred image.
      */
     gaussianBlur(options: GaussianBlurOptions): Image_2;
     /**
      * Flip the image.
-     *
      * @param options - Flip options.
      * @returns The flipped image.
      */
     flip(options?: FlipOptions): Image_2;
     /**
      *   Invert the colors of the image.
-     *
      * @param options - Inversion options.
      * @returns The inverted image.
      */
     invert(options?: InvertOptions): Image_2;
     /**
      * 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.
@@ -1583,28 +1540,24 @@ declare class Image_2 {
     hypotenuse(other: Image_2, options?: HypotenuseOptions): Image_2;
     /**
      * Apply a gradient filter to an image.
-     *
      * @param options - Gradient filter options.
      * @returns The gradient image.
      */
     gradientFilter(options: GradientFilterOptions): Image_2;
     /**
      * Apply a derivative filter to an image.
-     *
      * @param options - Derivative filter options.
      * @returns The processed image.
      */
     derivativeFilter(options?: DerivativeFilterOptions): Image_2;
     /**
      * Level the image using the optional input and output value. This function allows you to enhance the image's contrast.
-     *
      * @param options - Level options.
      * @returns The levelled image.
      */
     level(options?: LevelOptions): Image_2;
     /**
      * Correct the colors in an image using the reference colors.
-     *
      * @param measuredColors - Colors from the image, which will be compared to the reference.
      * @param referenceColors - Reference colors.
      * @returns Image with the colors corrected.
@@ -1612,7 +1565,6 @@ declare class Image_2 {
     correctColor(measuredColors: RgbColor[], referenceColors: RgbColor[]): Image_2;
     /**
      * Apply a median filter to the image.
-     *
      * @param options - Options to apply for median filter.
      * @returns Image after median filter.
      */
@@ -1623,56 +1575,48 @@ declare class Image_2 {
     transformRotate(angle: number, options?: TransformRotateOptions): Image_2;
     /**
      * Erode an image.
-     *
      * @param options - Erode options.
      * @returns The eroded image.
      */
     erode(options?: ErodeOptions): Image_2;
     /**
      * Dilate an image.
-     *
      * @param options - Dilate options.
      * @returns The dilated image.
      */
     dilate(options?: DilateOptions): Image_2;
     /**
      * Open an image.
-     *
      * @param options - Open options.
      * @returns The opened image.
      */
     open(options?: OpenOptions): Image_2;
     /**
      * Close an image.
-     *
      * @param options - Close options.
      * @returns The closed image.
      */
     close(options?: CloseOptions): Image_2;
     /**
      * Top hat of an image.
-     *
      * @param options - Top hat options.
      * @returns The top-hatted image.
      */
     topHat(options?: TopHatOptions): Image_2;
     /**
      * Bottom hat of an image.
-     *
      * @param options - Bottom hat options.
      * @returns The bottom-hatted image.
      */
     bottomHat(options?: BottomHatOptions): Image_2;
     /**
      * Apply morphological gradient to an image.
-     *
      * @param options - Morphological gradient options.
      * @returns The processed image.
      */
     morphologicalGradient(options?: MorphologicalGradientOptions): Image_2;
     /**
      * Apply Canny edge detection to an image.
-     *
      * @param options - Canny edge detection options.
      * @returns The processed image.
      */
@@ -1721,7 +1665,6 @@ declare interface ImageMetadata {
 export declare interface ImageOptions {
     /**
      * Number of bits per value in each channel.
-     *
      * @default `8`.
      */
     bitDepth?: BitDepth;
@@ -1731,13 +1674,11 @@ export declare interface ImageOptions {
     data?: ImageDataArray;
     /**
      * Color model of the created image.
-     *
      * @default 'RGB'.
      */
     colorModel?: ImageColorModel;
     /**
      * Origin of the image relative to a parent image (top-left corner).
-     *
      * @default {row: 0, column: 0}
      */
     origin?: Point;