MLKitSegmentationCommon Framework Reference

  • The Segmenter class performs segmentation on input images to identify different regions or objects.

  • It provides methods for asynchronous and synchronous processing of images for segmentation.

  • You can configure the segmenter using MLKCommonSegmenterOptions when initializing.

  • Results are provided as an MLKSegmentationMask object which can be used to understand the identified segments.

  • Direct instantiation with init is unavailable; use the provided class methods like segmenter(options:) instead.

Segmenter

class Segmenter : NSObject

A detector that performs segmentation on input images.

  • Returns a segmenter with the given options.

    Declaration

    Swift

    class func segmenter(options: MLKCommonSegmenterOptions) -> Self

    Parameters

    options

    Options for configuring the segmenter.

    Return Value

    A segmenter configured with the given options.

  • Unavailable. Use the class methods.

  • Processes the given image for segmentation.

    Declaration

    Swift

    func process(_ image: MLKitCompatibleImage) async throws -> MLKSegmentationMask

    Parameters

    image

    The image to process.
    completion

    Handler to call back on the main thread with the segmentation mask or error.

  • Returns the segmentation mask in the given image or nil if there was an error. The segmentation is performed synchronously on the calling thread.

    It is advised to call this method off the main thread to avoid blocking the UI. As a result, an NSException is raised if this method is called on the main thread.

    Declaration

    Swift

    func results(in image: MLKitCompatibleImage) throws -> MLKSegmentationMask

    Parameters

    image

    The image to get results in.
    error

    An optional error parameter populated when there is an error getting results.

    Return Value

    The segmentation mask in the given image or nil if there was an error.