MLKitSegmentationCommon Framework Reference

MLKSegmenter


@interface MLKSegmenter : NSObject

A detector that performs segmentation on input images.

  • Returns a segmenter with the given options.

    Declaration

    Objective-C

    + (nonnull instancetype)segmenterWithOptions:
    (nonnull MLKCommonSegmenterOptions *)options;

    Parameters

    options

    Options for configuring the segmenter.

    Return Value

    A segmenter configured with the given options.

  • Unavailable. Use the class methods.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Processes the given image for segmentation.

    Declaration

    Objective-C

    - (void)processImage:(nonnull id<MLKCompatibleImage>)image
          completion:(nonnull MLKSegmentationCallback)completion;

    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

    Objective-C

    - (nullable MLKSegmentationMask *)
    resultsInImage:(nonnull id<MLKCompatibleImage>)image
             error:(NSError *_Nullable *_Nullable)error;

    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.