Segmentation
Stay organized with collections
Save and categorize content based on your preferences.
Entry point 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 InputImage
from a Bitmap
, ByteBuffer
, etc. See InputImage
documentation for more details. For example, the code below creates an InputImage
from a Bitmap
.
InputImage image = InputImage.fromBitmap(bitmap, rotationDegrees);
Then the code
below can segment the supplied InputImage
and
asynchronously return a SegmentationMask
. Task<SegmentationMask> task = segmenter.process(image);
task.addOnSuccessListener(...).addOnFailureListener(...);
Inherited Method Summary
From class java.lang.Object
Public Methods
Gets an instance of Segmenter
that can segment the foreground and the background of an image.
To release the resources associated with a Segmenter
,
you need to ensure that Segmenter.close()
is called on the resulting Segmenter
instance once it will no longer be used.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eSegmentation\u003c/code\u003e class is used to identify foreground and background pixels in an image.\u003c/p\u003e\n"],["\u003cp\u003eTo use it, you first create an \u003ccode\u003eInputImage\u003c/code\u003e from your image source (e.g., Bitmap).\u003c/p\u003e\n"],["\u003cp\u003eYou then obtain a \u003ccode\u003eSegmenter\u003c/code\u003e instance using \u003ccode\u003eSegmentation.getClient()\u003c/code\u003e with desired options.\u003c/p\u003e\n"],["\u003cp\u003eFinally, you call \u003ccode\u003esegmenter.process()\u003c/code\u003e on the \u003ccode\u003eInputImage\u003c/code\u003e to get a \u003ccode\u003eSegmentationMask\u003c/code\u003e representing the segmentation result.\u003c/p\u003e\n"],["\u003cp\u003eRemember to close the \u003ccode\u003eSegmenter\u003c/code\u003e instance using \u003ccode\u003eSegmenter.close()\u003c/code\u003e when you are finished with it.\u003c/p\u003e\n"]]],["To segment an image, obtain a `Segmenter` instance via `Segmentation.getClient(segmenterOptions)`. Create an `InputImage` from a `Bitmap` or `ByteBuffer`. Use `segmenter.process(image)` to segment the image, which returns a `Task\u003cSegmentationMask\u003e` asynchronously. Attach success and failure listeners to this task. Once finished with the `Segmenter`, call `Segmenter.close()` to release resources. `Segmenter` identifies pixels as either foreground or background.\n"],null,["# Segmentation\n\npublic class **Segmentation** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nEntry point for identifying pixels in a supplied image as being part of the foreground or\nthe background. \n\n Segmenter segmenter = Segmentation.getClient(segmenterOptions);\n\nTo perform segmentation of an image, you first need to create an instance of\n[InputImage](/android/reference/com/google/mlkit/vision/common/InputImage)\nfrom a [Bitmap](//developer.android.com/reference/android/graphics/Bitmap.html),\n[ByteBuffer](//developer.android.com/reference/java/nio/ByteBuffer.html), etc. See\n[InputImage](/android/reference/com/google/mlkit/vision/common/InputImage)\ndocumentation for more details. For example, the code below creates an [InputImage](/android/reference/com/google/mlkit/vision/common/InputImage)\nfrom a [Bitmap](//developer.android.com/reference/android/graphics/Bitmap.html). \n\n InputImage image = InputImage.fromBitmap(bitmap, rotationDegrees);\n\nThen the code below can segment the supplied [InputImage](/android/reference/com/google/mlkit/vision/common/InputImage) and asynchronously return a [SegmentationMask](/android/reference/com/google/mlkit/vision/segmentation/SegmentationMask). \n\n Task\u003cSegmentationMask\u003e task = segmenter.process(image);\n task.addOnSuccessListener(...).addOnFailureListener(...);\n\n### Public Method Summary\n\n|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [Segmenter](/android/reference/com/google/mlkit/vision/segmentation/Segmenter) | [getClient](/android/reference/com/google/mlkit/vision/segmentation/Segmentation#getClient(com.google.mlkit.vision.segmentation.selfie.SelfieSegmenterOptions))([SelfieSegmenterOptions](/android/reference/com/google/mlkit/vision/segmentation/selfie/SelfieSegmenterOptions) segmenterOptions) Gets an instance of [Segmenter](/android/reference/com/google/mlkit/vision/segmentation/Segmenter) that can segment the foreground and the background of an image. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Methods\n--------------\n\n#### public static [Segmenter](/android/reference/com/google/mlkit/vision/segmentation/Segmenter)\n**getClient** ([SelfieSegmenterOptions](/android/reference/com/google/mlkit/vision/segmentation/selfie/SelfieSegmenterOptions) segmenterOptions)\n\nGets an instance of [Segmenter](/android/reference/com/google/mlkit/vision/segmentation/Segmenter)\nthat can segment the foreground and the background of an image.\n\nTo release the resources associated with a [Segmenter](/android/reference/com/google/mlkit/vision/segmentation/Segmenter),\nyou need to ensure that [Segmenter.close()](/android/reference/com/google/mlkit/vision/segmentation/Segmenter#close())\nis called on the resulting [Segmenter](/android/reference/com/google/mlkit/vision/segmentation/Segmenter)\ninstance once it will no longer be used."]]
