MLImage Framework Reference

  • MLImage is an object used for on-device machine learning, representing an image with properties like width, height, and orientation.

  • It can be initialized using various sources: a standard image, a pixel buffer, or a sample buffer, each with specific requirements.

  • If initialized with an image, the CGImage property of the input image must not be NULL for successful creation of the MLImage instance.

  • MLImage stores the source type and provides access to the underlying data through properties like image, pixelBuffer, and sampleBuffer, which may be nil depending on the source type.

MLImage

class MLImage : NSObject

An image used in on-device machine learning.

  • Width of the image in pixels.

    Declaration

    Swift

    var width: CGFloat { get }

  • Height of the image in pixels.

    Declaration

    Swift

    var height: CGFloat { get }

  • The display orientation of the image. If imageSourceType is .image, the default value is image.imageOrientation; otherwise the default value is .up.

    Declaration

    Swift

    var orientation: Int32 { get set }

  • The type of the image source.

    Declaration

    Swift

    var imageSourceType: MLImageSourceType { get }

  • The source image. nil if imageSourceType is not .image.

    Declaration

    Swift

    var image: UnsafeMutablePointer<Int32>? { get }

  • The source pixel buffer. nil if imageSourceType is not .pixelBuffer.

    Declaration

    Swift

    var pixelBuffer: CVPixelBuffer? { get }

  • The source sample buffer. nil if imageSourceType is not .sampleBuffer.

    Declaration

    Swift

    var sampleBuffer: CMSampleBuffer? { get }

  • Initializes an MLImage object with the given image.

    Declaration

    Swift

    init?(image: Any!)

    Parameters

    image

    The image to use as the source. Its CGImage property must not be NULL.

    Return Value

    A new MLImage instance with the given image as the source. nil if the given image is nil or invalid.

  • Initializes an MLImage object with the given pixel buffer.

    Declaration

    Swift

    init?(pixelBuffer: CVPixelBuffer)

    Parameters

    pixelBuffer

    The pixel buffer to use as the source. It will be retained by the new MLImage instance for the duration of its lifecycle.

    Return Value

    A new MLImage instance with the given pixel buffer as the source. nil if the given pixel buffer is nil or invalid.

  • Initializes an MLImage object with the given sample buffer.

    Declaration

    Swift

    init?(sampleBuffer: CMSampleBuffer)

    Parameters

    sampleBuffer

    The sample buffer to use as the source. It will be retained by the new MLImage instance for the duration of its lifecycle. The sample buffer must be based on a pixel buffer (not compressed data). In practice, it should be the video output of the camera on an iOS device, not other arbitrary types of CMSampleBuffers.

    Return Value

    A new MLImage instance with the given sample buffer as the source. nil if the given sample buffer is nil or invalid.

  • Unavailable.