MediaPipeTasksVision Framework Reference

ImageClassifierOptions

class ImageClassifierOptions: TaskOptions, NSCopying

Options for setting up a ImageClassifier.

  • The allowlist of category names. If non-empty, detection results whose category name is not in this set will be filtered out. Duplicate or unknown category names are ignored. Mutually exclusive with categoryDenylist.

    Declaration

    Swift

    var categoryAllowlist: [String] { get set }

  • The denylist of category names. If non-empty, detection results whose category name is in this set will be filtered out. Duplicate or unknown category names are ignored. Mutually exclusive with categoryAllowlist.

    Declaration

    Swift

    var categoryDenylist: [String] { get set }

  • The locale to use for display names specified through the TFLite Model Metadata, if any. Defaults to English.

    Declaration

    Swift

    var displayNamesLocale: String { get set }

  • An object that confirms to ImageClassifierLiveStreamDelegate protocol. This object must implement objectDetector(_:didFinishDetectionWithResult:timestampInMilliseconds:error:) to receive the results of asynchronous classification on images (i.e, when runningMode = .liveStream).

    Declaration

    Swift

    weak var imageClassifierLiveStreamDelegate: (any ImageClassifierLiveStreamDelegate)? { get set }

  • The maximum number of top-scored classification results to return. If < 0, all available results will be returned. If 0, an invalid argument error is returned.

    Declaration

    Swift

    var maxResults: Int { get set }

  • Running mode of the image classifier task. Defaults to .image. ImageClassifier can be created with one of the following running modes: 1. .image: The mode for performing classification on single image inputs. 2. .video: The mode for performing classification on the decoded frames of a video. 3. .liveStream: The mode for performing classification on a live stream of input data, such as from the camera.

    Declaration

    Swift

    var runningMode: RunningMode { get set }

  • Score threshold to override the one provided in the model metadata (if any). Results below this value are rejected.

    Declaration

    Swift

    var scoreThreshold: CFloat { get set }