third_party/tflite_support/src/tensorflow_lite_support/ios/task/vision/sources/TFLImageClassifier.h

/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.

 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 "third_party/tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions.h"
#import "third_party/tensorflow_lite_support/ios/task/processor/sources/TFLClassificationOptions.h"
#import "third_party/tensorflow_lite_support/ios/task/processor/sources/TFLClassificationResult.h"
#import "third_party/tensorflow_lite_support/odml/ios/image/apis/GMLImage.h"

NS_ASSUME_NONNULL_BEGIN

/**
 * Options to configure TFLImageClassifier.
 */
@interface TFLImageClassifierOptions : NSObject

/**
 * Base options that is used for creation of any type of task.
 * @seealso TFLBaseOptions
 */
@property(nonatomic, copy) TFLBaseOptions* baseOptions;

/**
 * Options that configure the display and filtering of results.
 * @seealso TFLClassificationOptions
 */
@property(nonatomic, copy) TFLClassificationOptions* classificationOptions;

/**
 * Initializes TFLImageClassifierOptions with the model path set to the
 * specified path to a model file.
 * @description The external model file, must be a single standalone TFLite
 * file. It could be packed with TFLite Model Metadata[1] and associated files
 * if exist. Fail to provide the necessary metadata and associated files might
 * result in errors. Check the [documentation]
 * (https://www.tensorflow.org/lite/convert/metadata) for each task about the
 * specific requirement.
 *
 * @param modelPath Path to a TFLite model file.
 * @return An instance of TFLImageClassifierOptions set to the specified
 * modelPath.
 */
- (nullable instancetype)initWithModelPath:(nonnull NSString*)modelPath;

@end

/**
 * A TensorFlow Lite Task Image Classifiier.
 */
@interface TFLImageClassifier : NSObject

/**
 * Creates TFLImageClassifier from a model file and specified options .
 *
 * @param options TFLImageClassifierOptions instance with the necessary
 * properties set.
 *
 * @return A TFLImageClassifier instance.
 */
+ (nullable instancetype)imageClassifierWithOptions:
                             (nonnull TFLImageClassifierOptions*)options
                                              error:(NSError**)error
    NS_SWIFT_NAME(imageClassifier(options:));

/**
 * Performs classification on a GMLImage input, returns an array of
 * categorization results where each member in the array is an array of
 * TFLClass objects for each classification head.
 *
 * @param image input to the model.
 * @return An NSArray<NSArray<TFLClass *>*> * of classification results.
 */
- (nullable TFLClassificationResult*)classifyWithGMLImage:(GMLImage*)image
                                                    error:(NSError* _Nullable*)
                                                              error
    NS_SWIFT_NAME(classify(gmlImage:));

/**
 * Performs classification on a GMLImage input on the pixels in the
 * specified bounding box, returns an array of categorization results
 * where each member in the array is an array of TFLClass objects for
 * each classification head.
 *
 * @param image input to the model.
 * @param roi CGRect specifying region of interest in image.
 *
 * @return An NSArray<NSArray<TFLClass *>*> * of classification results.
 */
- (nullable TFLClassificationResult*)classifyWithGMLImage:(GMLImage*)image
                                         regionOfInterest:(CGRect)roi
                                                    error:(NSError* _Nullable*)
                                                              error
    NS_SWIFT_NAME(classify(gmlImage:regionOfInterest:));

- (instancetype)init NS_UNAVAILABLE;

+ (instancetype)new NS_UNAVAILABLE;

@end

NS_ASSUME_NONNULL_END