Class Mask

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

Readonlyalpha

ReadonlybitDepth

Readonlychannels

ReadonlycolorModel

Readonlycomponents

Readonlyheight

ReadonlymaxValue

Readonlyorigin

Readonlysize

Readonlywidth

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.

bottomHat

• bottomHat(options?: BottomHatOptions): Mask

• Bottom hat of an image.

  Parameters

  • Optionaloptions: BottomHatOptions

    Bottom hat options.

  Returns Mask

  The bottom-hatted image.

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.

clone

• clone(): Mask

• Create a copy of this mask.

  Returns Mask

  The mask clone.

close

• close(options?: CloseOptions): Mask

• Close an image.

  Parameters

  • Optionaloptions: CloseOptions

    Close options.

  Returns Mask

  The closed image.

convertColor

• convertColor(colorModel: ImageColorModel): Image

• Parameters

  • colorModel: ImageColorModel

  Returns Image

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.

dilate

• dilate(options?: DilateOptions): Mask

• Dilate an image.

  Parameters

  • Optionaloptions: DilateOptions

    Dilate options.

  Returns Mask

  The dilated image.

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.

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.

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.

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.

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.

erode

• erode(options?: ErodeOptions): Mask

• Erode a Mask.

  Parameters

  • Optionaloptions: ErodeOptions

    Erode options.

  Returns Mask

  The eroded mask.

fill

• fill(value: BitValue): this

• Fill the mask with a value.

  Parameters

  • value: BitValue

    Value of the bit.

  Returns this

  The mask instance.

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.

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.

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.

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.

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.

getFeret

• getFeret(): Feret

• Computes the Feret data.

  Returns Feret

  The Feret diameters.

getMbr

• getMbr(): Mbr

• Get the corners of the minimum bounding rectangle of a shape defined in a mask.

  Returns Mbr

  Array of border points.

getNbNonZeroPixels

• getNbNonZeroPixels(): number

• Get the number of pixels that do not have the value 0.

  Returns number

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.

getPixelByIndex

• getPixelByIndex(index: number): number[]

• Get a pixel using its index.

  Parameters

  • index: number

    Index of the pixel.

  Returns number[]

  The pixel.

getRawImage

• getRawImage(): { data: Uint8Array; height: number; width: number }

• Return the raw mask data.

  Returns { data: Uint8Array; height: number; width: number }

  The raw data.

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.

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.

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.

invert

• invert(options?: InvertOptions): Mask

• Invert the colors of the mask.

  Parameters

  • Optionaloptions: InvertOptions

    Inversion options.

  Returns Mask

  The inverted mask.

morphologicalGradient

• morphologicalGradient(options?: MorphologicalGradientOptions): Mask

• Apply morphological gradient to an image.

  Parameters

  • Optionaloptions: MorphologicalGradientOptions

    Morphological gradient options.

  Returns Mask

  The processed image.

open

• open(options?: OpenOptions): Mask

• Open an image.

  Parameters

  • Optionaloptions: OpenOptions

    Open options.

  Returns Mask

  The opened image.

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.

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.

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

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

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

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

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

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

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

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

solidFill

• solidFill(options?: SolidFillOptions): Mask

• Fill holes in regions of interest.

  Parameters

  • Optionaloptions: SolidFillOptions

    Flood fill options.

  Returns Mask

  The filled mask.

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.

topHat

• topHat(options?: TopHatOptions): Mask

• Top hat of an image.

  Parameters

  • Optionaloptions: TopHatOptions

    Top hat options.

  Returns Mask

  The top-hatted image.

StaticcreateFrom

• 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.

StaticfromPoints

• 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.