Package apple.metalperformanceshaders

Class MPSCNNPoolingAverage

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class MPSCNNPoolingAverage
extends MPSCNNPooling
    MPSCNNPoolingAverage [@dependency] This depends on Metal.framework Specifies the average pooling filter. For each pixel, returns the mean value of pixels in the kernelWidth x kernelHeight filter region. When @ref edgeMode is @ref MPSImageEdgeModeClamp the filtering window is shrunk to remain within the source image borders. What this means is that close to image borders the filtering window will be smaller in order to fit inside the source image and less values will be used to compute the average. In case the filtering window is entirely outside the source image border the outputted value will be zero.

    • Constructor Detail

      • MPSCNNPoolingAverage

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object 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()

      • 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 java.lang.Object new_objc()

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

      • initWithDevice

        public MPSCNNPoolingAverage initWithDevice​(java.lang.Object device)
        Description copied from class: MPSCNNKernel
        Standard init with default properties per filter type
        Overrides:
        initWithDevice in class MPSCNNPooling
        Parameters:
        device - The device that the filter will be used on. May not be NULL.
        Returns:
        A pointer to the newly initialized object. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later.

      • initWithDeviceKernelWidthKernelHeight

        public MPSCNNPoolingAverage initWithDeviceKernelWidthKernelHeight​(MTLDevice device,
                                                                  long kernelWidth,
                                                                  long kernelHeight)
        Description copied from class: MPSCNNPooling
        Initialize a pooling filter
        Overrides:
        initWithDeviceKernelWidthKernelHeight in class MPSCNNPooling
        Parameters:
        device - The device the filter will run on
        kernelWidth - The width of the kernel. Can be an odd or even value.
        kernelHeight - The height of the kernel. Can be an odd or even value.
        Returns:
        A valid MPSCNNPooling object or nil, if failure.

      • initWithDeviceKernelWidthKernelHeightStrideInPixelsXStrideInPixelsY

        public MPSCNNPoolingAverage initWithDeviceKernelWidthKernelHeightStrideInPixelsXStrideInPixelsY​(MTLDevice device,
                                                                                                long kernelWidth,
                                                                                                long kernelHeight,
                                                                                                long strideInPixelsX,
                                                                                                long strideInPixelsY)
        Initialize a MPSCNNPoolingAverage pooling filter
        Overrides:
        initWithDeviceKernelWidthKernelHeightStrideInPixelsXStrideInPixelsY in class MPSCNNPooling
        Parameters:
        device - The device the filter will run on
        kernelWidth - The width of the kernel. Can be an odd or even value.
        kernelHeight - The height of the kernel. Can be an odd or even value.
        strideInPixelsX - The output stride (downsampling factor) in the x dimension.
        strideInPixelsY - The output stride (downsampling factor) in the y dimension.
        Returns:
        A valid MPSCNNPooling object or nil, if failure.

      • initWithCoderDevice

        public MPSCNNPoolingAverage initWithCoderDevice​(NSCoder aDecoder,
                                                java.lang.Object device)
        NSSecureCoding compatability See @ref MPSKernel#initWithCoder.
        Overrides:
        initWithCoderDevice in class MPSCNNPooling
        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.

      • setZeroPadSizeX

        public void setZeroPadSizeX​(long value)
        [@property] zeroPadSizeX How much zero padding to apply to both left and right borders of the input image for average pooling, when using @see edgeMode MPSImageEdgeModeClamp. For @see edgeMode MPSImageEdgeModeZero this property is ignored and the area outside the image is interpreted to contain zeros. The zero padding size is used to shrink the pooling window to fit inside the area bound by the source image and its padding region, but the effect is that the normalization factor of the average computation is computed also for the zeros in the padding region.

      • setZeroPadSizeY

        public void setZeroPadSizeY​(long value)
        [@property] zeroPadSizeY How much zero padding to apply to both top and bottom borders of the input image for average pooling, when using @see edgeMode MPSImageEdgeModeClamp. For @see edgeMode MPSImageEdgeModeZero this property is ignored and the area outside the image is interpreted to contain zeros. The zero padding size is used to shrink the pooling window to fit inside the area bound by the source image and its padding region, but the effect is that the normalization factor of the average computation is computed also for the zeros in the padding region.

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

      • zeroPadSizeX

        public long zeroPadSizeX()
        [@property] zeroPadSizeX How much zero padding to apply to both left and right borders of the input image for average pooling, when using @see edgeMode MPSImageEdgeModeClamp. For @see edgeMode MPSImageEdgeModeZero this property is ignored and the area outside the image is interpreted to contain zeros. The zero padding size is used to shrink the pooling window to fit inside the area bound by the source image and its padding region, but the effect is that the normalization factor of the average computation is computed also for the zeros in the padding region.

      • zeroPadSizeY

        public long zeroPadSizeY()
        [@property] zeroPadSizeY How much zero padding to apply to both top and bottom borders of the input image for average pooling, when using @see edgeMode MPSImageEdgeModeClamp. For @see edgeMode MPSImageEdgeModeZero this property is ignored and the area outside the image is interpreted to contain zeros. The zero padding size is used to shrink the pooling window to fit inside the area bound by the source image and its padding region, but the effect is that the normalization factor of the average computation is computed also for the zeros in the padding region.