ClassesClassesClassesClasses | | | | Operators

gen_std_bandpassgen_std_bandpassGenStdBandpassgen_std_bandpassGenStdBandpassGenStdBandpass (Operator)


gen_std_bandpassgen_std_bandpassGenStdBandpassgen_std_bandpassGenStdBandpassGenStdBandpass — Generate a bandpass filter with Gaussian or sinusoidal shape.


gen_std_bandpass( : ImageFilter : Frequency, Sigma, Type, Norm, Mode, Width, Height : )

Herror gen_std_bandpass(Hobject* ImageFilter, double Frequency, double Sigma, const char* Type, const char* Norm, const char* Mode, const Hlong Width, const Hlong Height)

Herror T_gen_std_bandpass(Hobject* ImageFilter, const Htuple Frequency, const Htuple Sigma, const Htuple Type, const Htuple Norm, const Htuple Mode, const Htuple Width, const Htuple Height)

Herror gen_std_bandpass(Hobject* ImageFilter, const HTuple& Frequency, const HTuple& Sigma, const HTuple& Type, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height)

HImage HImage::GenStdBandpass(const HTuple& Frequency, const HTuple& Sigma, const HTuple& Type, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height)

void GenStdBandpass(HObject* ImageFilter, const HTuple& Frequency, const HTuple& Sigma, const HTuple& Type, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height)

void HImage::GenStdBandpass(double Frequency, double Sigma, const HString& Type, const HString& Norm, const HString& Mode, Hlong Width, Hlong Height)

void HImage::GenStdBandpass(double Frequency, double Sigma, const char* Type, const char* Norm, const char* Mode, Hlong Width, Hlong Height)

void HOperatorSetX.GenStdBandpass(
[out] IHUntypedObjectX*ImageFilter, [in] VARIANT Frequency, [in] VARIANT Sigma, [in] VARIANT Type, [in] VARIANT Norm, [in] VARIANT Mode, [in] VARIANT Width, [in] VARIANT Height)

void HImageX.GenStdBandpass(
[in] double Frequency, [in] double Sigma, [in] BSTR Type, [in] BSTR Norm, [in] BSTR Mode, [in] Hlong Width, [in] Hlong Height)

static void HOperatorSet.GenStdBandpass(out HObject imageFilter, HTuple frequency, HTuple sigma, HTuple type, HTuple norm, HTuple mode, HTuple width, HTuple height)

void HImage.GenStdBandpass(double frequency, double sigma, string type, string norm, string mode, int width, int height)


gen_std_bandpassgen_std_bandpassGenStdBandpassgen_std_bandpassGenStdBandpassGenStdBandpass generates a rotationally invariant bandpass filter with the response being determined by the parameters FrequencyFrequencyFrequencyFrequencyFrequencyfrequency and SigmaSigmaSigmaSigmaSigmasigma: FrequencyFrequencyFrequencyFrequencyFrequencyfrequency determines the location of the maximum response with respect to the DC term, while SigmaSigmaSigmaSigmaSigmasigma determines the width of the frequency band that passes the filter. FrequencyFrequencyFrequencyFrequencyFrequencyfrequency and SigmaSigmaSigmaSigmaSigmasigma are specified as a fraction of the maximum (horizontal and vertical) frequency that can be represented in an image of size WidthWidthWidthWidthWidthwidth x HeightHeightHeightHeightHeightheight. FrequencyFrequencyFrequencyFrequencyFrequencyfrequency should lie between 0 and 1. For TypeTypeTypeTypeTypetype = 'gauss'"gauss""gauss""gauss""gauss""gauss", a Gaussian response is generated with SigmaSigmaSigmaSigmaSigmasigma being the standard deviation. For TypeTypeTypeTypeTypetype = 'sin'"sin""sin""sin""sin""sin", a sine function is generated with the maximum at FrequencyFrequencyFrequencyFrequencyFrequencyfrequency and the extent SigmaSigmaSigmaSigmaSigmasigma. 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.



ImageFilterImageFilterImageFilterImageFilterImageFilterimageFilter (output_object)  image objectHImageHImageHImageHImageXHobject * (real)

Bandpass filter as image in the frequency domain.

FrequencyFrequencyFrequencyFrequencyFrequencyfrequency (input_control)  real HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Distance of the filter's maximum from the DC term.

Default value: 0.1

Suggested values: 0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0

Restriction: Frequency >= 0

SigmaSigmaSigmaSigmaSigmasigma (input_control)  real HTupleHTupleHTupleVARIANTHtuple (real) (double) (double) (double) (double) (double)

Bandwidth of the filter (standard deviation).

Default value: 0.01

Suggested values: 0.002, 0.005, 0.01, 0.02, 0.05, 0.1, 0.2, 0.3, 0.4, 0.5, 0.7, 1.0

Restriction: Sigma >= 0

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

Filter type.

Default value: 'sin' "sin" "sin" "sin" "sin" "sin"

List of values: 'gauss'"gauss""gauss""gauss""gauss""gauss", 'sin'"sin""sin""sin""sin""sin"

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

Suggested 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

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


gen_std_bandpassgen_std_bandpassGenStdBandpassgen_std_bandpassGenStdBandpassGenStdBandpass 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




See also

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



ClassesClassesClassesClasses | | | | Operators