Class Mask

Constructors

constructor

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

Properties

`Readonly`alpha

alpha: boolean

Specifying that the mask has no an alpha channel.

`Readonly`bitDepth

bitDepth: BitDepth

The number of bits per value in each channel (always 1).

`Readonly`channels

channels: number

The number of channels in the mask, including the alpha channel (always 1).

`Readonly`colorModel

colorModel: ImageColorModel

The color model of the mask (always BINARY).

`Readonly`components

components: number

The number of color channels in the image, excluding the alpha channel (always 1).

`Readonly`height

height: number

The number of rows of the mask.

`Readonly`maxValue

maxValue: number

The maximum value that a pixel channel can have.

`Readonly`origin

origin: Point

Origin of the image relative to a the parent image.

`Readonly`size

size: number

The total number of bits in the mask (width × height).

`Readonly`width

width: number

The number of columns of the mask.

Methods

and

and(other: Mask, options?: AndOptions): Mask
Perform an AND operation on two masks.
Parameters
- other: Mask
  Second mask.
- Optionaloptions: AndOptions
  And options.
Returns Mask
AND of the two masks.
- Defined in Mask.ts:483

bottomHat

bottomHat(options?: BottomHatOptions): Mask
Bottom hat of an image.
Parameters
- Optionaloptions: BottomHatOptions
  Bottom hat options.
Returns Mask
The bottom-hatted image.
- Defined in Mask.ts:581

clearBorder

clearBorder(options?: ClearBorderOptions): Mask
Remove elements connected to the borders of an image.
Parameters
- Optionaloptions: ClearBorderOptions
  Clear border options.
Returns Mask
The processed image.
- Defined in Mask.ts:599

clone

clone(): Mask
Create a copy of this mask.

Returns Mask
The mask clone.
- Defined in Mask.ts:284

close

close(options?: CloseOptions): Mask
Close an image.
Parameters
- Optionaloptions: CloseOptions
  Close options.
Returns Mask
The closed image.
- Defined in Mask.ts:563

convertColor

convertColor(colorModel: ImageColorModel): Image
Parameters
- colorModel: ImageColorModel
Returns Image
- Defined in Mask.ts:453

copyTo

copyTo(target: Mask, options?: CopyToOptions<Mask>): Mask
Copy the mask to another one by specifying the location in the target mask.
Parameters
- target: Mask
  The target mask.
- options: CopyToOptions<Mask> = {}
  Options.
Returns Mask
The target with the source copied to it.
- Defined in Mask.ts:689

dilate

dilate(options?: DilateOptions): Mask
Dilate an image.
Parameters
- Optionaloptions: DilateOptions
  Dilate options.
Returns Mask
The dilated image.
- Defined in Mask.ts:545

drawLine

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

drawPoints

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

drawPolygon

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

drawPolyline

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

drawRectangle

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

erode

erode(options?: ErodeOptions): Mask
Erode a Mask.
Parameters
- Optionaloptions: ErodeOptions
  Erode options.
Returns Mask
The eroded mask.
- Defined in Mask.ts:536

fill

fill(value: BitValue): this
Fill the mask with a value.
Parameters
- value: BitValue
  Value of the bit.
Returns this
The mask instance.
- Defined in Mask.ts:447

floodFill

floodFill(options?: FloodFillOptions): Mask
Apply flood fill algorithm from a given starting point.
Parameters
- Optionaloptions: FloodFillOptions
  Flood fill options.
Returns Mask
The filled mask.
- Defined in Mask.ts:607

getBit

getBit(column: number, row: number): number
Get the value of a bit.
Parameters
- column: number
  Column index.
- row: number
  Row index.
Returns number
The bit value.
- Defined in Mask.ts:294

getBitByIndex

getBitByIndex(index: number): number
Get the value of a bit using index.
Parameters
- index: number
  Index of the pixel.
Returns number
Value of the bit.
- Defined in Mask.ts:316

getBorderPoints

getBorderPoints(options?: GetBorderPointsOptions): Point[]
Get the coordinates of the points on the border of a shape defined in a mask.
Parameters
- Optionaloptions: GetBorderPointsOptions
  Get border points options.
