Added MPPImageClassifierOptions

mediapipe/tasks/ios/vision/image_classifier/BUILD

@@ -26,3 +26,13 @@ objc_library(
     ],
 )
 
+objc_library(
+    name = "MPPImageClassifierOptions",
+    srcs = ["sources/MPPImageClassifierOptions.m"],
+    hdrs = ["sources/MPPImageClassifierOptions.h"],
+    deps = [
+        ":MPPImageClassifierResult",
+        "//mediapipe/tasks/ios/core:MPPTaskOptions",
+        "//mediapipe/tasks/ios/vision/core:MPPRunningMode",
+    ],
+)

mediapipe/tasks/ios/vision/image_classifier/sources/MPPImageClassifierOptions.h

@@ -0,0 +1,70 @@
+// Copyright 2023 The MediaPipe Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#import <Foundation/Foundation.h>
+
+#import "mediapipe/tasks/ios/core/sources/MPPTaskOptions.h"
+#import "mediapipe/tasks/ios/vision/core/sources/MPPRunningMode.h"
+#import "mediapipe/tasks/ios/vision/image_classifier/sources/MPPImageClassifierResult.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Options for setting up a `MPPImageClassifier`.
+ */
+NS_SWIFT_NAME(ImageClassifierOptions)
+@interface MPPImageClassifierOptions : MPPTaskOptions <NSCopying>
+
+@property(nonatomic) MPPRunningMode runningMode;
+
+/** 
+ * The user-defined result callback for processing live stream data. The result callback should only be specified when the running mode is set to the live stream mode.
+ */
+@property(nonatomic, copy) void (^completion)(MPPImageClassifierResult *result, NSError *error);
+
+/**
+ * The locale to use for display names specified through the TFLite Model Metadata, if any. Defaults
+ * to English.
+ */
+@property(nonatomic, copy) NSString *displayNamesLocale;
+
+/**
+ * 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.
+ */
+@property(nonatomic) NSInteger maxResults;
+
+/**
+ * Score threshold to override the one provided in the model metadata (if any). Results below this
+ * value are rejected.
+ */
+@property(nonatomic) float scoreThreshold;
+
+/**
+ * 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.
+ */
+@property(nonatomic, copy) NSArray<NSString *> *categoryAllowlist;
+
+/**
+ * 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.
+ */
+@property(nonatomic, copy) NSArray<NSString *> *categoryDenylist;
+
+@end
+
+NS_ASSUME_NONNULL_END

mediapipe/tasks/ios/vision/image_classifier/sources/MPPImageClassifierOptions.m

@@ -0,0 +1,41 @@
+// Copyright 2023 The MediaPipe Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#import "mediapipe/tasks/ios/vision/image_classifier/sources/MPPImageClassifierOptions.h"
+
+@implementation MPPImageClassifierOptions
+
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    _maxResults = -1;
+    _scoreThreshold = 0;
+  }
+  return self;
+}
+
+- (id)copyWithZone:(NSZone *)zone {
+  MPPImageClassifierOptions *imageClassifierOptions = [super copyWithZone:zone];
+
+  imageClassifierOptions.scoreThreshold = self.scoreThreshold;
+  imageClassifierOptions.maxResults = self.maxResults;
+  imageClassifierOptions.categoryDenylist = self.categoryDenylist;
+  imageClassifierOptions.categoryAllowlist = self.categoryAllowlist;
+  imageClassifierOptions.displayNamesLocale = self.displayNamesLocale;
+  imageClassifierOptions.completion = self.completion;
+
+  return imageClassifierOptions;
+}
+
+@end