Merge branch 'utils' of http://gnuradio.org/git/trondeau into master
[debian/gnuradio] / grc / blocks / wxgui_waterfallsink2.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Waterfall Sink
5 ###################################################
6  -->
7 <block>
8         <name>Waterfall Sink</name>
9         <key>wxgui_waterfallsink2</key>
10         <import>from gnuradio.wxgui import waterfallsink2</import>
11         <make>#set $parent = $notebook() and 'self.%s.GetPage(%s)'%$notebook() or 'self'
12 waterfallsink2.$(type.fcn)(
13         $(parent).GetWin(),
14         baseband_freq=$baseband_freq,
15         dynamic_range=$dynamic_range,
16         ref_level=$ref_level,
17         ref_scale=$ref_scale,
18         sample_rate=$samp_rate,
19         fft_size=$fft_size,
20         fft_rate=$fft_rate,
21         average=$options.average,
22         avg_alpha=#if $avg_alpha() then $avg_alpha else 'None'#,
23         title=$title,
24 )
25 #if not $grid_pos()
26 $(parent).Add(self.$(id).win)
27 #else
28 $(parent).GridAdd(self.$(id).win, $(', '.join(map(str, $grid_pos()))))
29 #end if</make>
30         <callback>set_baseband_freq($baseband_freq)</callback>
31         <callback>set_sample_rate($samp_rate)</callback>
32         <param>
33                 <name>Type</name>
34                 <key>type</key>
35                 <value>complex</value>
36                 <type>enum</type>
37                 <option>
38                         <name>Complex</name>
39                         <key>complex</key>
40                         <opt>fcn:waterfall_sink_c</opt>
41                 </option>
42                 <option>
43                         <name>Float</name>
44                         <key>float</key>
45                         <opt>fcn:waterfall_sink_f</opt>
46                 </option>
47         </param>
48         <param>
49                 <name>Title</name>
50                 <key>title</key>
51                 <value>Waterfall Plot</value>
52                 <type>string</type>
53         </param>
54         <param>
55                 <name>Sample Rate</name>
56                 <key>samp_rate</key>
57                 <value>samp_rate</value>
58                 <type>real</type>
59         </param>
60         <param>
61                 <name>Baseband Freq</name>
62                 <key>baseband_freq</key>
63                 <value>0</value>
64                 <type>real</type>
65         </param>
66         <param>
67                 <name>Dynamic Range</name>
68                 <key>dynamic_range</key>
69                 <value>100</value>
70                 <type>real</type>
71         </param>
72         <param>
73                 <name>Reference Level</name>
74                 <key>ref_level</key>
75                 <value>50</value>
76                 <type>real</type>
77         </param>
78         <param>
79                 <name>Ref Scale (p2p)</name>
80                 <key>ref_scale</key>
81                 <value>2.0</value>
82                 <type>real</type>
83         </param>
84         <param>
85                 <name>FFT Size</name>
86                 <key>fft_size</key>
87                 <value>512</value>
88                 <type>int</type>
89         </param>
90         <param>
91                 <name>FFT Rate</name>
92                 <key>fft_rate</key>
93                 <value>15</value>
94                 <type>int</type>
95         </param>
96         <param>
97                 <name>Average Alpha</name>
98                 <key>avg_alpha</key>
99                 <value>0</value>
100                 <type>real</type>
101         </param>
102         <param>
103                 <name>Options</name>
104                 <key>options</key>
105                 <value>none</value>
106                 <type>enum</type>
107                 <option>
108                         <name>None</name>
109                         <key>none</key>
110                         <opt>average:False</opt>
111                 </option>
112                 <option>
113                         <name>Average</name>
114                         <key>average</key>
115                         <opt>average:True</opt>
116                 </option>
117         </param>
118         <param>
119                 <name>Grid Position</name>
120                 <key>grid_pos</key>
121                 <value></value>
122                 <type>grid_pos</type>
123         </param>
124         <param>
125                 <name>Notebook</name>
126                 <key>notebook</key>
127                 <value></value>
128                 <type>notebook</type>
129         </param>
130         <sink>
131                 <name>in</name>
132                 <type>$type</type>
133         </sink>
134         <doc>
135 Set Average Alpha to 0 for automatic setting.
136
137 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
138
139 Use the Notebook Param (notebook-id, page-index) to place the graphical element inside of a notebook page.
140         </doc>
141 </block>