MPSImageStatisticsMeanAndVariance(3)

NAME
MPSImageStatisticsMeanAndVariance

SYNOPSIS

#import <MPSImageStatistics.h>

Inherits MPSUnaryImageKernel.

  Instance Methods
(nonnull instancetype) - initWithDevice:
(nullable instancetype) - initWithCoder:device:

  Properties
MTLRegion clipRectSource

  Additional Inherited Members

Detailed Description

The MPSImageStatisticsMeanAndVariance computes the mean and variance for a given region of an image. The mean and variance values are written to the destination image at the following pixel locations:

•   mean value is written at pixel location (0, 0)

•   variance value is written at pixel location (1, 0)

Method Documentation

  - (nullable instancetype) initWithCoder: (NSCoder *__nonnull) aDecoder(nonnull id< MTLDevice >) device
NSSecureCoding compatability While the standard NSSecureCoding/NSCoding method -initWithCoder: should work, since the file can't know which device your data is allocated on, we have to guess and may guess incorrectly. To avoid that problem, use initWithCoder:device instead.

Parameters:
    aDecoder The NSCoder subclass with your serialized MPSKernel
    device The MTLDevice on which to make the MPSKernel

Returns:
    A new MPSKernel object, or nil if failure.

Reimplemented from MPSUnaryImageKernel.

  - (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device
Specifies information to apply the statistics mean operation on an image.

Parameters:
    device The device the filter will run on

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

Reimplemented from MPSUnaryImageKernel.

Property Documentation

  - clipRectSource [read], [write], [nonatomic], [assign]
The source rectangle to use when reading data. A MTLRegion that indicates which part of the source to read. If the clipRectSource does not lie completely within the source image, the intersection of the image bounds and clipRectSource will be used. The clipRectSource replaces the MPSUnaryImageKernel offset parameter for this filter. The latter is ignored. Default: MPSRectNoClip, use the entire source texture.

The clipRect specified in MPSUnaryImageKernel is used to control the origin in the destination texture where the mean value is written.

Author

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