.TH "MPSCNNYOLOLoss" 3 "Mon Jul 9 2018" "Version MetalPerformanceShaders-119.3" "MetalPerformanceShaders.framework" \" -*- nroff -*- .ad l .nh .SH NAME MPSCNNYOLOLoss .SH SYNOPSIS .br .PP .PP \fC#import \fP .PP Inherits \fBMPSCNNKernel\fP\&. .SS "Instance Methods" .in +1c .ti -1c .RI "(nonnull instancetype) \- \fBinitWithDevice:\fP" .br .ti -1c .RI "(nonnull instancetype) \- \fBinitWithDevice:lossDescriptor:\fP" .br .ti -1c .RI "(nullable instancetype) \- \fBinitWithCoder:device:\fP" .br .ti -1c .RI "(void) \- \fBencodeToCommandBuffer:sourceImage:labels:destinationImage:\fP" .br .ti -1c .RI "(\fBMPSImage\fP *__nonnull) \- \fBencodeToCommandBuffer:sourceImage:labels:\fP" .br .ti -1c .RI "(void) \- \fBencodeBatchToCommandBuffer:sourceImages:labels:destinationImages:\fP" .br .ti -1c .RI "(\fBMPSImageBatch\fP *__nonnull) \- \fBencodeBatchToCommandBuffer:sourceImages:labels:\fP" .br .in -1c .SS "Properties" .in +1c .ti -1c .RI "\fBMPSCNNLoss\fP * \fBlossXY\fP" .br .ti -1c .RI "\fBMPSCNNLoss\fP * \fBlossWH\fP" .br .ti -1c .RI "\fBMPSCNNLoss\fP * \fBlossConfidence\fP" .br .ti -1c .RI "\fBMPSCNNLoss\fP * \fBlossClasses\fP" .br .ti -1c .RI "float \fBscaleXY\fP" .br .ti -1c .RI "float \fBscaleWH\fP" .br .ti -1c .RI "float \fBscaleNoObject\fP" .br .ti -1c .RI "float \fBscaleObject\fP" .br .ti -1c .RI "float \fBscaleClass\fP" .br .ti -1c .RI "float \fBminIOUForObjectPresence\fP" .br .ti -1c .RI "float \fBmaxIOUForObjectAbsence\fP" .br .ti -1c .RI "\fBMPSCNNReductionType\fP \fBreductionType\fP" .br .ti -1c .RI "NSUInteger \fBnumberOfAnchorBoxes\fP" .br .ti -1c .RI "NSData * \fBanchorBoxes\fP" .br .in -1c .SS "Additional Inherited Members" .SH "Method Documentation" .PP .SS "\- (\fBMPSImageBatch\fP*__nonnull) encodeBatchToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(\fBMPSImageBatch\fP *__nonnull) sourceImage(\fBMPSCNNLossLabelsBatch\fP *__nonnull) labels" .SS "\- (void) encodeBatchToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(\fBMPSImageBatch\fP *__nonnull) sourceImage(\fBMPSCNNLossLabelsBatch\fP *__nonnull) labels(\fBMPSImageBatch\fP *__nonnull) destinationImage" .SS "\- (\fBMPSImage\fP*__nonnull) encodeToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(\fBMPSImage\fP *__nonnull) sourceImage(\fBMPSCNNLossLabels\fP *__nonnull) labels" Encode a \fBMPSCNNLoss\fP filter and return a gradient\&. This -encode call is similar to the encodeToCommandBuffer:sourceImage:labels:destinationImage: above, except that it creates and returns the \fBMPSImage\fP with the loss gradient result\&. .PP \fBParameters:\fP .RS 4 \fIcommandBuffer\fP The MTLCommandBuffer on which to encode\&. .br \fIsourceImage\fP The source image from the previous filter in the graph (in the inference direction)\&. .br \fIlabels\fP The object containing the target data (labels) and optionally, weights for the labels\&. .RE .PP \fBReturns:\fP .RS 4 The \fBMPSImage\fP containing the gradient result\&. .RE .PP .SS "\- (void) encodeToCommandBuffer: (nonnull id< MTLCommandBuffer >) commandBuffer(\fBMPSImage\fP *__nonnull) sourceImage(\fBMPSCNNLossLabels\fP *__nonnull) labels(\fBMPSImage\fP *__nonnull) destinationImage" Encode a \fBMPSCNNYOLOLoss\fP filter and return a gradient in the destinationImage\&. This filter consumes the output of a previous layer and the \fBMPSCNNLossLabels\fP object containing the target data (labels) and optionally, weights for the labels\&. The destinationImage contains the computed gradient for the loss layer\&. It serves as a source gradient input image to the first gradient layer (in the backward direction)\&. For information on the data-layout see \fBMPSCNNYOLOLossDescriptor\fP\&. .PP \fBParameters:\fP .RS 4 \fIcommandBuffer\fP The MTLCommandBuffer on which to encode\&. .br \fIsourceImage\fP The source image from the previous filter in the graph (in the inference direction)\&. .br \fIlabels\fP The object containing the target data (labels) and optionally, weights for the labels\&. .br \fIdestinationImage\fP The \fBMPSImage\fP into which to write the gradient result\&. .RE .PP .SS "\- (nullable instancetype) \fBinitWithCoder:\fP (NSCoder *__nonnull) aDecoder(nonnull id< MTLDevice >) device" support .PP Reimplemented from \fBMPSCNNKernel\fP\&. .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 \fBMPSCNNKernel\fP\&. .SS "\- (nonnull instancetype) \fBinitWithDevice:\fP (nonnull id< MTLDevice >) device(\fBMPSCNNYOLOLossDescriptor\fP *_Nonnull) lossDescriptor" Initialize the loss filter with a loss descriptor\&. .PP \fBParameters:\fP .RS 4 \fIdevice\fP The device the filter will run on\&. .br \fIlossDescriptor\fP The loss descriptor\&. .RE .PP \fBReturns:\fP .RS 4 \fBA\fP valid \fBMPSCNNLoss\fP object or nil, if failure\&. .RE .PP .SH "Property Documentation" .PP .SS "\- (NSData*) anchorBoxes\fC [read]\fP, \fC [nonatomic]\fP, \fC [retain]\fP" .SS "\- lossClasses\fC [read]\fP, \fC [nonatomic]\fP, \fC [retain]\fP" loss filter for prediction of bounding box predicted class of the detected object .SS "\- lossConfidence\fC [read]\fP, \fC [nonatomic]\fP, \fC [retain]\fP" loss filter for prediction of bounding box probability of presence of object .SS "\- lossWH\fC [read]\fP, \fC [nonatomic]\fP, \fC [retain]\fP" loss filter for prediction of bounding box size .SS "\- lossXY\fC [read]\fP, \fC [nonatomic]\fP, \fC [retain]\fP" loss filter for prediction of bounding box position .SS "\- (float) maxIOUForObjectAbsence\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (float) minIOUForObjectPresence\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (NSUInteger) numberOfAnchorBoxes\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (\fBMPSCNNReductionType\fP) reductionType\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (float) scaleClass\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (float) scaleNoObject\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (float) scaleObject\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (float) scaleWH\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" .SS "\- (float) scaleXY\fC [read]\fP, \fC [nonatomic]\fP, \fC [assign]\fP" See \fBMPSCNNYOLOLossDescriptor\fP for information about the following properties\&. .SH "Author" .PP Generated automatically by Doxygen for MetalPerformanceShaders\&.framework from the source code\&.