Package apple.metalperformanceshaders

Class MPSImageGaussianPyramid

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class MPSImageGaussianPyramid
extends MPSImagePyramid
    MPSImageGaussianPyramid A Gaussian image pyramid is constructed as follows: The mipmap level zero is the source of the operation and is left untouched and the subsequent mipmap levels are constructed from it recursively: [@code] mip[ level = n + 1 ] = Downsample( filter( mip[ level = n ] ) ), where [@endcode] "filter()" applies a filter with the specified convolution kernel and "Downsample()" removes odd rows and columns from the input image. The default convolution filter kernel for this operation is [@code] k = w w^T, where w = [ 1/16, 1/4, 3/8, 1/4, 1/16 ]^T, [@endcode] but the user may also tweak this kernel with a @ref centerWeight parameter: 'a': [@code] k = w w^T, where w = [ (1/4 - a/2), 1/4, a, 1/4, (1/4 - a/2) ]^T [@endcode] or the user can provide a completely custom kernel. This procedure is continued until every mipmap level present in the image texture are filled with the pyramid levels. In case of the Gaussian pyramid the user must run the operation in-place using: [@ref] MPSUnaryImageKernel::encodeToCommandBuffer:inPlaceTexture:fallbackCopyAllocator:, where the fallback allocator is ignored.

    • Constructor Detail

      • MPSImageGaussianPyramid

        protected MPSImageGaussianPyramid​(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 MPSImageGaussianPyramid initWithDevice​(java.lang.Object device)
        Description copied from class: MPSImagePyramid
        Initialize a downwards 5-tap image pyramid with the default filter kernel and device The filter kernel is the outer product of w = [ 1/16, 1/4, 3/8, 1/4, 1/16 ]^T, with itself
        Overrides:
        initWithDevice in class MPSImagePyramid
        Parameters:
        device - The device the filter will run on
        Returns:
        A valid object or nil, if failure.

      • initWithDeviceCenterWeight

        public MPSImageGaussianPyramid initWithDeviceCenterWeight​(MTLDevice device,
                                                          float centerWeight)
        Description copied from class: MPSImagePyramid
        Initialize a downwards 5-tap image pyramid with a central weight parameter and device
        Overrides:
        initWithDeviceCenterWeight in class MPSImagePyramid
        Parameters:
        device - The device the filter will run on
        centerWeight - Defines form of the filter-kernel through the outer product ww^T, where w = [ (1/4 - a/2), 1/4, a, 1/4, (1/4 - a/2) ]^T and 'a' is centerWeight.
        Returns:
        A valid object or nil, if failure.

      • initWithDeviceKernelWidthKernelHeightWeights

        public MPSImageGaussianPyramid initWithDeviceKernelWidthKernelHeightWeights​(MTLDevice device,
                                                                            long kernelWidth,
                                                                            long kernelHeight,
                                                                            org.moe.natj.general.ptr.ConstFloatPtr kernelWeights)
        Description copied from class: MPSImagePyramid
        Initialize a downwards n-tap pyramid with a custom filter kernel and device
        Overrides:
        initWithDeviceKernelWidthKernelHeightWeights in class MPSImagePyramid
        Parameters:
        device - The device the filter will run on
        kernelWidth - The width of the filtering kernel. See @ref MPSImageConvolution.
        kernelHeight - The height of the filtering kernel. See @ref MPSImageConvolution.
        kernelWeights - A pointer to an array of kernelWidth * kernelHeight values to be used as the kernel. These are in row major order. See @ref MPSImageConvolution.
        Returns:
        A valid object or nil, if failure.

      • initWithCoderDevice

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

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