apple.metalperformanceshaders

Class MPSCNNInstanceNormalization

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSKernel

apple.metalperformanceshaders.MPSCNNKernel

apple.metalperformanceshaders.MPSCNNInstanceNormalization

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject

public class MPSCNNInstanceNormalization
extends MPSCNNKernel

MPSCNNInstanceNormalization [@dependency] This depends on Metal.framework

This kernel normalizes each image, on a per-channel basis, to have zero mean and unit variance:

for each image: for each channel: y = (x - mean) * gamma / sqrt(variance + epsilon) + beta;

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	MPSCNNInstanceNormalization(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 MPSCNNInstanceNormalization	alloc()
static MPSCNNInstanceNormalization	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()
MPSCNNInstanceNormalizationDataSource	dataSource() The data source that the object was initialized with
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
float	epsilon() [@property] epsilon
static long	hash_static()
MPSCNNInstanceNormalization	init()
MPSCNNInstanceNormalization	initWithCoder(NSCoder aDecoder) NS_DESIGNATED_INITIALIZER
MPSCNNInstanceNormalization	initWithCoderDevice(NSCoder aDecoder, java.lang.Object device) NSSecureCoding compatability
MPSCNNInstanceNormalization	initWithDevice(java.lang.Object device) Standard init with default properties per filter type
MPSCNNInstanceNormalization	initWithDeviceDataSource(MTLDevice device, MPSCNNInstanceNormalizationDataSource dataSource) Initialize a MPSCNNInstanceNormalization kernel on a device.
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 MPSCNNInstanceNormalization	new_objc()
void	reloadDataSource(MPSCNNInstanceNormalizationDataSource dataSource) Reload data using a data source.
void	reloadGammaAndBetaFromDataSource() Reinitialize the filter using the data source provided at kernel initialization.
void	reloadGammaAndBetaWithCommandBufferGammaAndBetaState(MTLCommandBuffer commandBuffer, MPSCNNNormalizationGammaAndBetaState gammaAndBetaState) Reload data using new gamma and beta terms contained within an MPSCNNInstanceNormalizationGradientState object.
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
MPSCNNInstanceNormalizationGradientState	resultStateForSourceImageSourceStatesDestinationImage(MPSImage sourceImage, NSArray<? extends MPSState> sourceStates, MPSImage destinationImage) Return a MPSCNNInstanceNormalizationGradientState object for the provided source image, source states, and destination image.
void	setEpsilon(float value) [@property] epsilon
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
MPSCNNInstanceNormalizationGradientState	temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage(MTLCommandBuffer commandBuffer, MPSImage sourceImage, NSArray<? extends MPSState> sourceStates, MPSImage destinationImage) Return a temporary MPSCNNInstanceNormalizationGradientState object which may be used with a MPSCNNInstanceNormalization filter.
static long	version_static()

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, setClipRect, setDestinationFeatureChannelOffset, setDestinationImageAllocator, setEdgeMode, setOffset, setPadding, setSourceFeatureChannelMaxCount, setSourceFeatureChannelOffset, sourceFeatureChannelMaxCount, sourceFeatureChannelOffset, strideInPixelsX, strideInPixelsY

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

MPSCNNInstanceNormalization

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSCNNInstanceNormalization alloc()

allocWithZone

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

dataSource

public MPSCNNInstanceNormalizationDataSource dataSource()

The data source that the object was initialized with

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

epsilon

public float epsilon()

[@property] epsilon

The epsilon value used to bias the variance when normalizing.

hash_static

public static long hash_static()

init

public MPSCNNInstanceNormalization init()

Overrides:

init in class MPSCNNKernel

initWithCoder

public MPSCNNInstanceNormalization initWithCoder(NSCoder aDecoder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class MPSCNNKernel

initWithCoderDevice

public MPSCNNInstanceNormalization initWithCoderDevice(NSCoder aDecoder,
                                                       java.lang.Object device)

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 MPSCNNKernel

Parameters:

aDecoder - The NSCoder subclass with your serialized MPSKernel

device - The MTLDevice on which to make the MPSKernel

Returns:

A new MPSCNNInstanceNormalization object, or nil if failure.

initWithDevice

public MPSCNNInstanceNormalization initWithDevice(java.lang.Object device)

Description copied from class: MPSCNNKernel

Standard init with default properties per filter type

Overrides:

initWithDevice in class MPSCNNKernel

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.

initWithDeviceDataSource

public MPSCNNInstanceNormalization initWithDeviceDataSource(MTLDevice device,
                                                            MPSCNNInstanceNormalizationDataSource dataSource)

Initialize a MPSCNNInstanceNormalization kernel on a device.

Parameters:

dataSource - An object conforming to the MPSCNNInstanceNormalizationDataSource protocol which

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 MPSCNNInstanceNormalization new_objc()

reloadDataSource

public void reloadDataSource(MPSCNNInstanceNormalizationDataSource dataSource)

Reload data using a data source.

Parameters:

dataSource - The data source which will provide the gamma and beta terms to scale and bias the normalized result respectively.

reloadGammaAndBetaFromDataSource

public void reloadGammaAndBetaFromDataSource()

Reinitialize the filter using the data source provided at kernel initialization.

reloadGammaAndBetaWithCommandBufferGammaAndBetaState

public void reloadGammaAndBetaWithCommandBufferGammaAndBetaState(MTLCommandBuffer commandBuffer,
                                                                 MPSCNNNormalizationGammaAndBetaState gammaAndBetaState)

Reload data using new gamma and beta terms contained within an MPSCNNInstanceNormalizationGradientState object.

Parameters:

commandBuffer - The command buffer on which to encode the reload.

gammaAndBetaState - The state containing the updated weights which are to be reloaded.

resolveClassMethod

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

resolveInstanceMethod

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

resultStateForSourceImageSourceStatesDestinationImage

public MPSCNNInstanceNormalizationGradientState resultStateForSourceImageSourceStatesDestinationImage(MPSImage sourceImage,
                                                                                                      NSArray<? extends MPSState> sourceStates,
                                                                                                      MPSImage destinationImage)

Return a MPSCNNInstanceNormalizationGradientState object for the provided source image, source states, and destination image.

Overrides:

resultStateForSourceImageSourceStatesDestinationImage in class MPSCNNKernel

Parameters:

sourceImage - The MPSImage consumed by the associated -encode call.

sourceStates - The list of MPSStates consumed by the associated -encode call, for a batch size of 1.

destinationImage - The destination image for the encode call

Returns:

The list of states produced by the -encode call for batch size of 1. When the batch size is not 1, this function will be called repeatedly unless -isResultStateReusedAcrossBatch returns YES. If -isResultStateReusedAcrossBatch returns YES, then it will be called once per batch and the MPSStateBatch array will contain MPSStateBatch.length references to the same object.

setEpsilon

public void setEpsilon(float value)

[@property] epsilon

The epsilon value used to bias the variance when normalizing.

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 MPSCNNKernel

temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage

public MPSCNNInstanceNormalizationGradientState temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage(MTLCommandBuffer commandBuffer,
                                                                                                                            MPSImage sourceImage,
                                                                                                                            NSArray<? extends MPSState> sourceStates,
                                                                                                                            MPSImage destinationImage)

Return a temporary MPSCNNInstanceNormalizationGradientState object which may be used with a MPSCNNInstanceNormalization filter.

Overrides:

temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage in class MPSCNNKernel

Parameters:

commandBuffer - The command buffer to allocate the temporary storage against The state will only be valid on this command buffer.

sourceImage - The MPSImage consumed by the associated -encode call.

sourceStates - The list of MPSStates consumed by the associated -encode call, for a batch size of 1.

destinationImage - The destination image for the encode call

Returns:

The list of states produced by the -encode call for batch size of 1. When the batch size is not 1, this function will be called repeatedly unless -isResultStateReusedAcrossBatch returns YES. If -isResultStateReusedAcrossBatch returns YES, then it will be called once per batch and the MPSStateBatch array will contain MPSStateBatch.length references to the same object.

version_static

public static long version_static()