edu.jhu.tmaj.beans.masks
Interface Mask
- All Superinterfaces:
- java.lang.Comparable<Mask>, java.io.Serializable
- All Known Implementing Classes:
- AbstractMask, ColorMask, FilterMask, LassoMask, MetaMask
public interface Mask
- extends java.lang.Comparable<Mask>, java.io.Serializable
Represents a Mask.
A mask is one of the main concepts of this program.
All masks have a name, such as "Red" or "Circled Cancer Region", or "Red and Circled Cancer Region".
All masks have a type, and currently there are 3 types of masks in this program: Color, Lasso, and Meta.
A mask basically takes an image and determines for each pixel in the image, whether or not the pixel is
in the mask or outside the mask. In the getMask() method, the boolean array returned is the same size
as the number of pixels in the imagePlus. If the boolean value is true, it means the corresponding pixel
is inside the mask, and if the boolean value is false, it means the corresponding pixel is outside
the mask.
Notice that the getMask() method also takes a file argument. An implementor of this class
may setup a mask that is only applicable to certain file names. The lasso class is the most
notable example of this. (One would only want to apply the Lasso to one file, not every file.)
Methods inherited from interface java.lang.Comparable |
compareTo |
getMask
boolean[] getMask(ij.ImagePlus imagePlus,
ExternalFile file)
getName
java.lang.String getName()
setName
void setName(java.lang.String name)
getType
MaskType getType()
getID
java.lang.Integer getID()
setID
void setID(java.lang.Integer maskID)
updateMask
void updateMask(Mask mask)