Class Image

Index

Constructors

Properties

alpha bitDepth channels colorModel components height maxValue meta? origin size width

Methods

add blur bottomHat cannyEdgeDetector changeEach clone close convertBitDepth convertColor copyTo correctColor crop cropAlpha cropRectangle derivativeFilter dilate directConvolution divide drawCircle drawLine drawMarker drawMarkers drawPoints drawPolygon drawPolyline drawRectangle erode extract fill fillAlpha fillChannel flip gaussianBlur getChannel getColumn getCoordinates getPixel getPixelByIndex getRawImage getRow getValue getValueByIndex getValueByPoint gradientFilter grey histogram hypotenuse increaseContrast invert level mean median medianFilter minMax morphologicalGradient multiply open paintMask pixelate rawDirectConvolution resize rotate separableConvolution setClampedValue setClampedValueByIndex setPixel setPixelByIndex setValue setValueByIndex setValueByPoint setVisiblePixel split subtract threshold topHat transform transformRotate variance createFrom

Constructors

constructor

new Image(width, height, options?): Image
Construct a new Image knowing its dimensions.
Parameters
- width: number
  Image width.
- height: number
  Image height.
- options: ImageOptions = {}
  Image options.
Returns Image
- Defined in Image.ts:238

Properties

`Readonly` alpha

alpha: boolean

Whether the image has an alpha channel or not.

`Readonly` bitDepth

bitDepth: BitDepth

The number of bits per value in each channel.

`Readonly` channels

channels: number

The total number of channels in the image, including the alpha channel.

`Readonly` colorModel

colorModel: ImageColorModel

The color model of the image.

`Readonly` components

