mpsnnreducefeaturechannelsandweightssum(3) [mojave man page]

MPSNNReduceFeatureChannelsAndWeightsSum(3)		 MetalPerformanceShaders.framework		MPSNNReduceFeatureChannelsAndWeightsSum(3)

NAME

       MPSNNReduceFeatureChannelsAndWeightsSum

SYNOPSIS

       #import <MPSNNReduce.h>

       Inherits MPSNNReduceBinary.

   Instance Methods
       (nonnull instancetype) - initWithDevice:
       (nonnull instancetype) - initWithDevice:doWeightedSumByNonZeroWeights:

   Properties
       bool doWeightedSumByNonZeroWeights

   Additional Inherited Members
Method Documentation
   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device
       Specifies information to apply the reduction operation on an image.

       Parameters:
	   device The device the filter will run on

       Returns:
	   A valid MPSNNReduceFeatureChannelsAndWeightsMean object or nil, if failure.

       Reimplemented from MPSNNReduceBinary.

   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(bool) doWeightedSumByNonZeroWeights
       Specifies information to apply the reduction operation on an image.

       Parameters:
	   device The device the filter will run on
	   doWeightedSumByNonZeroWeights A boolean to indicate whether to compute a weighted sum or weighted sum divided by the number of non-zero
	   weights

       Returns:
	   A valid MPSNNReduceFeatureChannelsAndWeightsSum object or nil, if failure.

Property Documentation
   - (bool) doWeightedSumByNonZeroWeights [read],  [nonatomic],  [assign]
       A boolean to indicate whether the reduction should perform a weighted sum of feature channels with non-zero weights  If false, computes a
       dot product of the feature channels and weights. If true, computes a dot product of the feature channels and weights divided by the number
       of non-zero weights

Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

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

MPSNNReduceBinary(3)					 MetalPerformanceShaders.framework				      MPSNNReduceBinary(3)

NAME

       MPSNNReduceBinary

SYNOPSIS

       #import <MPSNNReduce.h>

       Inherits MPSCNNBinaryKernel.

       Inherited by MPSNNReduceFeatureChannelsAndWeightsMean, and MPSNNReduceFeatureChannelsAndWeightsSum.

   Instance Methods
       (nonnull instancetype) - initWithDevice:

   Properties
       MTLRegion primarySourceClipRect
       MTLRegion secondarySourceClipRect

   Additional Inherited Members
Detailed Description
       The MPSNNReduce performs a reduction operation The reduction operations supported are:

       o Reduce feature channels mean

Method Documentation
   - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device
       Standard init with default properties per filter type

       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.

       Reimplemented from MPSCNNBinaryKernel.

       Reimplemented in MPSNNReduceFeatureChannelsAndWeightsSum, and MPSNNReduceFeatureChannelsAndWeightsMean.

Property Documentation
   - (MTLRegion) primarySourceClipRect [read],	[write],  [nonatomic],	[assign]
       The source rectangle to use when reading data from primary source  A MTLRegion that indicates which part of the primary source to read. If
       the clipRectPrimarySource does not lie completely within the primary source image, the intersection of the image bounds and
       clipRectPrimarySource will be used. The primarySourceClipRect replaces the MPSBinaryImageKernel primaryOffset parameter for this filter.
       The latter is ignored. Default: MPSRectNoClip, use the entire source texture.

       The clipRect specified in MPSBinaryImageKernel is used to control the origin in the destination texture where the min, max values are
       written. The clipRect.width must be >=2. The clipRect.height must be >= 1.

   - (MTLRegion) secondarySourceClipRect [read],  [write],  [nonatomic],  [assign]
       The source rectangle to use when reading data from secondary source  A MTLRegion that indicates which part of the secondary source to read.
       If the clipRectSecondarySource does not lie completely within the secondary source image, the intersection of the image bounds and
       clipRectSecondarySource will be used. The secondarySourceClipRect replaces the MPSBinaryImageKernel secondaryOffset parameter for this
       filter. The latter is ignored. Default: MPSRectNoClip, use the entire source texture.

       The clipRect specified in MPSBinaryImageKernel is used to control the origin in the destination texture where the min, max values are
       written. The clipRect.width must be >=2. The clipRect.height must be >= 1.

Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

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