gen_sin_bandpass gen_sin_bandpass GenSinBandpass GenSinBandpass gen_sin_bandpass (Operator)
Name
gen_sin_bandpass gen_sin_bandpass GenSinBandpass GenSinBandpass gen_sin_bandpass
— Generate a bandpass filter with sinusoidal shape.
Signature
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 GenSinBandpass (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)
Description
gen_sin_bandpass gen_sin_bandpass GenSinBandpass GenSinBandpass GenSinBandpass gen_sin_bandpass
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
Frequency Frequency Frequency Frequency frequency frequency
, which is given as a fraction of the maximum
(horizontal and vertical) frequency that can be represented in an
image of size Width Width Width Width width width
x Height Height Height Height height height
, i.e.,
Frequency Frequency Frequency Frequency frequency frequency
should lie between 0 and 1. To achieve a maximum
overall efficiency of the filtering operation, the parameter
Norm Norm Norm Norm norm norm
can be used to specify the normalization factor of the
filter. If fft_generic fft_generic FftGeneric FftGeneric FftGeneric fft_generic
and Norm Norm Norm Norm norm norm
= 'n' "n" "n" "n" "n" "n"
is used the normalization in the FFT can be avoided. Mode Mode Mode Mode mode mode
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_generic fft_generic FftGeneric FftGeneric FftGeneric fft_generic
is used, 'dc_edge' "dc_edge" "dc_edge" "dc_edge" "dc_edge" "dc_edge" can be used to gain
efficiency. If fft_image fft_image FftImage FftImage FftImage fft_image
and fft_image_inv fft_image_inv FftImageInv FftImageInv FftImageInv fft_image_inv
are used
for filtering, Norm Norm Norm Norm norm norm
= 'none' "none" "none" "none" "none" "none" and Mode Mode Mode Mode mode mode
= 'dc_center' "dc_center" "dc_center" "dc_center" "dc_center" "dc_center" must be used. If rft_generic rft_generic RftGeneric RftGeneric RftGeneric rft_generic
is
used, Mode Mode Mode Mode mode mode
= 'rft' "rft" "rft" "rft" "rft" "rft" must be used. The filter is
always zero for the DC term, rises with the sine function up to
Frequency Frequency Frequency Frequency frequency frequency
, and drops for higher frequencies accordingly.
The range of the sine used is from 0 to
. All other
points are set to zero.
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
ImageFilter ImageFilter ImageFilter ImageFilter imageFilter image_filter
(output_object) image →
object HImage HObject HImage Hobject * (real)
Bandpass filter as image in the frequency domain.
Frequency Frequency Frequency Frequency frequency frequency
(input_control) real →
HTuple float HTuple Htuple (real) (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
Norm Norm Norm Norm norm norm
(input_control) string →
HTuple str HTuple Htuple (string) (string ) (HString ) (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"
Mode Mode Mode Mode mode mode
(input_control) string →
HTuple str HTuple Htuple (string) (string ) (HString ) (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"
Width Width Width Width width width
(input_control) integer →
HTuple int HTuple Htuple (integer) (int / long) (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
Height Height Height Height height height
(input_control) integer →
HTuple int HTuple Htuple (integer) (int / long) (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
Result
gen_sin_bandpass gen_sin_bandpass GenSinBandpass GenSinBandpass GenSinBandpass gen_sin_bandpass
returns TRUE if all parameters are correct.
If necessary, an exception is raised.
Possible Predecessors
fft_image fft_image FftImage FftImage FftImage fft_image
,
fft_generic fft_generic FftGeneric FftGeneric FftGeneric fft_generic
,
rft_generic rft_generic RftGeneric RftGeneric RftGeneric rft_generic
Possible Successors
convol_fft convol_fft ConvolFft ConvolFft ConvolFft convol_fft
Alternatives
gen_std_bandpass gen_std_bandpass GenStdBandpass GenStdBandpass GenStdBandpass gen_std_bandpass
See also
fft_image_inv fft_image_inv FftImageInv FftImageInv FftImageInv fft_image_inv
,
gen_gauss_filter gen_gauss_filter GenGaussFilter GenGaussFilter GenGaussFilter gen_gauss_filter
,
gen_mean_filter gen_mean_filter GenMeanFilter GenMeanFilter GenMeanFilter gen_mean_filter
,
gen_derivative_filter gen_derivative_filter GenDerivativeFilter GenDerivativeFilter GenDerivativeFilter gen_derivative_filter
,
gen_bandpass gen_bandpass GenBandpass GenBandpass GenBandpass gen_bandpass
,
gen_bandfilter gen_bandfilter GenBandfilter GenBandfilter GenBandfilter gen_bandfilter
,
gen_highpass gen_highpass GenHighpass GenHighpass GenHighpass gen_highpass
,
gen_lowpass gen_lowpass GenLowpass GenLowpass GenLowpass gen_lowpass
Module
Foundation