Returns Point[]
Array of border points.
- Defined in Mask.ts:502

getConvexHull

getConvexHull(): ConvexHull
Get the vertices of the convex Hull polygon of a mask.

Returns ConvexHull
Array of the vertices of the convex Hull in clockwise order.
- Defined in Mask.ts:510

getFeret

getFeret(): Feret
Computes the Feret data.

Returns Feret
The Feret diameters.
- Defined in Mask.ts:526

getMbr

getMbr(): Mbr
Get the corners of the minimum bounding rectangle of a shape defined in a mask.

Returns Mbr
Array of border points.
- Defined in Mask.ts:518

getNbNonZeroPixels

getNbNonZeroPixels(): number
Get the number of pixels that do not have the value 0.

Returns number
- Defined in Mask.ts:333

getPixel

getPixel(column: number, row: number): number[]
Get a pixel of the mask.
Parameters
- column: number
  Column index.
- row: number
  Row index.
Returns number[]
The pixel.
- Defined in Mask.ts:211

getPixelByIndex

getPixelByIndex(index: number): number[]
Get a pixel using its index.
Parameters
- index: number
  Index of the pixel.
Returns number[]
The pixel.
- Defined in Mask.ts:246

getRawImage

getRawImage(): {
    data: Uint8Array<ArrayBufferLike>;
    height: number;
    width: number;
}
Return the raw mask data.

Returns { data: Uint8Array<ArrayBufferLike>; height: number; width: number }
The raw data.
- Defined in Mask.ts:420

getValue

getValue(column: number, row: number, channel: number): number
Get the value of a bit. Function exists for compatibility with Image.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- channel: number
  Index of the channel, must be zero.
Returns number
The bit value.
- Defined in Mask.ts:350

getValueByIndex

getValueByIndex(index: number, channel: number): number
Get the value of a bit using index. Function exists for compatibility with Image.
Parameters
- index: number
  Index of the pixel.
- channel: number
  Index of the channel, must be zero.
Returns number
Value of the bit.
- Defined in Mask.ts:378

getValueByPoint

getValueByPoint(point: Point): number
Get the value of a specific bit. Select bit using a point.
Parameters
- point: Point
  Coordinates of the desired biz.
Returns number
Value of the bit.
- Defined in Mask.ts:403

invert

invert(options?: InvertOptions): Mask
Invert the colors of the mask.
Parameters
- Optionaloptions: InvertOptions
  Inversion options.
Returns Mask
The inverted mask.
- Defined in Mask.ts:463

morphologicalGradient

morphologicalGradient(options?: MorphologicalGradientOptions): Mask
Apply morphological gradient to an image.
Parameters
- Optionaloptions: MorphologicalGradientOptions
  Morphological gradient options.
Returns Mask
The processed image.
- Defined in Mask.ts:590

open

open(options?: OpenOptions): Mask
Open an image.
Parameters
- Optionaloptions: OpenOptions
  Open options.
Returns Mask
The opened image.
- Defined in Mask.ts:554

or

or(other: Mask, options?: OrOptions): Mask
Perform an OR operation on two masks.
Parameters
- other: Mask
  Second mask.
- Optionaloptions: OrOptions
  And options.
Returns Mask
OR of the two masks.
- Defined in Mask.ts:492

paintMask

paintMask(mask: Mask, options?: PaintMaskOnMaskOptions): Mask
Paint a mask onto another mask and the given position and with the given value.
Parameters
- mask: Mask
  Mask to paint.
- Optionaloptions: PaintMaskOnMaskOptions
  Paint mask options.
Returns Mask
The painted mask.
- Defined in Mask.ts:699

setBit

setBit(column: number, row: number, value: BitValue): void
Set the value of a bit.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- value: BitValue
  New bit value.
Returns void
- Defined in Mask.ts:305

setBitByIndex

setBitByIndex(index: number, value: BitValue): void
Set the value of a bit using index.
Parameters
- index: number
  Index of the pixel.
- value: BitValue
  Value to set.
Returns void
- Defined in Mask.ts:325

