git.gag.com Git - debian/gnuradio/blob - grc/data/platforms/python/blocks/band_pass_filter.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 ###################################################
   4 ##Band Pass Filter: Custom wrapper
   5 ###################################################
   6  -->
   7 <block>
   8         <name>Band Pass Filter</name>
   9         <key>band_pass_filter</key>
  10         <import>from gnuradio import gr</import>
  11         <import>from gnuradio.gr import firdes</import>
  12         <make>gr.$(type)($decim, firdes.band_pass(
  13         $gain, $samp_rate, $low_cutoff_freq, $high_cutoff_freq, $width, firdes.$window, $beta))</make>
  14         <callback>set_taps(firdes.band_pass($gain, $samp_rate, $low_cutoff_freq, $high_cutoff_freq, $width, firdes.$window, $beta))</callback>
  15         <param>
  16                 <name>FIR Type</name>
  17                 <key>type</key>
  18                 <type>enum</type>
  19                 <option>
  20                         <name>Complex->Complex (Decimating)</name>
  21                         <key>fir_filter_ccf</key>
  22                         <opt>input:complex</opt>
  23                         <opt>output:complex</opt>
  24                 </option>
  25                 <option>
  26                         <name>Complex->Complex (Interpolating)</name>
  27                         <key>interp_fir_filter_ccf</key>
  28                         <opt>input:complex</opt>
  29                         <opt>output:complex</opt>
  30                 </option>
  31                 <option>
  32                         <name>Float->Float (Decimating)</name>
  33                         <key>fir_filter_fff</key>
  34                         <opt>input:float</opt>
  35                         <opt>output:float</opt>
  36                 </option>
  37                 <option>
  38                         <name>Float->Float (Interpolating)</name>
  39                         <key>interp_fir_filter_fff</key>
  40                         <opt>input:float</opt>
  41                         <opt>output:float</opt>
  42                 </option>
  43         </param>
  44         <param>
  45                 <name>Decimation</name>
  46                 <key>decim</key>
  47                 <value>1</value>
  48                 <type>int</type>
  49         </param>
  50         <param>
  51                 <name>Gain</name>
  52                 <key>gain</key>
  53                 <value>1</value>
  54                 <type>real</type>
  55         </param>
  56         <param>
  57                 <name>Sample Rate</name>
  58                 <key>samp_rate</key>
  59                 <value>samp_rate</value>
  60                 <type>real</type>
  61         </param>
  62         <param>
  63                 <name>Low Cutoff Freq</name>
  64                 <key>low_cutoff_freq</key>
  65                 <type>real</type>
  66         </param>
  67         <param>
  68                 <name>High Cutoff Freq</name>
  69                 <key>high_cutoff_freq</key>
  70                 <type>real</type>
  71         </param>
  72         <param>
  73                 <name>Transition Width</name>
  74                 <key>width</key>
  75                 <type>real</type>
  76         </param>
  77         <param>
  78                 <name>Window</name>
  79                 <key>window</key>
  80                 <type>enum</type>
  81                 <option>
  82                         <name>Hamming</name>
  83                         <key>WIN_HAMMING</key>
  84                 </option>
  85                 <option>
  86                         <name>Hann</name>
  87                         <key>WIN_HANN</key>
  88                 </option>
  89                 <option>
  90                         <name>Blackman</name>
  91                         <key>WIN_BLACKMAN</key>
  92                 </option>
  93                 <option>
  94                         <name>Rectangular</name>
  95                         <key>WIN_RECTANGULAR</key>
  96                 </option>
  97                 <option>
  98                         <name>Kaiser</name>
  99                         <key>WIN_KAISER</key>
 100                 </option>
 101         </param>
 102         <param>
 103                 <name>Beta</name>
 104                 <key>beta</key>
 105                 <value>6.76</value>
 106                 <type>real</type>
 107         </param>
 108         <sink>
 109                 <name>in</name>
 110                 <type>$type.input</type>
 111         </sink>
 112         <source>
 113                 <name>out</name>
 114                 <type>$type.output</type>
 115         </source>
 116         <doc>
 117 This filter is a convenience wrapper for an fir filter and a firdes taps generating function.
 118
 119 The decimation paramater becomes interpolation when the filter type is set to interpolating.
 120
 121 Sample rate, cutoff frequency, and transition width are in Hertz.
 122
 123 The beta paramater only applies to the Kaiser window.
 124         </doc>
 125 </block>