apple.metalperformanceshaders

Class MPSNNLocalCorrelation

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSKernel

apple.metalperformanceshaders.MPSCNNBinaryKernel

apple.metalperformanceshaders.MPSNNReduceBinary

apple.metalperformanceshaders.MPSNNLocalCorrelation

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject

public class MPSNNLocalCorrelation
extends MPSNNReduceBinary

MPSNNLocalCorrelation

The MPSNNLocalCorrelation filter computes the correlation between two images locally with a varying offset on x-y plane between the two source images (controlled by the window and stride properties) and the end result is summed over the feature channels. The results are stored in the different feature channels of the destination image, ordered such that the offset in the x direction is the faster running index.

Given two images A and B, the output image has (2*windowInX + 1)*(2*windowInY + 1) feature channels, with each feature channel computed as: O(x, y, f(m, n)) = sum_z{A(x, y, z) * B(x + M[m], y + N[n], z)} where m runs from {0, 1, ... , (2*windowInX)}, n runs from {0, 1, ... , (2*windowInY)}, f(m, n) = n * (2*windowInY + 1) + m, M = {-windowInX*strideInX, (-windowInX + 1)*strideInX, ... 0 ... , (windowInX - 1)*strideInX, windowInX*strideInX}, N = {-windowInY*strideInY, (-windowInY + 1)*strideInY, ... 0 ... , (windowInY - 1)*strideInY, windowInX*strideInY}

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	MPSNNLocalCorrelation(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
boolean	_supportsSecureCoding() This property must return YES on all classes that allow secure coding.
static boolean	accessInstanceVariablesDirectly()
static MPSNNLocalCorrelation	alloc()
static MPSNNLocalCorrelation	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()
MPSNNLocalCorrelation	init()
MPSNNLocalCorrelation	initWithCoder(NSCoder aDecoder) NS_DESIGNATED_INITIALIZER
MPSNNLocalCorrelation	initWithCoderDevice(NSCoder aDecoder, java.lang.Object device) NSSecureCoding compatability
MPSNNLocalCorrelation	initWithDevice(java.lang.Object device) Initialize the MPSNNLocalCorrelation filter with default property values.
MPSNNLocalCorrelation	initWithDeviceWindowInXWindowInYStrideInXStrideInY(MTLDevice device, long windowInX, long windowInY, long strideInX, long strideInY) Specifies information to apply the local correlation operation on an image.
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 MPSNNLocalCorrelation	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setStrideInX(long value) Specifies the stride for the offset in the x dimension.
void	setStrideInY(long value) Specifies the stride for the offset in the y dimension.
static void	setVersion_static(long aVersion)
void	setWindowInX(long value) Specifies a symmetric window around 0 for offsetting the secondary source in the x dimension.
void	setWindowInY(long value) Specifies a symmetric window around 0 for offsetting the secondary source in the y dimension.
long	strideInX() Specifies the stride for the offset in the x dimension.
long	strideInY() Specifies the stride for the offset in the y dimension.
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
static long	version_static()
long	windowInX() Specifies a symmetric window around 0 for offsetting the secondary source in the x dimension.
long	windowInY() Specifies a symmetric window around 0 for offsetting the secondary source in the y dimension.

Methods inherited from class apple.metalperformanceshaders.MPSNNReduceBinary

primaryOffset, primarySourceClipRect, secondaryOffset, secondarySourceClipRect, setPrimaryOffset, setPrimarySourceClipRect, setSecondaryOffset, setSecondarySourceClipRect

Methods inherited from class apple.metalperformanceshaders.MPSCNNBinaryKernel

appendBatchBarrier, clipRect, destinationFeatureChannelOffset, destinationImageAllocator, destinationImageDescriptorForSourceImagesSourceStates, encodeToCommandBufferPrimaryImageSecondaryImage, encodeToCommandBufferPrimaryImageSecondaryImageDestinationImage, encodeToCommandBufferPrimaryImageSecondaryImageDestinationStateDestinationStateIsTemporary, encodingStorageSizeForPrimaryImageSecondaryImageSourceStatesDestinationImage, isBackwards, isResultStateReusedAcrossBatch, isStateModified, padding, primaryDilationRateX, primaryDilationRateY, primaryEdgeMode, primaryKernelHeight, primaryKernelWidth, primarySourceFeatureChannelMaxCount, primarySourceFeatureChannelOffset, primaryStrideInPixelsX, primaryStrideInPixelsY, resultStateForPrimaryImageSecondaryImageSourceStatesDestinationImage, secondaryDilationRateX, secondaryDilationRateY, secondaryEdgeMode, secondaryKernelHeight, secondaryKernelWidth, secondarySourceFeatureChannelMaxCount, secondarySourceFeatureChannelOffset, secondaryStrideInPixelsX, secondaryStrideInPixelsY, setClipRect, setDestinationFeatureChannelOffset, setDestinationImageAllocator, setPadding, setPrimaryEdgeMode, setPrimarySourceFeatureChannelMaxCount, setPrimarySourceFeatureChannelOffset, setPrimaryStrideInPixelsX, setPrimaryStrideInPixelsY, setSecondaryEdgeMode, setSecondarySourceFeatureChannelMaxCount, setSecondarySourceFeatureChannelOffset, setSecondaryStrideInPixelsX, setSecondaryStrideInPixelsY, temporaryResultStateForCommandBufferPrimaryImageSecondaryImageSourceStatesDestinationImage

Methods inherited from class apple.metalperformanceshaders.MPSKernel

copyWithZone, copyWithZoneDevice, device, encodeWithCoder, label, options, setLabel, setOptions

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

MPSNNLocalCorrelation

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSNNLocalCorrelation alloc()

allocWithZone

public static MPSNNLocalCorrelation 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 MPSNNLocalCorrelation init()

Overrides:

init in class MPSNNReduceBinary

initWithCoder

public MPSNNLocalCorrelation initWithCoder(NSCoder aDecoder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class MPSNNReduceBinary

initWithCoderDevice

public MPSNNLocalCorrelation initWithCoderDevice(NSCoder aDecoder,
                                                 java.lang.Object device)

NSSecureCoding compatability

See @ref MPSKernel#initWithCoder.

Overrides:

initWithCoderDevice in class MPSNNReduceBinary

Parameters:

aDecoder - The NSCoder subclass with your serialized MPSCNNPooling

device - The MTLDevice on which to make the MPSCNNPooling

Returns:

A new MPSCNNPooling object, or nil if failure.

initWithDevice

public MPSNNLocalCorrelation initWithDevice(java.lang.Object device)

Initialize the MPSNNLocalCorrelation filter with default property values.

Overrides:

initWithDevice in class MPSNNReduceBinary

Parameters:

device - The device the filter will run on

Returns:

A valid MPSNNReduceLocalCorrelation object or nil, if failure.

initWithDeviceWindowInXWindowInYStrideInXStrideInY

public MPSNNLocalCorrelation initWithDeviceWindowInXWindowInYStrideInXStrideInY(MTLDevice device,
                                                                                long windowInX,
                                                                                long windowInY,
                                                                                long strideInX,
                                                                                long strideInY)

Specifies information to apply the local correlation operation on an image.

Parameters:

device - The device the filter will run on

windowInX - Specifies a symmetric window around 0 for offsetting the secondary source in the x dimension.

windowInY - Specifies a symmetric window around 0 for offsetting the secondary source in the y dimension.

strideInX - Specifies the stride for the offset in the x dimension.

strideInY - Specifies the stride for the offset in the y dimension.

Returns:

A valid MPSNNReduceLocalCorrelation object or nil, if failure.

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 MPSNNLocalCorrelation new_objc()

resolveClassMethod

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

resolveInstanceMethod

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

setStrideInX

public void setStrideInX(long value)

Specifies the stride for the offset in the x dimension.

strideInX must be > 0. The default value for strideInX is 1.

setStrideInY

public void setStrideInY(long value)

Specifies the stride for the offset in the y dimension.

strideInY must be > 0. The default value for strideInY is 1.

setVersion_static

public static void setVersion_static(long aVersion)

setWindowInX

public void setWindowInX(long value)

Specifies a symmetric window around 0 for offsetting the secondary source in the x dimension.

The default value for windowInX is 0.

setWindowInY

public void setWindowInY(long value)

Specifies a symmetric window around 0 for offsetting the secondary source in the y dimension.

The default value for windowInY is 0.

strideInX

public long strideInX()

Specifies the stride for the offset in the x dimension.

strideInX must be > 0. The default value for strideInX is 1.

strideInY

public long strideInY()

Specifies the stride for the offset in the y dimension.

strideInY must be > 0. The default value for strideInY is 1.

superclass_static

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

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

Overrides:

_supportsSecureCoding in class MPSNNReduceBinary

version_static

public static long version_static()

windowInX

public long windowInX()

Specifies a symmetric window around 0 for offsetting the secondary source in the x dimension.

The default value for windowInX is 0.

windowInY

public long windowInY()

Specifies a symmetric window around 0 for offsetting the secondary source in the y dimension.

The default value for windowInY is 0.