Changeset 9707

Show
Ignore:
Timestamp:
10/03/08 16:30:56
Author:
n4hy
Message:

more cleanup of comments and adding left our functions to swig. Not yet complete

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.h

    r9693 r9707  
    8989            double cutoff_freq,         // Hz beginning transition band 
    9090            double transition_width,    // Hz width of transition band 
    91             double attenuation_dB,   // attenuation dB 
     91            double attenuation_dB,      // out of band attenuation dB 
    9292            win_type window = WIN_HAMMING, 
    9393            double beta = 6.76);                // used only with Kaiser 
     
    107107   * \p beta:                   parameter for Kaiser window 
    108108   */ 
     109 
    109110  static std::vector<float> 
    110111  high_pass (double gain, 
     
    115116             double beta = 6.76);               // used only with Kaiser 
    116117 
     118  /*! 
     119   * \brief use "window method" to design a high-pass FIR filter 
     120   * 
     121   * \p gain:                   overall gain of filter (typically 1.0) 
     122   * \p sampling_freq:          sampling freq (Hz) 
     123   * \p cutoff_freq:            center of transition band (Hz) 
     124   * \p transition_width:       width of transition band (Hz). 
     125   * \p attenuation_dB          out of band attenuation 
     126   *                            The normalized width of the transition 
     127   *                            band is what sets the number of taps 
     128   *                            required.  Narrow --> more taps 
     129   * \p window_type:            What kind of window to use. Determines 
     130   *                            maximum attenuation and passband ripple. 
     131   * \p beta:                   parameter for Kaiser window 
     132   */ 
     133 
    117134  static std::vector<float> 
    118135  high_pass_2 (double gain, 
     
    120137             double cutoff_freq,                // Hz center of transition band 
    121138             double transition_width,           // Hz width of transition band 
    122              double attenuation_dB,   // attenuation dB 
     139             double attenuation_dB,             // out of band attenuation dB 
    123140             win_type window = WIN_HAMMING, 
    124141             double beta = 6.76);               // used only with Kaiser 
     
    148165             double beta = 6.76);               // used only with Kaiser 
    149166 
     167  /*! 
     168   * \brief use "window method" to design a band-pass FIR filter 
     169   * 
     170   * \p gain:                   overall gain of filter (typically 1.0) 
     171   * \p sampling_freq:          sampling freq (Hz) 
     172   * \p low_cutoff_freq:        center of transition band (Hz) 
     173   * \p high_cutoff_freq:       center of transition band (Hz) 
     174   * \p transition_width:       width of transition band (Hz). 
     175   * \p attenuation_dB          out of band attenuation 
     176   *                            The normalized width of the transition 
     177   *                            band is what sets the number of taps 
     178   *                            required.  Narrow --> more taps 
     179   * \p window_type:            What kind of window to use. Determines 
     180   *                            maximum attenuation and passband ripple. 
     181   * \p beta:                   parameter for Kaiser window 
     182   */ 
    150183  static std::vector<float> 
    151184  band_pass_2 (double gain, 
     
    154187             double high_cutoff_freq,           // Hz beginning transition band 
    155188             double transition_width,           // Hz width of transition band 
    156              double attenuation_dB,   // attenuation dB 
     189             double attenuation_dB,             // out of band attenuation dB 
    157190             win_type window = WIN_HAMMING, 
    158191             double beta = 6.76);               // used only with Kaiser 
     
    183216             double beta = 6.76);               // used only with Kaiser 
    184217 
     218  /*! 
     219   * \brief use "window method" to design a complex band-pass FIR filter 
     220   * 
     221   * \p gain:                   overall gain of filter (typically 1.0) 
     222   * \p sampling_freq:          sampling freq (Hz) 
     223   * \p low_cutoff_freq:        center of transition band (Hz) 
     224   * \p high_cutoff_freq:       center of transition band (Hz) 
     225   * \p transition_width:       width of transition band (Hz). 
     226   * \p attenuation_dB          out of band attenuation 
     227   *                            The normalized width of the transition 
     228   *                            band is what sets the number of taps 
     229   *                            required.  Narrow --> more taps 
     230   * \p window_type:            What kind of window to use. Determines 
     231   *                            maximum attenuation and passband ripple. 
     232   * \p beta:                   parameter for Kaiser window 
     233   */ 
     234 
    185235  static std::vector<gr_complex> 
    186236  complex_band_pass_2 (double gain, 
     
    189239             double high_cutoff_freq,           // Hz beginning transition band 
    190240             double transition_width,           // Hz width of transition band 
    191              double attenuation_dB,             // attenuation dB 
    192              win_type window = WIN_HAMMING, 
    193              double beta = 6.76);               // used only with Kaiser 
    194  
     241             double attenuation_dB,             // out of band attenuation dB 
     242             win_type window = WIN_HAMMING, 
     243             double beta = 6.76);               // used only with Kaiser 
    195244 
    196245  /*! 
     
    219268               double beta = 6.76);             // used only with Kaiser 
    220269 
     270  /*! 
     271   * \brief use "window method" to design a band-reject FIR filter 
     272   * 
     273   * \p gain:                   overall gain of filter (typically 1.0) 
     274   * \p sampling_freq:          sampling freq (Hz) 
     275   * \p low_cutoff_freq:        center of transition band (Hz) 
     276   * \p high_cutoff_freq:       center of transition band (Hz) 
     277   * \p transition_width:       width of transition band (Hz). 
     278   * \p attenuation_dB          out of band attenuation 
     279   *                            The normalized width of the transition 
     280   *                            band is what sets the number of taps 
     281   *                            required.  Narrow --> more taps 
     282   * \p window_type:            What kind of window to use. Determines 
     283   *                            maximum attenuation and passband ripple. 
     284   * \p beta:                   parameter for Kaiser window 
     285   */ 
     286 
    221287  static std::vector<float> 
    222288  band_reject_2 (double gain, 
     
    225291               double high_cutoff_freq,         // Hz beginning transition band 
    226292               double transition_width,         // Hz width of transition band 
    227                double attenuation_dB,           // attenuation dB 
     293               double attenuation_dB,           // out of band attenuation dB 
    228294               win_type window = WIN_HAMMING, 
    229295               double beta = 6.76);             // used only with Kaiser 
  • gnuradio/trunk/gnuradio-core/src/lib/general/gr_firdes.i

    r9693 r9707  
    5050   * \p cutoff_freq:            center of transition band (Hz) 
    5151   * \p transition_width:       width of transition band (Hz). 
     52   * \p attenuation_dB          out of band attenuation 
    5253   *                            The normalized width of the transition 
    5354   *                            band is what sets the number of taps