ClassesClassesClassesClasses | | | | Operators

gen_mean_filtergen_mean_filterGenMeanFiltergen_mean_filterGenMeanFilterGenMeanFilter (Operator)

Name

gen_mean_filtergen_mean_filterGenMeanFiltergen_mean_filterGenMeanFilterGenMeanFilter — Generate a mean filter in the frequency domain.

Signature

gen_mean_filter( : ImageMean : MaskShape, Diameter1, Diameter2, Phi, Norm, Mode, Width, Height : )

Herror gen_mean_filter(Hobject* ImageMean, const char* MaskShape, double Diameter1, double Diameter2, double Phi, const char* Norm, const char* Mode, const Hlong Width, const Hlong Height)

Herror T_gen_mean_filter(Hobject* ImageMean, const Htuple MaskShape, const Htuple Diameter1, const Htuple Diameter2, const Htuple Phi, const Htuple Norm, const Htuple Mode, const Htuple Width, const Htuple Height)

Herror gen_mean_filter(Hobject* ImageMean, const HTuple& MaskShape, const HTuple& Diameter1, const HTuple& Diameter2, const HTuple& Phi, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height)

HImage HImage::GenMeanFilter(const HTuple& MaskShape, const HTuple& Diameter1, const HTuple& Diameter2, const HTuple& Phi, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height)

void GenMeanFilter(HObject* ImageMean, const HTuple& MaskShape, const HTuple& Diameter1, const HTuple& Diameter2, const HTuple& Phi, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height)

void HImage::GenMeanFilter(const HString& MaskShape, double Diameter1, double Diameter2, double Phi, const HString& Norm, const HString& Mode, Hlong Width, Hlong Height)

void HImage::GenMeanFilter(const char* MaskShape, double Diameter1, double Diameter2, double Phi, const char* Norm, const char* Mode, Hlong Width, Hlong Height)

void HOperatorSetX.GenMeanFilter(
[out] IHUntypedObjectX*ImageMean, [in] VARIANT MaskShape, [in] VARIANT Diameter1, [in] VARIANT Diameter2, [in] VARIANT Phi, [in] VARIANT Norm, [in] VARIANT Mode, [in] VARIANT Width, [in] VARIANT Height)

void HImageX.GenMeanFilter(
[in] BSTR MaskShape, [in] double Diameter1, [in] double Diameter2, [in] double Phi, [in] BSTR Norm, [in] BSTR Mode, [in] Hlong Width, [in] Hlong Height)

static void HOperatorSet.GenMeanFilter(out HObject imageMean, HTuple maskShape, HTuple diameter1, HTuple diameter2, HTuple phi, HTuple norm, HTuple mode, HTuple width, HTuple height)

void HImage.GenMeanFilter(string maskShape, double diameter1, double diameter2, double phi, string norm, string mode, int width, int height)

Description

gen_mean_filtergen_mean_filterGenMeanFiltergen_mean_filterGenMeanFilterGenMeanFilter generates a mean filter in the frequency domain. The shape of the mean filter is determined by MaskShapeMaskShapeMaskShapeMaskShapeMaskShapemaskShape. For MaskShapeMaskShapeMaskShapeMaskShapeMaskShapemaskShape = 'rectangle'"rectangle""rectangle""rectangle""rectangle""rectangle", a rectangular mean filter is generated. For MaskShapeMaskShapeMaskShapeMaskShapeMaskShapemaskShape = 'ellipse'"ellipse""ellipse""ellipse""ellipse""ellipse", an elliptical mean filter is generated. The diameters (i.e., the amount of smoothing) of the mean filter in the spatial domain are determined by Diameter1Diameter1Diameter1Diameter1Diameter1diameter1 and Diameter2Diameter2Diameter2Diameter2Diameter2diameter2. Diameter1Diameter1Diameter1Diameter1Diameter1diameter1 is the diameter in the principal direction of the filter in the spatial domain determined by the angle PhiPhiPhiPhiPhiphi. To achieve a maximum overall efficiency of the filtering operation, the parameter NormNormNormNormNormnorm can be used to specify the normalization factor of the filter. If fft_genericfft_genericFftGenericfft_genericFftGenericFftGeneric and NormNormNormNormNormnorm = 'n'"n""n""n""n""n" is used the normalization in the FFT can be avoided. ModeModeModeModeModemode can be used to determine where the DC term of the filter lies or whether the filter should be used in the real-valued FFT. If fft_genericfft_genericFftGenericfft_genericFftGenericFftGeneric is used, 'dc_edge'"dc_edge""dc_edge""dc_edge""dc_edge""dc_edge" can be used to gain efficiency. If fft_imagefft_imageFftImagefft_imageFftImageFftImage and fft_image_invfft_image_invFftImageInvfft_image_invFftImageInvFftImageInv are used for filtering, NormNormNormNormNormnorm = 'none'"none""none""none""none""none" and ModeModeModeModeModemode = 'dc_center'"dc_center""dc_center""dc_center""dc_center""dc_center" must be used. If rft_genericrft_genericRftGenericrft_genericRftGenericRftGeneric is used, ModeModeModeModeModemode = 'rft'"rft""rft""rft""rft""rft" must be used.

