MPSImageMedian(3)

NAME
MPSImageMedian -

SYNOPSIS

#import <MPSImageMedian.h>

Inherits MPSUnaryImageKernel.

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

  Class Methods
(NSUInteger) + maxKernelDiameter
(NSUInteger) + minKernelDiameter

  Properties
NSUInteger kernelDiameter

  Additional Inherited Members

Detailed Description

MPSImageMedian.h MetalPerformanceShaders.framework

Copyright:
    Copyright (c) 2015 Apple Inc. All rights reserved. MetalPerformanceShaders median filters

The MPSImageMedian applies a median filter to an image. A median filter finds the median color value for each channel within a kernelDiameter x kernelDiameter window surrounding the pixel of interest. It is a common means of noise reduction and also as a smoothing filter with edge preserving qualities.

NOTE: The MPSImageMedian filter currently only supports images with <= 8 bits/channel.

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) NS_DESIGNATED_INITIALIZER
Initialize a filter for a particular kernel size and device

Parameters:
    device The device the filter will run on
    kernelDiameter Diameter of the median filter. Must be an odd number.

Returns:
    A valid object or nil, if failure.

  + (NSUInteger) maxKernelDiameter
The maximum diameter in pixels of the filter window supported by the median filter.

  + (NSUInteger) minKernelDiameter
The minimum diameter in pixels of the filter window supported by the median filter.

Property Documentation

  - kernelDiameter [read], [nonatomic], [assign]
The diameter in pixels of the filter window. The median filter is applied to a kernelDiameter x kernelDiameter window of pixels centered on the corresponding source pixel for each destination pixel. The kernel diameter must be an odd number.

Author

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