apple.metalperformanceshaders

Class MPSCNNPoolingAverage

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSKernel

apple.metalperformanceshaders.MPSCNNKernel

apple.metalperformanceshaders.MPSCNNPooling

apple.metalperformanceshaders.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.

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	MPSCNNPoolingAverage(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 MPSCNNPoolingAverage	alloc()
static MPSCNNPoolingAverage	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()
MPSCNNPoolingAverage	init()
MPSCNNPoolingAverage	initWithCoder(NSCoder aDecoder) NS_DESIGNATED_INITIALIZER
MPSCNNPoolingAverage	initWithCoderDevice(NSCoder aDecoder, java.lang.Object device) NSSecureCoding compatability
MPSCNNPoolingAverage	initWithDevice(java.lang.Object device) Standard init with default properties per filter type
MPSCNNPoolingAverage	initWithDeviceKernelWidthKernelHeight(MTLDevice device, long kernelWidth, long kernelHeight) Initialize a pooling filter
MPSCNNPoolingAverage	initWithDeviceKernelWidthKernelHeightStrideInPixelsXStrideInPixelsY(MTLDevice device, long kernelWidth, long kernelHeight, long strideInPixelsX, long strideInPixelsY) Initialize a MPSCNNPoolingAverage pooling filter
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 MPSCNNPoolingAverage	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
static void	setVersion_static(long aVersion)
void	setZeroPadSizeX(long value) [@property] zeroPadSizeX
void	setZeroPadSizeY(long value) [@property] zeroPadSizeY
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
static long	version_static()
long	zeroPadSizeX() [@property] zeroPadSizeX
long	zeroPadSizeY() [@property] zeroPadSizeY

Methods inherited from class apple.metalperformanceshaders.MPSCNNKernel

appendBatchBarrier, clipRect, destinationFeatureChannelOffset, destinationImageAllocator, destinationImageDescriptorForSourceImagesSourceStates, dilationRateX, dilationRateY, edgeMode, encodeToCommandBufferSourceImage, encodeToCommandBufferSourceImageDestinationImage, encodeToCommandBufferSourceImageDestinationStateDestinationImage, encodeToCommandBufferSourceImageDestinationStateDestinationStateIsTemporary, encodingStorageSizeForSourceImageSourceStatesDestinationImage, isBackwards, isResultStateReusedAcrossBatch, isStateModified, kernelHeight, kernelWidth, offset, padding, resultStateForSourceImageSourceStatesDestinationImage, setClipRect, setDestinationFeatureChannelOffset, setDestinationImageAllocator, setEdgeMode, setOffset, setPadding, setSourceFeatureChannelMaxCount, setSourceFeatureChannelOffset, sourceFeatureChannelMaxCount, sourceFeatureChannelOffset, strideInPixelsX, strideInPixelsY, temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage

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

MPSCNNPoolingAverage

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSCNNPoolingAverage alloc()

allocWithZone

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

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

init

public MPSCNNPoolingAverage init()

Overrides:

init in class MPSCNNPooling

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.

initWithCoder

public MPSCNNPoolingAverage initWithCoder(NSCoder aDecoder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class MPSCNNPooling

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.