Parallelization

Parameters

ImageMeanImageMeanImageMeanImageMeanImageMeanimageMean (output_object)  image objectHImageHImageHImageHImageXHobject * (real)

Mean filter as image in the frequency domain.

MaskShapeMaskShapeMaskShapeMaskShapeMaskShapemaskShape (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Shape of the filter mask in the spatial domain.

Default value: 'ellipse' "ellipse" "ellipse" "ellipse" "ellipse" "ellipse"

List of values: 'ellipse'"ellipse""ellipse""ellipse""ellipse""ellipse", 'rectangle'"rectangle""rectangle""rectangle""rectangle""rectangle"

Diameter1Diameter1Diameter1Diameter1Diameter1diameter1 (input_control)  real HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Diameter of the mean filter in the principal direction of the filter in the spatial domain.

Default value: 11.0

Suggested values: 3.0, 5.0, 7.0, 9.0, 11.0, 15.0, 21.0, 31.0, 51.0

Restriction: Diameter1 > 0

Diameter2Diameter2Diameter2Diameter2Diameter2diameter2 (input_control)  real HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Diameter of the mean filter perpendicular to the principal direction of the filter in the spatial domain.

Default value: 11.0

Suggested values: 3.0, 5.0, 7.0, 9.0, 11.0, 15.0, 21.0, 31.0, 51.0

Restriction: Diameter2 > 0

PhiPhiPhiPhiPhiphi (input_control)  angle.rad HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Principal direction of the filter in the spatial domain.

Default value: 0.0

Suggested values: 0.0, 0.523599, 0.785398, 1.047198, 1.570796, 2.094395, 2.356194, 2.617994, 3.141593

NormNormNormNormNormnorm (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Normalizing factor of the filter.

Default value: 'none' "none" "none" "none" "none" "none"

List of values: 'n'"n""n""n""n""n", 'none'"none""none""none""none""none"

ModeModeModeModeModemode (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Location of the DC term in the frequency domain.

Default value: 'dc_center' "dc_center" "dc_center" "dc_center" "dc_center" "dc_center"

List of values: 'dc_center'"dc_center""dc_center""dc_center""dc_center""dc_center", 'dc_edge'"dc_edge""dc_edge""dc_edge""dc_edge""dc_edge", 'rft'"rft""rft""rft""rft""rft"

WidthWidthWidthWidthWidthwidth (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Width of the image (filter).

Default value: 512

List of values: 128, 160, 192, 256, 320, 384, 512, 640, 768, 1024, 2048, 4096, 8192

HeightHeightHeightHeightHeightheight (input_control)  integer HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

Height of the image (filter).

Default value: 512

List of values: 120, 128, 144, 240, 256, 288, 480, 512, 576, 1024, 2048, 4096, 8192

Example (HDevelop)

* Generate a circular mean filter.
gen_mean_filter (FilterMean, 'ellipse', 15, 15, 0, 'n', 'dc_edge', 512, 512)
* Filter an image with the circular mean filter.
fft_generic (Image, ImageFFT, 'to_freq', -1, 'none', 'dc_edge', 'complex')
convol_fft (ImageFFT, FilterMean, Filtered)
fft_generic (Filtered, ImageMean, 'from_freq', 1, 'none', 'dc_edge', 'real')

Result

gen_mean_filtergen_mean_filterGenMeanFiltergen_mean_filterGenMeanFilterGenMeanFilter returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Possible Predecessors

fft_imagefft_imageFftImagefft_imageFftImageFftImage, fft_genericfft_genericFftGenericfft_genericFftGenericFftGeneric, rft_genericrft_genericRftGenericrft_genericRftGenericRftGeneric

Possible Successors

convol_fftconvol_fftConvolFftconvol_fftConvolFftConvolFft

See also

fft_image_invfft_image_invFftImageInvfft_image_invFftImageInvFftImageInv, gen_gauss_filtergen_gauss_filterGenGaussFiltergen_gauss_filterGenGaussFilterGenGaussFilter, gen_derivative_filtergen_derivative_filterGenDerivativeFiltergen_derivative_filterGenDerivativeFilterGenDerivativeFilter, gen_lowpassgen_lowpassGenLowpassgen_lowpassGenLowpassGenLowpass, gen_bandpassgen_bandpassGenBandpassgen_bandpassGenBandpassGenBandpass, gen_bandfiltergen_bandfilterGenBandfiltergen_bandfilterGenBandfilterGenBandfilter, gen_highpassgen_highpassGenHighpassgen_highpassGenHighpassGenHighpass

Module

Foundation


ClassesClassesClassesClasses | | | | Operators