MPSCNNPooling(3)

NAME
MPSCNNPooling -

SYNOPSIS

#import <MPSCNN.h>

Inherits MPSCNNKernel.

Inherited by MPSCNNPoolingAverage, and MPSCNNPoolingMax.

  Instance Methods
(nonnull instancetype) - initWithDevice:kernelWidth:kernelHeight:
(nonnull instancetype) - initWithDevice:kernelWidth:kernelHeight:strideInPixelsX:strideInPixelsY:
(nonnull instancetype) - initWithDevice:

  Properties
NSUInteger kernelWidth
NSUInteger kernelHeight
NSUInteger strideInPixelsX
NSUInteger strideInPixelsY

  Additional Inherited Members

Detailed Description

This depends on Metal.framework Pooling is a form of non-linear sub-sampling. Pooling partitions the input image into a set of rectangles (overlapping or non-overlapping) and, for each such sub-region, outputs a value. The pooling operation is used in computer vision to reduce the dimensionality of intermediate representations.

Method Documentation

  - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) NS_DESIGNATED_INITIALIZER
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 MPSKernel.

  - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(NSUInteger) kernelWidth(NSUInteger) kernelHeight
Initialize a pooling filter

Parameters:
    device The device the filter will run on
    kernelWidth The width of the kernel. Can be an odd or even value.
    kernelHeight The height of the kernel. Can be an odd or even value.

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

  - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device(NSUInteger) kernelWidth(NSUInteger) kernelHeight(NSUInteger) strideInPixelsX(NSUInteger) NS_DESIGNATED_INITIALIZER
Initialize a pooling filter

Parameters:
    device The device the filter will run on
    kernelWidth The width of the kernel. Can be an odd or even value.
    kernelHeight The height of the kernel. Can be an odd or even value.
    strideInPixelsX The output stride (downsampling factor) in the x dimension.
    strideInPixelsY The output stride (downsampling factor) in the y dimension.

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

Property Documentation

  - kernelHeight [read], [nonatomic], [assign]
The height of the filter window

  - kernelWidth [read], [nonatomic], [assign]
The width of the filter window

  - strideInPixelsX [read], [nonatomic], [assign]
The output stride (downsampling factor) in the x dimension. The default value is 1.

  - strideInPixelsY [read], [nonatomic], [assign]
The output stride (downsampling factor) in the y dimension. The default value is 1.

Author

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