components: number

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` height

height: number

The number of rows of the image.

`Readonly` maxValue

maxValue: number

The maximum value that a pixel channel can have.

`Optional` `Readonly` meta

meta?: ImageMetadata

`Readonly` origin

origin: Point

Origin of the image relative to a the parent image.

`Readonly` size

size: number

The total number of pixels in the image (width × height).

`Readonly` width

width: number

The number of columns of the image.

Methods

add

add(other): Image
Parameters
- other: Image
Returns Image
- Defined in Image.ts:686

blur

blur(options): Image
Parameters
- options: BlurOptions
Returns Image
- Defined in Image.ts:917

bottomHat

bottomHat(options?): Image
Bottom hat of an image.
Parameters
- Optional options: BottomHatOptions
  Bottom hat options.
Returns Image
The bottom-hatted image.
- Defined in Image.ts:1119

cannyEdgeDetector

cannyEdgeDetector(options?): Mask
Apply Canny edge detection to an image.
Parameters
- Optional options: CannyEdgeOptions
  Canny edge detection options.
Returns Mask
The processed image.
- Defined in Image.ts:1137

changeEach

changeEach(cb): void
Modify all the values of the image using the given callback.
Parameters
- cb: ((value) => number)
  Callback that modifies a given value.
  - - (value): number
    - Parameters
      value: number
      Returns number
Returns void
- Defined in Image.ts:639

clone

clone(): Image
Create a copy of this image.

Returns Image
The image clone.
- Defined in Image.ts:631

close

close(options?): Image
Close an image.
Parameters
- Optional options: CloseOptions
  Close options.
Returns Image
The closed image.
- Defined in Image.ts:1101

convertBitDepth

convertBitDepth(newDepth): Image
Parameters
- newDepth: BitDepth
Returns Image
- Defined in Image.ts:849

convertColor

convertColor(colorModel, options?): Image
Parameters
- colorModel: ImageColorModel
- Optional options: ConvertColorOptions
Returns Image
- Defined in Image.ts:842

copyTo

copyTo(target, options?): Image
Parameters
- target: Image
- options: CopyToOptions<Image> = {}
Returns Image
- Defined in Image.ts:857

correctColor

correctColor(measuredColors, referenceColors): Image
Correct the colors in an image using the reference colors.
Parameters
- measuredColors: RgbColor[]
  Colors from the image, which will be compared to the reference.
- referenceColors: RgbColor[]
  Reference colors.
Returns Image
Image with the colors corrected.
- Defined in Image.ts:1031

crop

crop(options?): Image
Crop the input image to a desired size.
Parameters
- Optional options: CropOptions
  Crop options.
Returns Image
The new cropped image.
- Defined in Image.ts:870

cropAlpha

cropAlpha(options?): Image
Crops the image based on the alpha channel This removes lines and columns where the alpha channel is lower than a threshold value.
Parameters
- options: CropAlphaOptions = {}
  Crop alpha options.
Returns Image
The cropped image.
- Defined in Image.ts:891

cropRectangle

cropRectangle(points, options?): Image
Crop an oriented rectangle from the image. If the rectangle's length or width are not an integers, its dimension is expanded in both directions such as the length and width are integers.
Parameters
- points: Point[]
  The points of the rectangle. Points must be circling around the rectangle (clockwise or anti-clockwise)
- Optional options: CropRectangleOptions
  Crop options, see CropRectangleOptions
Returns Image
The cropped image. The orientation of the image is the one closest to the rectangle passed as input.
- Defined in Image.ts:881

derivativeFilter

derivativeFilter(options?): Image
Apply a derivative filter to an image.
Parameters
- Optional options: DerivativeFilterOptions
  Derivative filter options.
Returns Image
The processed image.
- Defined in Image.ts:1003

dilate

dilate(options?): Image
Dilate an image.
Parameters
- Optional options: DilateOptions
  Dilate options.
Returns Image
The dilated image.
- Defined in Image.ts:1084

directConvolution

directConvolution(kernel, options?): Image
Parameters
- kernel: number[][]
- Optional options: ConvolutionOptions
Returns Image
- Defined in Image.ts:925

divide

divide(value, options?): Image
Divide image pixels by a constant.
Parameters
- value: number
  Value which pixels will be divided to.
- options: DivideOptions = {}
  Divide options.
Returns Image
Divided image.
- Defined in Image.ts:704

drawCircle

drawCircle(center, radius, options?): Image
Draw a circle defined by center and radius onto an image.
Parameters
- center: Point
  Circle center.
- radius: number
  Circle radius.
- options: DrawCircleOnImageOptions = {}
  Draw circle options.
Returns Image
The image with the circle drawing.
- Defined in Image.ts:809

drawLine

drawLine(from, to, options?): Image
Draw a line defined by two points onto an image.
Parameters
- from: Point
  Line starting point.
- to: Point
  Line ending point.
- options: DrawLineOnImageOptions = {}
  Draw Line options.
Returns Image
The mask with the line drawing.
- Defined in Image.ts:759

drawMarker

drawMarker(point, options?): Image
Draw a marker on the image.
Parameters
- point: Point
  Marker center point.
- options: DrawMarkerOptions = {}
  Draw marker options.
Returns Image
The image with the marker drawing.
- Defined in Image.ts:823

drawMarkers

drawMarkers(points, options?): Image
Draw markers on the image.
Parameters
- points: Point[]
  Markers center points.
- options: DrawMarkerOptions = {}
  Draw marker options.
Returns Image
The image with the markers drawing.
- Defined in Image.ts:833

drawPoints

drawPoints(points, options?): Image
Draw a set of points on an image.
Parameters
- points: Point[]
  Array of points.
- options: DrawPointsOptions = {}
  Draw points on Image options.
Returns Image
New mask.
- Defined in Image.ts:748

drawPolygon

drawPolygon(points, options?): Image
Draw a polygon defined by an array of points onto an image.
Parameters
- points: Point[]
  Polygon vertices.
- options: DrawPolygonOnImageOptions = {}
  Draw Line options.
Returns Image
The image with the polygon drawing.
- Defined in Image.ts:795

drawPolyline

drawPolyline(points, options?): Image
Draw a polyline defined by an array of points on an image.
Parameters
- points: Point[]
  Polyline array of points.
- options: DrawPolylineOnImageOptions = {}
  Draw polyline options.
Returns Image
The image with the polyline drawing.
- Defined in Image.ts:782

drawRectangle

drawRectangle(options?): Image
Draw a rectangle defined by position of the top-left corner, width and height.
Parameters
- options: DrawRectangleOptions<Image> = {}
  Draw rectangle options.
Returns Image
The image with the rectangle drawing.
- Defined in Image.ts:772

erode

erode(options?): Image
Erode an image.
Parameters
- Optional options: ErodeOptions
  Erode options.
Returns Image
The eroded image.
- Defined in Image.ts:1076

extract

extract(mask, options?): Image
Extract the pixels of an image, as specified in a mask.
Parameters
- mask: Mask
  The mask defining which pixels to keep.
- Optional options: ExtractOptions
  Extract options.
Returns Image
The extracted image.
- Defined in Image.ts:901

fill

fill(value): Image
Fill the image with a value or a color.
Parameters
- value: number | number[]
  Value or color.
Returns Image
The image instance.
- Defined in Image.ts:561

fillAlpha

fillAlpha(value): Image
Fill the alpha channel with the specified value.
Parameters
- value: number
  New channel value.
Returns Image
The image instance.
- Defined in Image.ts:616

fillChannel

fillChannel(channel, value): Image
Fill one channel with a value.
Parameters
- channel: number
  The channel to fill.
- value: number
  The new value.
Returns Image
The image instance.
- Defined in Image.ts:588

flip

flip(options?): Image
Flip the image.
Parameters
- Optional options: FlipOptions
  Flip options.
Returns Image
The flipped image.
- Defined in Image.ts:966

gaussianBlur

gaussianBlur(options): Image
Apply a gaussian filter to an image.
Parameters
- options: GaussianBlurOptions
  Gaussian blur options.
Returns Image
The blurred image.
- Defined in Image.ts:958

getChannel

getChannel(channel): number[]
Get one channel of the image as an array.
Parameters
- channel: number
  The channel to fill.
Returns number[]
Array with the channel values.
- Defined in Image.ts:602

getColumn

getColumn(column): number[][]
Parameters
- column: number
Returns number[][]
- Defined in Image.ts:342

getCoordinates

getCoordinates(coordinates, round?): Point
Get the coordinates of a point in the image. The reference is the top-left corner.
Parameters
- coordinates: ImageCoordinates
  The point for which you want the coordinates.
- round: boolean = false
  Whether the coordinates should be rounded. This is useful when you want the center of the image.
Returns Point
Coordinates of the point in the format [column, row].
- Defined in Image.ts:651

getPixel

getPixel(column, row): number[]
Get all the channels of a pixel.
Parameters
- column: number
  Column index.
- row: number
  Row index.
Returns number[]
Channels of the pixel.
- Defined in Image.ts:333

getPixelByIndex

getPixelByIndex(index): number[]
Get all the channels of a pixel using its index.
Parameters
- index: number
  Index of the pixel.
Returns number[]
Channels of the pixel.
- Defined in Image.ts:395

getRawImage

getRawImage(): {
    bitDepth: BitDepth;
    channels: number;
    data: ImageDataArray;
    height: number;
    width: number;
}
Return the raw image data.

Returns {
    bitDepth: BitDepth;
    channels: number;
    data: ImageDataArray;
    height: number;
    width: number;
}
The raw data.
- bitDepth: BitDepth
- channels: number
- data: ImageDataArray
- height: number
- width: number
- Defined in Image.ts:529

getRow

getRow(row): number[][]
Parameters
- row: number
Returns number[][]
- Defined in Image.ts:354

getValue

getValue(column, row, channel): number
Get the value of a specific pixel channel. Select pixel using coordinates.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- channel: number
  Channel index.
Returns number
Value of the specified channel of one pixel.
- Defined in Image.ts:423

getValueByIndex

getValueByIndex(index, channel): number
Get the value of a specific pixel channel. Select pixel using index.
Parameters
- index: number
  Index of the pixel.
- channel: number
  Channel index.
Returns number
Value of the channel of the pixel.
- Defined in Image.ts:467

getValueByPoint

getValueByPoint(point, channel): number
Get the value of a specific pixel channel. Select pixel using a point.
Parameters
- point: Point
  Coordinates of the desired pixel.
- channel: number
  Channel index.
Returns number
Value of the channel of the pixel.
- Defined in Image.ts:503

gradientFilter

gradientFilter(options): Image
Apply a gradient filter to an image.
Parameters
- options: GradientFilterOptions
  Gradient filter options.
Returns Image
The gradient image.
- Defined in Image.ts:994

grey

grey(options?): Image
Parameters
- Optional options: GreyOptions
Returns Image
- Defined in Image.ts:853

histogram

histogram(options?): Uint32Array
Parameters
- Optional options: HistogramOptions
Returns Uint32Array
- Defined in Image.ts:709

hypotenuse

hypotenuse(other, options?): Image
Calculate a new image that is the hypotenuse between the current image and the other.
Parameters
- other: Image
  Other image.
- Optional options: HypotenuseOptions
  Hypotenuse options.
Returns Image
Hypotenuse of the two images.
- Defined in Image.ts:985

increaseContrast

increaseContrast(options?): Image
Increase the contrast of an image by spanning each channel on the range [0, image.maxValue].
Parameters
- options: IncreaseContrastOptions = {}
  Increase contrast options.
Returns Image
The enhanced image.
- Defined in Image.ts:1021

invert

invert(options?): Image
Invert the colors of the image.
Parameters
- Optional options: InvertOptions
  Inversion options.
Returns Image
The inverted image.
- Defined in Image.ts:975

level

level(options?): Image
Level the image using the optional input and output value. This function allows you to enhance the image's contrast.
Parameters
- Optional options: LevelOptions
  Level options.
Returns Image
The levelled image.
- Defined in Image.ts:1012

mean

mean(options?): number[]
Compute the mean pixel of an image.
Parameters
- Optional options: MeanOptions
  Mean options.
Returns number[]
The mean pixel.
- Defined in Image.ts:718

median

median(options?): number[]
Compute the median pixel of an image.
Parameters
- Optional options: MedianOptions
  Median options.
Returns number[]
The median pixel.
- Defined in Image.ts:727

medianFilter

medianFilter(options): Image
Apply a median filter to the image.
Parameters
- options: MedianFilterOptions
  Options to apply for median filter.
Returns Image
Image after median filter.
- Defined in Image.ts:1042

minMax

minMax(): {
max: number[];
min: number[];
}
Find the min and max values of each channel of the image.

Returns {
max: number[];
min: number[];
}
An object with arrays of the min and max values.
- max: number[]
- min: number[]
- Defined in Image.ts:521

morphologicalGradient

morphologicalGradient(options?): Image
Apply morphological gradient to an image.
Parameters
- Optional options: MorphologicalGradientOptions
  Morphological gradient options.
Returns Image
The processed image.
- Defined in Image.ts:1128

multiply

multiply(value, options?): Image
Multiply image pixels by a constant.
Parameters
- value: number
  Value which pixels will be multiplied to.
- options: MultiplyOptions = {}
  Multiply options.
Returns Image
Multiplied image.
- Defined in Image.ts:695

open

open(options?): Image
Open an image.
Parameters
- Optional options: OpenOptions
  Open options.
Returns Image
The opened image.
- Defined in Image.ts:1092

paintMask

paintMask(mask, options?): Image
Paint a mask onto an image and the given position and with the given color.
Parameters
- mask: Mask
  Mask to paint on the image.
- Optional options: PaintMaskOnImageOptions
  Paint mask options.
Returns Image
The painted image.
- Defined in Image.ts:911

pixelate

pixelate(options): Image
Parameters
- options: PixelateOptions
Returns Image
- Defined in Image.ts:921

rawDirectConvolution

rawDirectConvolution(kernel, options?): Float64Array
Compute direct convolution of an image and return an array with the raw values.
Parameters
- kernel: number[][]
  Kernel used for the convolution.
- Optional options: ConvolutionOptions
  Convolution options.
Returns Float64Array
Array with the raw convoluted values.
- Defined in Image.ts:938

resize

resize(options): Image
Parameters
- options: ResizeOptions
Returns Image
- Defined in Image.ts:1048

rotate

rotate(angle): Image
Parameters
- angle: RotateAngle
Returns Image
- Defined in Image.ts:1052

separableConvolution

separableConvolution(kernelX, kernelY, options?): Image
Parameters
- kernelX: number[]
- kernelY: number[]
- Optional options: ConvolutionOptions
Returns Image
- Defined in Image.ts:945

setClampedValue

setClampedValue(column, row, channel, value): void
Set the value of a specific pixel channel. Select pixel using coordinates. If the value is out of range it is set to the closest extremety.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- channel: number
  Channel index.
- value: number
  Value to set.
Returns void
- Defined in Image.ts:451

setClampedValueByIndex

setClampedValueByIndex(index, channel, value): void
Set the value of a specific pixel channel. Select pixel using index. If the value is out of range it is set to the closest extremety.
Parameters
- index: number
  Index of the pixel.
- channel: number
  Channel index.
- value: number
  Value to set.
Returns void
- Defined in Image.ts:487

setPixel

setPixel(column, row, value): void
Set all the channels of a pixel.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- value: number[]
  New color of the pixel to set.
Returns void
- Defined in Image.ts:371

setPixelByIndex

setPixelByIndex(index, value): void
Set all the channels of a pixel using its index.
Parameters
- index: number
  Index of the pixel.
- value: number[]
  New channel values of the pixel to set.
Returns void
- Defined in Image.ts:409

setValue

setValue(column, row, channel, value): void
Set the value of a specific pixel channel. Select pixel using coordinates.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- channel: number
  Channel index.
- value: number
  Value to set.
Returns void
- Defined in Image.ts:434

setValueByIndex

setValueByIndex(index, channel, value): void
Set the value of a specific pixel channel. Select pixel using index.
Parameters
- index: number
  Index of the pixel.
- channel: number
  Channel index.
- value: number
  Value to set.
Returns void
- Defined in Image.ts:476

setValueByPoint

setValueByPoint(point, channel, value): void
Set the value of a specific pixel channel. Select pixel using a point.
Parameters
- point: Point
  Coordinates of the pixel.
- channel: number
  Channel index.
- value: number
  Value to set.
Returns void
- Defined in Image.ts:513

setVisiblePixel

setVisiblePixel(column, row, value): void
Set all the channels of a pixel if the coordinates are inside the image.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- value: number[]
  New color of the pixel to set.
Returns void
- Defined in Image.ts:384

split

split(): Image[]
Returns Image[]
- Defined in Image.ts:838

subtract

subtract(other, options?): Image
Subtract other from an image.
Parameters
- other: Image
  Image to subtract.
- options: SubtractImageOptions = {}
  Inversion options.
Returns Image
The subtracted image.
- Defined in Image.ts:682

threshold

threshold(options?): Mask
Parameters
- options: ThresholdOptions = {}
Returns Mask
- Defined in Image.ts:861

topHat

topHat(options?): Image
Top hat of an image.
Parameters
- Optional options: TopHatOptions
  Top hat options.
Returns Image
The top-hatted image.
- Defined in Image.ts:1110

transform

transform(transformMatrix, options?): Image
Parameters
- transformMatrix: number[][]
- Optional options: TransformOptions
Returns Image
- Defined in Image.ts:1056

transformRotate

transformRotate(angle, options?): Image
Parameters
- angle: number
- Optional options: TransformRotateOptions
Returns Image
- Defined in Image.ts:1063

variance

variance(options?): number[]
Compute the variance of each channel of an image.
Parameters
- Optional options: VarianceOptions
  Variance options.
Returns number[]
The variance of the channels of the image.
- Defined in Image.ts:736

`Static` createFrom

createFrom(other, options?): Image
Create a new Image based on the properties of an existing one.
Parameters
- other: Image | Mask
  Reference image.
- options: CreateFromOptions = {}
  Image options.
Returns Image
New image.
- Defined in Image.ts:308

Class Image

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

width: number

height: number

options: ImageOptions = {}

Returns Image

Properties

Readonly alpha

Readonly bitDepth

Readonly channels

Readonly colorModel

Readonly components

Readonly height

Readonly maxValue

Optional Readonly meta

Readonly origin

Readonly size

Readonly width

Methods

add

Parameters

other: Image

Returns Image

blur

Parameters

options: BlurOptions

Returns Image

bottomHat

Parameters

Optional options: BottomHatOptions

Returns Image

cannyEdgeDetector

Parameters

Optional options: CannyEdgeOptions

Returns Mask

changeEach

Parameters

cb: ((value) => number)

Parameters

value: number

Returns number

Returns void

clone

Returns Image

close

Parameters

Optional options: CloseOptions

Returns Image

convertBitDepth

Parameters

newDepth: BitDepth

Returns Image

convertColor

Parameters

colorModel: ImageColorModel

Optional options: ConvertColorOptions

Returns Image

copyTo

Parameters

target: Image

options: CopyToOptions<Image> = {}

Returns Image

correctColor

Parameters

measuredColors: RgbColor[]

referenceColors: RgbColor[]

Returns Image

crop

Parameters

Optional options: CropOptions

Returns Image

cropAlpha

Parameters

options: CropAlphaOptions = {}

`Readonly` alpha

`Readonly` bitDepth

`Readonly` channels

`Readonly` colorModel

`Readonly` components

`Readonly` height

`Readonly` maxValue

`Optional` `Readonly` meta

`Readonly` origin

`Readonly` size

`Readonly` width

`Optional` options: BottomHatOptions

`Optional` options: CannyEdgeOptions

`Optional` options: CloseOptions

`Optional` options: ConvertColorOptions

`Optional` options: CropOptions

`Optional` options: CropRectangleOptions

`Optional` options: DerivativeFilterOptions

`Optional` options: DilateOptions

`Optional` options: ConvolutionOptions

`Optional` options: ErodeOptions