setPixel

setPixel(column: number, row: number, value: number[]): void
Set a pixel.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- value: number[]
  The pixel value.
Returns void
- Defined in Mask.ts:224

setPixelByIndex

setPixelByIndex(index: number, value: number[]): void
Set a pixel using its index.
Parameters
- index: number
  Index of the pixel.
- value: number[]
  New value of the pixel to set.
Returns void
- Defined in Mask.ts:255

setValue

setValue(column: number, row: number, channel: number, value: BitValue): void
Set the value of a bit. Function exists for compatibility with Image.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- channel: number
  Index of the channel, must be zero.
- value: BitValue
  New bit value.
Returns void
- Defined in Mask.ts:362

setValueByIndex

setValueByIndex(index: number, channel: number, value: BitValue): void
Set the value of a bit using index. Function exists for compatibility with Image.
Parameters
- index: number
  Index of the pixel.
- channel: number
  Index of the channel, must be zero.
- value: BitValue
  Value to set.
Returns void
- Defined in Mask.ts:389

setValueByPoint

setValueByPoint(point: Point, value: BitValue): void
Set the value of a specific bit. Select bit using a point.
Parameters
- point: Point
  Coordinates of the bit.
- value: BitValue
  Value to set.
Returns void
- Defined in Mask.ts:412

setVisiblePixel

setVisiblePixel(column: number, row: number, value: number[]): void
Set a pixel to a given value if the coordinates are inside the mask.
Parameters
- column: number
  Column index.
- row: number
  Row index.
- value: number[]
  New color of the pixel to set.
Returns void
- Defined in Mask.ts:235

solidFill

solidFill(options?: SolidFillOptions): Mask
Fill holes in regions of interest.
Parameters
- Optionaloptions: SolidFillOptions
  Flood fill options.
Returns Mask
The filled mask.
- Defined in Mask.ts:615

subtract

subtract(other: Mask, options?: SubtractImageOptions): Mask
Subtract other from a mask.
Parameters
- other: Mask
  Image to subtract.
- Optionaloptions: SubtractImageOptions
  Inversion options.
Returns Mask
The subtracted mask.
- Defined in Mask.ts:473

topHat

topHat(options?: TopHatOptions): Mask
Top hat of an image.
Parameters
- Optionaloptions: TopHatOptions
  Top hat options.
Returns Mask
The top-hatted image.
- Defined in Mask.ts:572

`Static`createFrom

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

`Static`fromPoints

fromPoints(width: number, height: number, points: Point[]): Mask
Create a mask from an array of points.
Parameters
- width: number
  Width of the mask.
- height: number
  Height of the mask.
- points: Point[]
  Reference Mask.
Returns Mask
New mask.
- Defined in Mask.ts:266

Class Mask

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Mask

Properties

Readonlyalpha

ReadonlybitDepth

Readonlychannels

ReadonlycolorModel

Readonlycomponents

Readonlyheight

ReadonlymaxValue

Readonlyorigin

Readonlysize

Readonlywidth

Methods

and

Parameters

Returns Mask

bottomHat

Parameters

Returns Mask

clearBorder

Parameters

Returns Mask

clone

Returns Mask

close

Parameters

Returns Mask

convertColor

Parameters

Returns Image

copyTo

Parameters

Returns Mask

dilate

Parameters

Returns Mask

drawLine

Parameters

Returns Mask

drawPoints

Parameters

Returns Mask

drawPolygon

Parameters

Returns Mask

drawPolyline

Parameters

Returns Mask

drawRectangle

Parameters

Returns Mask

erode

Parameters

Returns Mask

fill

Parameters

Returns this

floodFill

Parameters

Returns Mask

getBit

Parameters

Returns number

getBitByIndex

Parameters

Returns number

getBorderPoints

Parameters

Returns Point[]

getConvexHull

Returns ConvexHull

getFeret

`Readonly`alpha

`Readonly`bitDepth

`Readonly`channels

`Readonly`colorModel

`Readonly`components

`Readonly`height

`Readonly`maxValue

`Readonly`origin

`Readonly`size

`Readonly`width