MPSCNNPoolingNode(3)

NAME
MPSCNNPoolingNode

SYNOPSIS

#import <MPSNNGraphNodes.h>

Inherits MPSNNFilterNode.

Inherited by MPSCNNPoolingAverageNode, MPSCNNPoolingL2NormNode, and MPSCNNPoolingMaxNode.

  Instance Methods
(nonnull instancetype) - initWithSource:kernelWidth:kernelHeight:strideInPixelsX:strideInPixelsY:
(nonnull instancetype) - initWithSource:filterSize:stride:
(nonnull instancetype) - initWithSource:filterSize:

  Class Methods
(nonnull instancetype) + nodeWithSource:filterSize:
(nonnull instancetype) + nodeWithSource:filterSize:stride:

  Properties
NSUInteger kernelWidth
NSUInteger NSUInteger kernelHeight
NSUInteger NSUInteger NSUInteger strideInPixelsX
NSUInteger NSUInteger NSUInteger NSUInteger strideInPixelsY

Detailed Description

A node for a MPSCNNPooling kernel This is an abstract base class that does not correspond with any particular MPSCNNKernel. Please make one of the MPSCNNPooling subclasses instead.

Method Documentation

  - (nonnull instancetype) initWithSource: (MPSNNImageNode *__nonnull) sourceNode(NSUInteger) size
Convenience initializer for MPSCNNPooling nodes with square non-overlapping kernels

Parameters:
    sourceNode The MPSNNImageNode representing the source MPSImage for the filter
    size kernelWidth = kernelHeight = strideInPixelsX = strideInPixelsY = size

Returns:
    A new MPSNNFilter node for a MPSCNNPooling kernel.

  - (nonnull instancetype) initWithSource: (MPSNNImageNode *__nonnull) sourceNode(NSUInteger) size(NSUInteger) stride
Convenience initializer for MPSCNNPooling nodes with square kernels

Parameters:
    sourceNode The MPSNNImageNode representing the source MPSImage for the filter
    size kernelWidth = kernelHeight = size
    stride strideInPixelsX = strideInPixelsY = stride

Returns:
    A new MPSNNFilter node for a MPSCNNPooling kernel.

  - (nonnull instancetype) initWithSource: (MPSNNImageNode *__nonnull) sourceNode(NSUInteger) kernelWidth(NSUInteger) kernelHeight(NSUInteger) strideInPixelsX(NSUInteger) strideInPixelsY
Init a node representing a MPSCNNPooling kernel

Parameters:
    sourceNode The MPSNNImageNode representing the source MPSImage for the filter
    kernelWidth The width of the max filter window
    kernelHeight The height of the max filter window
    strideInPixelsX The output stride (downsampling factor) in the x dimension.
    strideInPixelsY The output stride (downsampling factor) in the y dimension.

Returns:
    A new MPSNNFilter node for a MPSCNNPooling kernel.

  + (nonnull instancetype) nodeWithSource: (MPSNNImageNode *__nonnull) sourceNode(NSUInteger) size
Convenience initializer for MPSCNNPooling nodes with square non-overlapping kernels

Parameters:
    sourceNode The MPSNNImageNode representing the source MPSImage for the filter
    size kernelWidth = kernelHeight = strideInPixelsX = strideInPixelsY = size

Returns:
    A new MPSNNFilter node for a MPSCNNPooling kernel.

  + (nonnull instancetype) nodeWithSource: (MPSNNImageNode *__nonnull) sourceNode(NSUInteger) size(NSUInteger) stride
Convenience initializer for MPSCNNPooling nodes with square non-overlapping kernels and a different stride

Parameters:
    sourceNode The MPSNNImageNode representing the source MPSImage for the filter
    size kernelWidth = kernelHeight = size
    stride strideInPixelsX = strideInPixelsY = stride

Returns:
    A new MPSNNFilter node for a MPSCNNPooling kernel.

Property Documentation

  - (NSUInteger NSUInteger) kernelHeight [read], [nonatomic], [assign]

  - (NSUInteger) kernelWidth [read], [nonatomic], [assign]

  - (NSUInteger NSUInteger NSUInteger) strideInPixelsX [read], [nonatomic], [assign]

  - (NSUInteger NSUInteger NSUInteger NSUInteger) strideInPixelsY [read], [nonatomic], [assign]

Author

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