Package apple.metalperformanceshaders

Class MPSCNNArithmetic

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    Direct Known Subclasses:
    MPSCNNAdd, MPSCNNDivide, MPSCNNMultiply, MPSCNNSubtract, MPSNNCompare
    public class MPSCNNArithmetic
extends MPSCNNBinaryKernel
    MPSCNNArithmetic [@dependency] This depends on Metal.framework The MPSCNNArithmetic filter takes two source images, a primary source image and a secondary source image, and outputs a single destination image. It applies an element-wise arithmetic operator to each pixel in a primary source image and a corresponding pixel in a secondary source image over a specified region. The supported arithmetic operators are the following: - Addition - Subtraction - Multiplication - Division - Comparison This filter takes additional parameters: primaryScale, secondaryScale, and bias. The default value for primaryScale and secondaryScale is 1.0f. The default value for bias is 0.0f. This filter applies primaryScale, secondaryScale, and bias to the primary source pixel (x) and secondary source pixel (y) in the following way: - Addition: result = ((primaryScale * x) + (secondaryScale * y)) + bias - Subtraction: result = ((primaryScale * x) - (secondaryScale * y)) + bias - Multiplicaton: result = ((primaryScale * x) * (secondaryScale * y)) + bias - Division: result = ((primaryScale * x) / (secondaryScale * y)) + bias - Comparison: Unused. To clamp the result of an arithmetic operation, where result = clamp(result, minimumValue, maximumValue), set the minimumValue and maximumValue appropriately. The default value of minimumValue is -FLT_MAX. The default value of maximumValue is FLT_MAX. This filter also takes the following additional parameters: - primaryStrideInPixelsX, primaryStrideInPixelsY, primaryStrideInFeatureChannels - secondaryStrideInPixelsX, secondaryStrideInPixelsY, secondaryStrideInFeatureChannels These parameters can be used to control broadcasting for the data stored in the primary and secondary source images. For example, setting all strides for the primary source image to 0 will result in the primarySource image being treated as a scalar value. The only supported values are 0 or 1. The default value of these parameters is 1. The number of output feature channels remains the same as the number of input feature channels. You must use one of the sub-classes of MPSImageArithmetic.

    • Constructor Detail

      • MPSCNNArithmetic

        protected MPSCNNArithmetic​(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)

      • bias

        public float bias()

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

      • encodeToCommandBufferPrimaryImageSecondaryImageDestinationStateDestinationImage

        public void encodeToCommandBufferPrimaryImageSecondaryImageDestinationStateDestinationImage​(MTLCommandBuffer commandBuffer,
                                                                                            MPSImage primaryImage,
                                                                                            MPSImage secondaryImage,
                                                                                            MPSCNNArithmeticGradientState destinationState,
                                                                                            MPSImage destinationImage)
        Encode call that operates on a state for later consumption by a gradient kernel in training This is the older style of encode which reads the offset, doesn't change it, and ignores the padding method.
        Parameters:
        commandBuffer - The command buffer
        primaryImage - A MPSImage to use as the source images for the filter.
        secondaryImage - A MPSImage to use as the source images for the filter.
        destinationState - MPSCNNArithmeticGradientState to be consumed by the gradient layer
        destinationImage - A valid MPSImage to be overwritten by result image. destinationImage may not alias primarySourceImage or secondarySourceImage.

      • hash_static

        public static long hash_static()

      • initWithCoderDevice

        public MPSCNNArithmetic initWithCoderDevice​(NSCoder aDecoder,
                                            java.lang.Object device)
        Description copied from class: MPSCNNBinaryKernel
        NSSecureCoding compatability While the standard NSSecureCoding/NSCoding method -initWithCoder: should work, since the file can't know which device your data is allocated on, we have to guess and may guess incorrectly. To avoid that problem, use initWithCoder:device instead.
        Overrides:
        initWithCoderDevice in class MPSCNNBinaryKernel
        Parameters:
        aDecoder - The NSCoder subclass with your serialized MPSKernel
        device - The MTLDevice on which to make the MPSKernel
        Returns:
        A new MPSKernel object, or nil if failure.

      • initWithDevice

        public MPSCNNArithmetic initWithDevice​(java.lang.Object device)
        Description copied from class: MPSCNNBinaryKernel
        Standard init with default properties per filter type
        Overrides:
        initWithDevice in class MPSCNNBinaryKernel
        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.

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

      • maximumValue

        public float maximumValue()
        [@property] maximumValue maximumValue is used to clamp the result of an arithmetic operation: result = clamp(result, minimumValue, maximumValue). The default value of maximumValue is FLT_MAX.

      • minimumValue

        public float minimumValue()
        [@property] minimumValue minimumValue is to clamp the result of an arithmetic operation: result = clamp(result, minimumValue, maximumValue). The default value of minimumValue is -FLT_MAX.

      • new_objc

        public static java.lang.Object new_objc()

      • primaryScale

        public float primaryScale()

      • primaryStrideInFeatureChannels

        public long primaryStrideInFeatureChannels()
        [@property] primaryStrideInPixels The primarySource stride in the feature channel dimension. The only supported values are 0 or 1. The default value for each dimension is 1.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • secondaryScale

        public float secondaryScale()

      • secondaryStrideInFeatureChannels

        public long secondaryStrideInFeatureChannels()
        [@property] secondaryStrideInPixels The secondarySource stride in the feature channel dimension. The only supported values are 0 or 1. The default value for each dimension is 1.

      • setBias

        public void setBias​(float value)

      • setMaximumValue

        public void setMaximumValue​(float value)
        [@property] maximumValue maximumValue is used to clamp the result of an arithmetic operation: result = clamp(result, minimumValue, maximumValue). The default value of maximumValue is FLT_MAX.

      • setMinimumValue

        public void setMinimumValue​(float value)
        [@property] minimumValue minimumValue is to clamp the result of an arithmetic operation: result = clamp(result, minimumValue, maximumValue). The default value of minimumValue is -FLT_MAX.

      • setPrimaryScale

        public void setPrimaryScale​(float value)

      • setPrimaryStrideInFeatureChannels

        public void setPrimaryStrideInFeatureChannels​(long value)
        [@property] primaryStrideInPixels The primarySource stride in the feature channel dimension. The only supported values are 0 or 1. The default value for each dimension is 1.

      • setSecondaryScale

        public void setSecondaryScale​(float value)

      • setSecondaryStrideInFeatureChannels

        public void setSecondaryStrideInFeatureChannels​(long value)
        [@property] secondaryStrideInPixels The secondarySource stride in the feature channel dimension. The only supported values are 0 or 1. The default value for each dimension is 1.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

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

      • version_static

        public static long version_static()