apple.vision

Class VNImageRequestHandler

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.vision.VNImageRequestHandler

All Implemented Interfaces:

NSObject

public class VNImageRequestHandler
extends NSObject

Performs requests on a single image.

The VNImageRequestHandler is created with an image that is used to be used for the requests a client might want to schedule. The VNImageRequestHandler retains, but never modifies, the image source for its entire lifetime. The client also must not modify the content of the image source once the VNImageRequestHandler is created otherwise the results are undefined. The VNImageRequestHandler can choose to also cache intermediate representation of the image or other request-specific information for the purposes of runtime performance.

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VNImageRequestHandler(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static VNImageRequestHandler	alloc()
static VNImageRequestHandler	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static long	hash_static()
VNImageRequestHandler	init()
VNImageRequestHandler	initWithCGImageOptions(CGImageRef image, NSDictionary<java.lang.String,?> options) initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.
VNImageRequestHandler	initWithCGImageOrientationOptions(CGImageRef image, int orientation, NSDictionary<java.lang.String,?> options) initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.
VNImageRequestHandler	initWithCIImageOptions(CIImage image, NSDictionary<java.lang.String,?> options) initWithCIImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage.
VNImageRequestHandler	initWithCIImageOrientationOptions(CIImage image, int orientation, NSDictionary<java.lang.String,?> options) initWithCIImage:options:orientation creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage.
VNImageRequestHandler	initWithCMSampleBufferOptions(CMSampleBufferRef sampleBuffer, NSDictionary<java.lang.String,?> options) Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef
VNImageRequestHandler	initWithCMSampleBufferOrientationOptions(CMSampleBufferRef sampleBuffer, int orientation, NSDictionary<java.lang.String,?> options) Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef
VNImageRequestHandler	initWithCVPixelBufferOptions(CVBufferRef pixelBuffer, NSDictionary<java.lang.String,?> options) initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.
VNImageRequestHandler	initWithCVPixelBufferOrientationOptions(CVBufferRef pixelBuffer, int orientation, NSDictionary<java.lang.String,?> options) initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.
VNImageRequestHandler	initWithDataOptions(NSData imageData, NSDictionary<java.lang.String,?> options) initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object.
VNImageRequestHandler	initWithDataOrientationOptions(NSData imageData, int orientation, NSDictionary<java.lang.String,?> options) initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object.
VNImageRequestHandler	initWithURLOptions(NSURL imageURL, NSDictionary<java.lang.String,?> options) initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL
VNImageRequestHandler	initWithURLOrientationOptions(NSURL imageURL, int orientation, NSDictionary<java.lang.String,?> options) initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
static VNImageRequestHandler	new_objc()
boolean	performRequestsError(NSArray<? extends VNRequest> requests, org.moe.natj.general.ptr.Ptr<NSError> error) performRequests schedules one or more VNRequests to be performed.
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VNImageRequestHandler

protected VNImageRequestHandler(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static VNImageRequestHandler alloc()

allocWithZone

public static VNImageRequestHandler allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

init

public VNImageRequestHandler init()

Overrides:

init in class NSObject

initWithCGImageOptions

public VNImageRequestHandler initWithCGImageOptions(CGImageRef image,
                                                    NSDictionary<java.lang.String,?> options)

initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.

Parameters:

image - A CGImageRef containing the image to be used for performing the requests. The content of the image cannot be modified.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithCGImageOrientationOptions

public VNImageRequestHandler initWithCGImageOrientationOptions(CGImageRef image,
                                                               int orientation,
                                                               NSDictionary<java.lang.String,?> options)

initWithCGImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CGImageRef.

Parameters:

image - A CGImageRef containing the image to be used for performing the requests. The content of the image cannot be modified.

orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithCIImageOptions

public VNImageRequestHandler initWithCIImageOptions(CIImage image,
                                                    NSDictionary<java.lang.String,?> options)

initWithCIImage:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage.

[@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator. The orientation of the original image should be applied for instance by using imageByApplyingOrientation or use the initWithCIImage:options:orientation API.

Parameters:

image - A CIImage containing the image to be used for performing the requests. The content of the image cannot be modified.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithCIImageOrientationOptions

public VNImageRequestHandler initWithCIImageOrientationOptions(CIImage image,
                                                               int orientation,
                                                               NSDictionary<java.lang.String,?> options)

initWithCIImage:options:orientation creates a VNImageRequestHandler to be used for performing requests against the image passed in as a CIImage.

[@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator

Parameters:

image - A CIImage containing the image to be used for performing the requests. The content of the image cannot be modified.

orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithCVPixelBufferOptions

public VNImageRequestHandler initWithCVPixelBufferOptions(CVBufferRef pixelBuffer,
                                                          NSDictionary<java.lang.String,?> options)

initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.

Parameters:

pixelBuffer - A CVPixelBuffer containing the image to be used for performing the requests. The content of the buffer cannot be modified for the lifetime of the VNImageRequestHandler.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithCVPixelBufferOrientationOptions

public VNImageRequestHandler initWithCVPixelBufferOrientationOptions(CVBufferRef pixelBuffer,
                                                                     int orientation,
                                                                     NSDictionary<java.lang.String,?> options)

initWithCVPixelBuffer:options creates a VNImageRequestHandler to be used for performing requests against the image passed in as buffer.

Parameters:

pixelBuffer - A CVPixelBuffer containing the image to be used for performing the requests. The content of the buffer cannot be modified for the lifetime of the VNImageRequestHandler.

orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithDataOptions

public VNImageRequestHandler initWithDataOptions(NSData imageData,
                                                 NSDictionary<java.lang.String,?> options)

initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object.

[@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator

Parameters:

imageData - An NSData object containing the content of the image to be used for performing the requests. See CIImage imageWithData for supported format. The content of the image cannot be modified.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithDataOrientationOptions

public VNImageRequestHandler initWithDataOrientationOptions(NSData imageData,
                                                            int orientation,
                                                            NSDictionary<java.lang.String,?> options)

initWithData:options creates a VNImageRequestHandler to be used for performing requests against an image contained in an NSData object.

[@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator

Parameters:

imageData - An NSData object containing the content of the image to be used for performing the requests. See CIImage imageWithData for supported format. The content of the image cannot be modified.

orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithURLOptions

public VNImageRequestHandler initWithURLOptions(NSURL imageURL,
                                                NSDictionary<java.lang.String,?> options)

initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL

[@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator

Parameters:

imageURL - A URL pointing at an image to be used for performing the requests. The image has to be in a format that is supported by ImageIO. The content of the image cannot be modified.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithURLOrientationOptions

public VNImageRequestHandler initWithURLOrientationOptions(NSURL imageURL,
                                                           int orientation,
                                                           NSDictionary<java.lang.String,?> options)

initWithURL:options creates a VNImageRequestHandler to be used for performing requests against an image specified by it's URL

[@note] Request results may not be accurate in simulator due to CI's inability to render certain pixel formats in the simulator

Parameters:

imageURL - A URL pointing at an image to be used for performing the requests. The image has to be in a format that is supported by ImageIO. The content of the image cannot be modified.

orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

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

instancesRespondToSelector

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

isSubclassOfClass

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

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static VNImageRequestHandler new_objc()

performRequestsError

public boolean performRequestsError(NSArray<? extends VNRequest> requests,
                                    org.moe.natj.general.ptr.Ptr<NSError> error)

performRequests schedules one or more VNRequests to be performed. The function returns once all requests have been finished.

The results of the VNRequests as well any possible errors of the individual requests are reported in the VNRequests results and error properties.

Parameters:

requests - An NSArray of VNRequests that are to be performed.

error - Returns an error that happened during scheduling of the requests. Check individual requests results and errors for their respective success and failures. This parameter is optional.

Returns:

Returns true if all requests were scheduled and performed. Check individual requests results and errors for their respective success and failures.

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)

superclass_static

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

version_static

public static long version_static()

initWithCMSampleBufferOptions

public VNImageRequestHandler initWithCMSampleBufferOptions(CMSampleBufferRef sampleBuffer,
                                                           NSDictionary<java.lang.String,?> options)

Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef

[@note] CMSampleBuffers can contain metadata like camera intrinsics that will be used by algorithms supporting it unless overwritten by the options.

Parameters:

sampleBuffer - A CMSampleBuffer containing the imageBuffer that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics

initWithCMSampleBufferOrientationOptions

public VNImageRequestHandler initWithCMSampleBufferOrientationOptions(CMSampleBufferRef sampleBuffer,
                                                                      int orientation,
                                                                      NSDictionary<java.lang.String,?> options)

Creates a VNImageRequestHandler to be used for performing requests against the image buffer contained in the CMSampleBufferRef

[@note] CMSampleBuffers can contain metadata like camera intrinsics that will be used by algorithms supporting it unless overwritten by the options. [@note] Because CoreImage is unable to render certain pixel formats in the iOS simulator, request results may not be accurate in those cases.

Parameters:

sampleBuffer - A CMSampleBuffer containing the imageBuffer that will be used for performing the requests. Not all types of sample buffers are supported. They need to contain a CVImageBuffer, be valid and ready.

orientation - The orientation of the image/buffer based on the EXIF specification. For details see kCGImagePropertyOrientation. The value has to be an integer from 1 to 8. This supersedes every other orientation information.

options - A dictionary with options specifying auxiliary information for the buffer/image like VNImageOptionCameraIntrinsics