Description

Performs a High-pass filter on a FFT image.

Return Type

A McImage object.  

Depending on its input, this method returns either the filtered Amplitude (input is Amplitude or Phase) or the FFT data image itself (input is the FFT data image).

Syntax

object.HighPass (CFx, CFy, [PreserveNil], [vSourceImg])

The HighPass Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McFFT.
CFxRequired. A Double value.

Horizontal cutting frequency.

CFyRequired. A Double value.

Vertical cutting frequency.

PreserveNilOptional. A Boolean value.

Preserves the amplitude of the zero-frequency component.

vSourceImgOptional. A Variant value.

Optional input image, applies to parent if empty.

Remarks

The effect of this filter is to attenuate or filter out (depending on FilterTransition) the frequencies comprised in the region defined by CFx and CFy and FilterShape. This is a centered filter as opposed to SpikeCut and SpikeBoost.

The input (parent image or vSourceImg) can be a mciComplex FFT data image, or a mciPolar image as returned by Forward.

If PreserveNil is true, it preserves the amplitude of the zero-frequency component. This has the effect of preserving the average intensity of the image, which otherwise would be set to 0.