mojave man page for mpsnnarithmeticgradientnode

MPSNNArithmeticGradientNode(3)				 MetalPerformanceShaders.framework			    MPSNNArithmeticGradientNode(3)

NAME
       MPSNNArithmeticGradientNode

SYNOPSIS
       #import <MPSNNGraphNodes.h>

       Inherits MPSNNGradientFilterNode.

       Inherited by MPSNNAdditionGradientNode, MPSNNMultiplicationGradientNode, and MPSNNSubtractionGradientNode.

   Instance Methods
       (nonnull instancetype) - initWithSourceGradient:sourceImage:gradientState:
       (nonnull instancetype) - initWithGradientImages:forwardFilter:isSecondarySourceFilter:

   Class Methods
       (nonnull instancetype) + nodeWithSourceGradient:sourceImage:gradientState:

   Properties
       float primaryScale
       float secondaryScale
       float bias
       NSUInteger secondaryStrideInPixelsX
       NSUInteger secondaryStrideInPixelsY
       NSUInteger secondaryStrideInFeatureChannels
       float minimumValue
       float maximumValue
       bool isSecondarySourceFilter

Method Documentation
   - (nonnull instancetype) initWithGradientImages: (NSArray< MPSNNImageNode * > *__nonnull) gradientImages(MPSNNFilterNode *__nonnull)
       filter(bool) isSecondarySourceFilter
       create a new arithmetic gradient node  See also -[MPSCNNNeuronNode gradientFilterNodesWithSources:] for an easier way to do this.

       Parameters:
	   gradientImages The input gradient from the 'downstream' gradient filter and the source input image from the forward pass (primary or
	   secondary).
	   filter The matching filter node from the forward pass.
	   isSecondarySourceFilter The isSecondarySourceFilter property is used to indicate whether the arithmetic gradient filter is operating on
	   the primary or secondary source image from the forward pass.

   - (nonnull instancetype) initWithSourceGradient: (MPSNNImageNode *__nonnull) sourceGradient(MPSNNImageNode *__nonnull)
       sourceImage(MPSNNBinaryGradientStateNode *__nonnull) gradientState
       create a new arithmetic gradient node  See also -[MPSCNNNeuronNode gradientFilterNodesWithSources:] for an easier way to do this.

       Parameters:
	   sourceGradient The input gradient from the 'downstream' gradient filter.
	   sourceImage The source input image from the forward pass (primary or secondary).
	   gradientState The gradient state produced by the concatenation filter, consumed by this filter.

   + (nonnull instancetype) nodeWithSourceGradient: (MPSNNImageNode *__nonnull) sourceGradient(MPSNNImageNode *__nonnull)
       sourceImage(MPSNNBinaryGradientStateNode *__nonnull) gradientState
       create a new arithmetic gradient node  See also -[MPSCNNNeuronNode gradientFilterNodesWithSources:] for an easier way to do this.

       Parameters:
	   sourceGradient The input gradient from the 'downstream' gradient filter.
	   sourceImage The source input image from the forward pass (primary or secondary).
	   gradientState The gradient state produced by the concatenation filter, consumed by this filter.

Property Documentation
   - (float) bias [read],  [write],  [nonatomic],  [assign]
   - (bool) isSecondarySourceFilter [read],  [write],  [nonatomic],  [assign]
   - (float) maximumValue [read],  [write],  [nonatomic],  [assign]
   - (float) minimumValue [read],  [write],  [nonatomic],  [assign]
   - (float) primaryScale [read],  [write],  [nonatomic],  [assign]
   - (float) secondaryScale [read],  [write],  [nonatomic],  [assign]
   - (NSUInteger) secondaryStrideInFeatureChannels [read],  [write],  [nonatomic],  [assign]
   - (NSUInteger) secondaryStrideInPixelsX [read],  [write],  [nonatomic],  [assign]
   - (NSUInteger) secondaryStrideInPixelsY [read],  [write],  [nonatomic],  [assign]
Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

Version MetalPerformanceShaders-100				  Thu Feb 8 2018				    MPSNNArithmeticGradientNode(3)