Merge branch 'vrt' of http://gnuradio.org/git/jblum
[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 #if $win_size()
25         size=$win_size,
26 #end if
27 )
28 #if not $grid_pos()
29 $(parent).Add(self.$(id).win)
30 #else
31 $(parent).GridAdd(self.$(id).win, $(', '.join(map(str, $grid_pos()))))
32 #end if</make>
33         <callback>set_baseband_freq($baseband_freq)</callback>
34         <callback>set_sample_rate($samp_rate)</callback>
35         <param>
36                 <name>Type</name>
37                 <key>type</key>
38                 <value>complex</value>
39                 <type>enum</type>
40                 <option>
41                         <name>Complex</name>
42                         <key>complex</key>
43                         <opt>fcn:waterfall_sink_c</opt>
44                 </option>
45                 <option>
46                         <name>Float</name>
47                         <key>float</key>
48                         <opt>fcn:waterfall_sink_f</opt>
49                 </option>
50         </param>
51         <param>
52                 <name>Title</name>
53                 <key>title</key>
54                 <value>Waterfall Plot</value>
55                 <type>string</type>
56         </param>
57         <param>
58                 <name>Sample Rate</name>
59                 <key>samp_rate</key>
60                 <value>samp_rate</value>
61                 <type>real</type>
62         </param>
63         <param>
64                 <name>Baseband Freq</name>
65                 <key>baseband_freq</key>
66                 <value>0</value>
67                 <type>real</type>
68         </param>
69         <param>
70                 <name>Dynamic Range</name>
71                 <key>dynamic_range</key>
72                 <value>100</value>
73                 <type>real</type>
74         </param>
75         <param>
76                 <name>Reference Level</name>
77                 <key>ref_level</key>
78                 <value>50</value>
79                 <type>real</type>
80         </param>
81         <param>
82                 <name>Ref Scale (p2p)</name>
83                 <key>ref_scale</key>
84                 <value>2.0</value>
85                 <type>real</type>
86         </param>
87         <param>
88                 <name>FFT Size</name>
89                 <key>fft_size</key>
90                 <value>512</value>
91                 <type>int</type>
92         </param>
93         <param>
94                 <name>FFT Rate</name>
95                 <key>fft_rate</key>
96                 <value>15</value>
97                 <type>int</type>
98         </param>
99         <param>
100                 <name>Average Alpha</name>
101                 <key>avg_alpha</key>
102                 <value>0</value>
103                 <type>real</type>
104         </param>
105         <param>
106                 <name>Options</name>
107                 <key>options</key>
108                 <value>none</value>
109                 <type>enum</type>
110                 <option>
111                         <name>None</name>
112                         <key>none</key>
113                         <opt>average:False</opt>
114                 </option>
115                 <option>
116                         <name>Average</name>
117                         <key>average</key>
118                         <opt>average:True</opt>
119                 </option>
120         </param>
121         <param>
122                 <name>Window Size</name>
123                 <key>win_size</key>
124                 <value></value>
125                 <type>int_vector</type>
126                 <hide>#if $win_size() then 'none' else 'part'#</hide>
127         </param>
128         <param>
129                 <name>Grid Position</name>
130                 <key>grid_pos</key>
131                 <value></value>
132                 <type>grid_pos</type>
133         </param>
134         <param>
135                 <name>Notebook</name>
136                 <key>notebook</key>
137                 <value></value>
138                 <type>notebook</type>
139         </param>
140         <check>not $win_size or len($win_size) == 2</check>
141         <sink>
142                 <name>in</name>
143                 <type>$type</type>
144         </sink>
145         <doc>
146 Set Average Alpha to 0 for automatic setting.
147
148 Leave the window blank for the default size, otherwise enter a tuple of (width, height) pixels.
149
150 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
151
152 Use the Notebook Param (notebook-id, page-index) to place the graphical element inside of a notebook page.
153         </doc>
154 </block>