Package apple.coreml

Class MLFeatureValue

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject

    public class MLFeatureValue
    extends NSObject
    implements NSCopying, NSSecureCoding
    An immutable variant holding a data value of a supported MLFeatureType MLFeatureValue does not support type conversion in its accessor properties. It can also have a missing or undefined value of a well defined type. API-Since: 11.0
    • Constructor Detail

      • MLFeatureValue

        protected MLFeatureValue​(org.moe.natj.general.Pointer peer)
    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()
      • allocWithZone

        public static MLFeatureValue allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)
      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                                   @NotNull java.lang.String key)
      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                                   @NotNull java.lang.Object aTarget)
      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                                 @NotNull java.lang.Object aTarget,
                                                                                 @NotNull
                                                                                 @NotNull org.moe.natj.objc.SEL aSelector,
                                                                                 @Nullable
                                                                                 @Nullable java.lang.Object anArgument)
      • classFallbacksForKeyedArchiver

        @NotNull
        public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()
      • classForKeyedUnarchiver

        @NotNull
        public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()
      • copyWithZone

        @NotNull
        public @NotNull java.lang.Object copyWithZone​(@Nullable
                                                      @Nullable org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying
      • debugDescription_static

        public static java.lang.String debugDescription_static()
      • description_static

        public static java.lang.String description_static()
      • dictionaryValue

        @NotNull
        public @NotNull NSDictionary<?,​? extends NSNumber> dictionaryValue()
        Populated value if the type is MLFeatureTypeDictionary
      • doubleValue

        public double doubleValue()
        Populated value if the type is MLFeatureTypeDouble
      • featureValueWithDictionaryError

        public static MLFeatureValue featureValueWithDictionaryError​(@NotNull
                                                                     @NotNull NSDictionary<?,​? extends NSNumber> value,
                                                                     @Nullable
                                                                     @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        For encoding a sparse feature set or for encoding probabilities. Input keys that are not NSNumber * or NSString * are rejected on construction and return a MLModelErrorFeatureTypeMismatch error. Further validation for consistency occurs on evaluation
      • featureValueWithDouble

        public static MLFeatureValue featureValueWithDouble​(double value)
      • featureValueWithInt64

        public static MLFeatureValue featureValueWithInt64​(long value)
        Hold an object with the specified value
      • featureValueWithPixelBuffer

        public static MLFeatureValue featureValueWithPixelBuffer​(@NotNull
                                                                 @NotNull CVBufferRef value)
      • featureValueWithString

        public static MLFeatureValue featureValueWithString​(@NotNull
                                                            @NotNull java.lang.String value)
      • hash_static

        public static long hash_static()
      • imageBufferValue

        @Nullable
        public @Nullable CVBufferRef imageBufferValue()
        Populated value if the type is MLFeatureTypeImage
      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)
      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)
      • int64Value

        public long int64Value()
        Populated value if the type is MLFeatureTypeInt64
      • isEqualToFeatureValue

        public boolean isEqualToFeatureValue​(@NotNull
                                             @NotNull MLFeatureValue value)
        Returns a Boolean value that indicates whether a feature value is equal to another. If the types of the MLFeatureValue objects "self" and "value" are integer in one case and double in the other (in either order) then those mixed mode numeric values are compared as NSNumbers. Otherwise if the types of the MLFeatureValue objects are different NO is returned. When "self" and "value" are both PixelBuffer MLFeatureValue types, only their CVPixelBufferRef values are compared for equality, the underlying arrays of pixelValues are not examined. [So, distinct PixelBuffer MLFeatureValue objects with distinct CVPixelBufferRef values which encapsulate the same array of pixels will compare *not* equal.] For all other (matching) MLFeatureValue types, the BOOL value returned is the result of comparing "self" with "value" via isEqualToNumber:, isEqualToString:, isEqualtoDictionary:, isEqualToMultiArray:, isEqualToArray: as chosen by the MLFeatureValue types.
      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)
      • isUndefined

        public boolean isUndefined()
        True if the value represents a missing or undefined value
      • keyPathsForValuesAffectingValueForKey

        @NotNull
        public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                             @NotNull java.lang.String key)
      • multiArrayValue

        @Nullable
        public @Nullable MLMultiArray multiArrayValue()
        Populated value if the type is MLFeatureTypeMultiArray
      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)
      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)
      • setVersion_static

        public static void setVersion_static​(long aVersion)
      • stringValue

        @NotNull
        public @NotNull java.lang.String stringValue()
        Populated value if the type is MLFeatureTypeString
      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()
      • type

        public long type()
        Type of the value for which the corresponding property below is held
      • undefinedFeatureValueWithType

        @NotNull
        public static @NotNull MLFeatureValue undefinedFeatureValueWithType​(long type)
        Represent an undefined value of a specified type
      • version_static

        public static long version_static()
      • featureValueWithCGImageConstraintOptionsError

        public static MLFeatureValue featureValueWithCGImageConstraintOptionsError​(@NotNull
                                                                                   @NotNull CGImageRef cgImage,
                                                                                   @NotNull
                                                                                   @NotNull MLImageConstraint constraint,
                                                                                   @Nullable
                                                                                   @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                   @Nullable
                                                                                   @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from CGImage, using the size and type information required by feature description (orientation is assumed to be kCGImagePropertyOrientationUp)
      • featureValueWithCGImageOrientationConstraintOptionsError

        public static MLFeatureValue featureValueWithCGImageOrientationConstraintOptionsError​(@NotNull
                                                                                              @NotNull CGImageRef cgImage,
                                                                                              int orientation,
                                                                                              @NotNull
                                                                                              @NotNull MLImageConstraint constraint,
                                                                                              @Nullable
                                                                                              @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                              @Nullable
                                                                                              @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from CGImage w/ specified orientation, using the size and type information required by feature description
      • featureValueWithCGImageOrientationPixelsWidePixelsHighPixelFormatTypeOptionsError

        public static MLFeatureValue featureValueWithCGImageOrientationPixelsWidePixelsHighPixelFormatTypeOptionsError​(@NotNull
                                                                                                                       @NotNull CGImageRef cgImage,
                                                                                                                       int orientation,
                                                                                                                       long pixelsWide,
                                                                                                                       long pixelsHigh,
                                                                                                                       int pixelFormatType,
                                                                                                                       @Nullable
                                                                                                                       @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                                                       @Nullable
                                                                                                                       @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from CGImage w/ specified orientation
      • featureValueWithCGImagePixelsWidePixelsHighPixelFormatTypeOptionsError

        public static MLFeatureValue featureValueWithCGImagePixelsWidePixelsHighPixelFormatTypeOptionsError​(@NotNull
                                                                                                            @NotNull CGImageRef cgImage,
                                                                                                            long pixelsWide,
                                                                                                            long pixelsHigh,
                                                                                                            int pixelFormatType,
                                                                                                            @Nullable
                                                                                                            @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                                            @Nullable
                                                                                                            @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from CGImage (orientation is assumed to be kCGImagePropertyOrientationUp)
      • featureValueWithImageAtURLConstraintOptionsError

        public static MLFeatureValue featureValueWithImageAtURLConstraintOptionsError​(@NotNull
                                                                                      @NotNull NSURL url,
                                                                                      @NotNull
                                                                                      @NotNull MLImageConstraint constraint,
                                                                                      @Nullable
                                                                                      @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                      @Nullable
                                                                                      @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from an image on disk, using a model specified image constraint. Orientation is read from Exif if avaiable
      • featureValueWithImageAtURLOrientationConstraintOptionsError

        public static MLFeatureValue featureValueWithImageAtURLOrientationConstraintOptionsError​(@NotNull
                                                                                                 @NotNull NSURL url,
                                                                                                 int orientation,
                                                                                                 @NotNull
                                                                                                 @NotNull MLImageConstraint constraint,
                                                                                                 @Nullable
                                                                                                 @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                                 @Nullable
                                                                                                 @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from an image on disk using a model specified image constraint. The passed in orientation supersedes any in the file
      • featureValueWithImageAtURLOrientationPixelsWidePixelsHighPixelFormatTypeOptionsError

        public static MLFeatureValue featureValueWithImageAtURLOrientationPixelsWidePixelsHighPixelFormatTypeOptionsError​(@NotNull
                                                                                                                          @NotNull NSURL url,
                                                                                                                          int orientation,
                                                                                                                          long pixelsWide,
                                                                                                                          long pixelsHigh,
                                                                                                                          int pixelFormatType,
                                                                                                                          @Nullable
                                                                                                                          @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                                                          @Nullable
                                                                                                                          @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from an image on disk. The passed in orientation supersedes any in the file
      • featureValueWithImageAtURLPixelsWidePixelsHighPixelFormatTypeOptionsError

        public static MLFeatureValue featureValueWithImageAtURLPixelsWidePixelsHighPixelFormatTypeOptionsError​(@NotNull
                                                                                                               @NotNull NSURL url,
                                                                                                               long pixelsWide,
                                                                                                               long pixelsHigh,
                                                                                                               int pixelFormatType,
                                                                                                               @Nullable
                                                                                                               @Nullable NSDictionary<java.lang.String,​?> options,
                                                                                                               @Nullable
                                                                                                               @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)
        Construct image feature value from an image on disk. Orientation is read from Exif if avaiable
      • featureValueWithSequence

        public static MLFeatureValue featureValueWithSequence​(@NotNull
                                                              @NotNull MLSequence sequence)
        API-Since: 12.0
      • sequenceValue

        @Nullable
        public @Nullable MLSequence sequenceValue()
        Populated value if the type is MLFeatureTypeSequence API-Since: 12.0
      • supportsSecureCoding

        public static boolean supportsSecureCoding()
      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding
      • useStoredAccessor

        @Deprecated
        public static boolean useStoredAccessor()
        Deprecated.