Package apple.metalperformanceshaders

Class 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} API-Since: 13.0

    • Constructor Detail

      • MPSNNLocalCorrelation

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • 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()

      • initWithCoderDevice

        public MPSNNLocalCorrelation initWithCoderDevice​(@NotNull
                                                 @NotNull NSCoder aDecoder,
                                                 @NotNull
                                                 @NotNull 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​(@NotNull
                                            @NotNull 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​(@NotNull
                                                                                @NotNull 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.

      • 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

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

      • 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.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.