.TH "MPSNNReduceBinary" 3 "Mon Jul 9 2018" "Version MetalPerformanceShaders-119.3" "MetalPerformanceShaders.framework" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MPSNNReduceBinary
.SH SYNOPSIS
.br
.PP
.PP
\fC#import <MPSNNReduce\&.h>\fP
.PP
Inherits \fBMPSCNNBinaryKernel\fP\&.
.PP
Inherited by \fBMPSNNReduceFeatureChannelsAndWeightsMean\fP, and \fBMPSNNReduceFeatureChannelsAndWeightsSum\fP\&.
.SS "Instance Methods"

.in +1c
.ti -1c
.RI "(nonnull instancetype) \- \fBinitWithDevice:\fP"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "MTLRegion \fBprimarySourceClipRect\fP"
.br
.ti -1c
.RI "MTLRegion \fBsecondarySourceClipRect\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The MPSNNReduce performs a reduction operation The reduction operations supported are:
.IP "\(bu" 2
Reduce feature channels mean 
.PP

.SH "Method Documentation"
.PP 
.SS "\- (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device"
Standard init with default properties per filter type 
.PP
\fBParameters:\fP
.RS 4
\fIdevice\fP The device that the filter will be used on\&. May not be NULL\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
\fBA\fP 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\&. 
.RE
.PP

.PP
Reimplemented from \fBMPSCNNBinaryKernel\fP\&.
.PP
Reimplemented in \fBMPSNNReduceFeatureChannelsAndWeightsSum\fP, and \fBMPSNNReduceFeatureChannelsAndWeightsMean\fP\&.
.SH "Property Documentation"
.PP 
.SS "\- (MTLRegion) primarySourceClipRect\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The source rectangle to use when reading data from primary source  \fBA\fP 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 \fBMPSBinaryImageKernel\fP primaryOffset parameter for this filter\&. The latter is ignored\&. Default: MPSRectNoClip, use the entire source texture\&.
.PP
The clipRect specified in \fBMPSBinaryImageKernel\fP 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\&. 
.SS "\- (MTLRegion) secondarySourceClipRect\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"
The source rectangle to use when reading data from secondary source  \fBA\fP 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 \fBMPSBinaryImageKernel\fP secondaryOffset parameter for this filter\&. The latter is ignored\&. Default: MPSRectNoClip, use the entire source texture\&.
.PP
The clipRect specified in \fBMPSBinaryImageKernel\fP 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\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for MetalPerformanceShaders\&.framework from the source code\&.