Mask (Deep Java Library 0.24.0 API specification)

java.lang.Object
- ai.djl.modality.cv.output.Rectangle
- - ai.djl.modality.cv.output.Mask

All Implemented Interfaces:

BoundingBox, java.io.Serializable
```
public class Mask
extends Rectangle
```
A mask with a probability for each pixel within a bounding rectangle.
This class is usually used to record the results of an Image Segmentation task.

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  Mask(double x, double y, double width, double height, float[][] dist)
  Constructs a Mask with the given data.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  float[][] getProbDist()
  Returns the probability for each pixel.
  - Methods inherited from class ai.djl.modality.cv.output.Rectangle
    getBounds, getHeight, getIoU, getPath, getPoint, getWidth, getX, getY, toString
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Mask
```
public Mask(double x,
            double y,
            double width,
            double height,
            float[][] dist)
```
    Constructs a Mask with the given data.
    
    Parameters:
    
    x - the left coordinate of the bounding rectangle
    
    y - the top coordinate of the bounding rectangle
    
    width - the width of the bounding rectangle
    
    height - the height of the bounding rectangle
    
    dist - the probability distribution for each pixel in the rectangle
- Method Detail
  - getProbDist
```
public float[][] getProbDist()
```
    Returns the probability for each pixel.
    
    Returns:
    
    the probability for each pixel