# Segmenter

public interface **Segmenter** extends [Detector](https://developers.google.com/android/reference/com/google/mlkit/vision/interfaces/Detector)\<[SegmentationMask](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask)\> A `https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/Segmentation`
client for identifying pixels in a supplied image as being part of the foreground or the
background.

    Segmenter segmenter = Segmentation.getClient(segmenterOptions);
     
To perform segmentation of an image, you first need to create an instance of
`https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
from a `https://developer.android.com/reference/android/graphics/Bitmap.html`,
`https://developer.android.com/reference/java/nio/ByteBuffer.html`, etc. See
`https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
documentation for more details. For example, the code below creates a `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
from a `https://developer.android.com/reference/android/graphics/Bitmap.html`.

    InputImage image = InputImage.fromBitmap(bitmap, rotationDegrees);
     
Then the code below can segment the supplied `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` and asynchronously return a `https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask`.

    Task<SegmentationMask> task = segmenter.process(image);
     task.addOnSuccessListener(...).addOnFailureListener(...);
     
### Public Method Summary

|---|---|
| abstract void | [close](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/Segmenter#close())() Closes the detector and releases its resources. |
| abstract Task\<[SegmentationMask](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask)\> | [process](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/Segmenter#process(com.google.android.odml.image.MlImage))([MlImage](https://developers.google.com/android/reference/com/google/android/odml/image/MlImage) image) Performs segmentation on an input image. |
| abstract Task\<[SegmentationMask](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask)\> | [process](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/Segmenter#process(com.google.mlkit.vision.common.InputImage))([InputImage](https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage) image) Performs segmentation on an input image. |

### Inherited Method Summary

From interface java.io.Closeable

|---|---|
| abstract void | close() |

From interface java.lang.AutoCloseable

|---|---|
| abstract void | close() |

## Public Methods

#### public abstract void **close** ()

Closes the detector and releases its resources.

#### public abstract Task\<[SegmentationMask](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask)\>
**process** ([MlImage](https://developers.google.com/android/reference/com/google/android/odml/image/MlImage) image)

Performs segmentation on an input image.

This is an experimental API in beta version.

Create an `https://developers.google.com/android/reference/com/google/android/odml/image/MlImage`
object using one of `https://developers.google.com/android/reference/com/google/android/odml/image/MlImage`'s
builder methods. See `https://developers.google.com/android/reference/com/google/android/odml/image/MlImage`
documentation for more details.

##### Returns

- a `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` that asynchronously returns a `https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask`.

#### public abstract Task\<[SegmentationMask](https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask)\>
**process** ([InputImage](https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage) image)

Performs segmentation on an input image.

Create an `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
object using one of `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`'s
factory methods. See `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
documentation for more details.

##### Returns

- a `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` that asynchronously returns a `https://developers.google.com/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask`.