Skip to content

gen_sin_bandpassgen_sin_bandpassGenSinBandpassGenSinBandpassgen_sin_bandpassgen_sin_bandpassπŸ”—

Short descriptionπŸ”—

gen_sin_bandpassgen_sin_bandpassGenSinBandpassGenSinBandpassgen_sin_bandpassgen_sin_bandpass β€” Generate a bandpass filter with sinusoidal shape.

SignatureπŸ”—

gen_sin_bandpass( out image ImageFilter, real Frequency, string Norm, string Mode, integer Width, integer Height )gen_sin_bandpass( : ImageFilter : Frequency, Norm, Mode, Width, Height : )void GenSinBandpass( HObject* ImageFilter, const HTuple& Frequency, const HTuple& Norm, const HTuple& Mode, const HTuple& Width, const HTuple& Height )static void HOperatorSet.GenSinBandpass( out HObject imageFilter, HTuple frequency, HTuple norm, HTuple mode, HTuple width, HTuple height )def gen_sin_bandpass( frequency: float, norm: str, mode: str, width: int, height: int ) -> HObject

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

Herror T_gen_sin_bandpass( Hobject* ImageFilter, const Htuple Frequency, const Htuple Norm, const Htuple Mode, const Htuple Width, const Htuple Height )

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

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

void HImage::GenSinBandpass( double Frequency, const wchar_t* Norm, const wchar_t* Mode, Hlong Width, Hlong Height ) (Windows only)

void HImage.GenSinBandpass( double frequency, string norm, string mode, int width, int height )

DescriptionπŸ”—

gen_sin_bandpassGenSinBandpass generates a rotationally invariant bandpass filter with the response being a sinusoidal function in the frequency domain. The maximum of the sine is determined by Frequencyfrequencyfrequency, which is given as a fraction of the maximum (horizontal and vertical) frequency that can be represented in an image of size Widthwidthwidth x Heightheightheight, i.e., Frequencyfrequencyfrequency should lie between 0 and 1. To achieve a maximum overall efficiency of the filtering operation, the parameter Normnormnorm can be used to specify the normalization factor of the filter. If fft_genericFftGeneric and Normnormnorm \(=\) 'n'"n" is used the normalization in the FFT can be avoided. Modemodemode 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_genericFftGeneric is used, 'dc_edge'"dc_edge" can be used to gain efficiency. If fft_imageFftImage and fft_image_invFftImageInv are used for filtering, Normnormnorm \(=\) 'none'"none" and Modemodemode \(=\) 'dc_center'"dc_center" must be used. If rft_genericRftGeneric is used, Modemodemode \(=\) 'rft'"rft" must be used. The filter is always zero for the DC term, rises with the sine function up to Frequencyfrequencyfrequency, and drops for higher frequencies accordingly. The range of the sine used is from 0 to \(\pi\). All other points are set to zero.

Execution informationπŸ”—

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

ParametersπŸ”—

ImageFilterimageFilterimage_filter (output_object) image β†’ object (real)object (real)HObject (real)HImage (real)HObject (real)Hobject * (real)

Bandpass filter as image in the frequency domain.

Frequencyfrequencyfrequency (input_control) real β†’ (real)(real)HTuple (double)HTuple (double)floatHtuple (double)

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

Default: 0.10.1
Suggested values: 0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.00.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0
Restriction: Frequency >= 0

Normnormnorm (input_control) string β†’ (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Normalizing factor of the filter.

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

Modemodemode (input_control) string β†’ (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Location of the DC term in the frequency domain.

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

Widthwidthwidth (input_control) integer β†’ (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Width of the image (filter).

Default: 512512
Suggested values: 128, 160, 192, 256, 320, 384, 512, 640, 768, 1024, 2048, 4096, 8192128, 160, 192, 256, 320, 384, 512, 640, 768, 1024, 2048, 4096, 8192

Heightheightheight (input_control) integer β†’ (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Height of the image (filter).

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

ResultπŸ”—

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

Combinations with other operatorsπŸ”—

Combinations

Possible predecessors

fft_imageFftImage, fft_genericFftGeneric, rft_genericRftGeneric

Possible successors

convol_fftConvolFft

Alternatives

gen_std_bandpassGenStdBandpass

See also

fft_image_invFftImageInv, gen_gauss_filterGenGaussFilter, gen_mean_filterGenMeanFilter, gen_derivative_filterGenDerivativeFilter, gen_bandpassGenBandpass, gen_bandfilterGenBandfilter, gen_highpassGenHighpass, gen_lowpassGenLowpass

ModuleπŸ”—

Foundation