Module imagingbook.common

Package imagingbook.common.filter.mask

Class BinaryMask

java.lang.Object

imagingbook.common.filter.mask.BinaryMask

Direct Known Subclasses:

CircularMask

public class BinaryMask
extends Object

This class defines a binary mask, as used in filters, for example.

Version:

2022/09/10

Constructor Summary

Constructors

Constructor	Description
BinaryMask(byte[][] mask)
BinaryMask(byte[][] mask, int centerX, int centerY)

Method Summary

Modifier and Type	Method	Description
byte[][]	getByteArray()	Returns a byte[x][y] with outside mask element values zero, inside mask elements non-zero.
ByteProcessor	getByteProcessor()	Returns a byte[x][y] with outside mask element values zero, inside mask elements non-zero.
int	getCenterX()	Returns the x-coordinate of the mask's reference point.
int	getCenterY()	Returns the y-coordinate of the mask's reference point.
int	getElementCount()	Returns the number of inside-mask (1) elements.
int	getHeight()
int	getWidth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BinaryMask

public BinaryMask(byte[][] mask,
 int centerX,
 int centerY)

BinaryMask

public BinaryMask(byte[][] mask)

Method Details

getWidth

public int getWidth()

getHeight

public int getHeight()

getCenterX

public int getCenterX()

Returns the x-coordinate of the mask's reference point.

Returns:

the x-coordinate of the mask's reference point

getCenterY

public int getCenterY()

Returns the y-coordinate of the mask's reference point.

Returns:

the y-coordinate of the mask's reference point

getElementCount

public int getElementCount()

Returns the number of inside-mask (1) elements.

Returns:

the number of inside-mask elements

getByteArray

public byte[][] getByteArray()

Returns a byte[x][y] with outside mask element values zero, inside mask elements non-zero. The first array index corresponds to the horizontal coordinate.

Returns:

the mask as a byte[][]

getByteProcessor

public ByteProcessor getByteProcessor()

Returns a byte[x][y] with outside mask element values zero, inside mask elements non-zero. The first array index corresponds to the horizontal coordinate.

Returns:

the mask as a byte[][]