Merge branch 'sync' of git@gnuradio.org:trondeau into master
[debian/gnuradio] / grc / blocks / wxgui_fftsink2.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##FFT Sink
5 ###################################################
6  -->
7 <block>
8         <name>FFT Sink</name>
9         <key>wxgui_fftsink2</key>
10         <import>from gnuradio.wxgui import fftsink2</import>
11         <make>#set $parent = $notebook() and 'self.%s.GetPage(%s)'%$notebook() or 'self'
12 fftsink2.$(type.fcn)(
13         $(parent).GetWin(),
14         baseband_freq=$baseband_freq,
15         y_per_div=$y_per_div,
16         y_divs=$y_divs,
17         ref_level=$ref_level,
18         ref_scale=$ref_scale,
19         sample_rate=$samp_rate,
20         fft_size=$fft_size,
21         fft_rate=$fft_rate,
22         average=$average,
23         avg_alpha=#if $avg_alpha() then $avg_alpha else 'None'#,
24         title=$title,
25         peak_hold=$peak_hold,
26 )
27 #if not $grid_pos()
28 $(parent).Add(self.$(id).win)
29 #else
30 $(parent).GridAdd(self.$(id).win, $(', '.join(map(str, $grid_pos()))))
31 #end if</make>
32         <callback>set_baseband_freq($baseband_freq)</callback>
33         <callback>set_sample_rate($samp_rate)</callback>
34         <param>
35                 <name>Type</name>
36                 <key>type</key>
37                 <value>complex</value>
38                 <type>enum</type>
39                 <option>
40                         <name>Complex</name>
41                         <key>complex</key>
42                         <opt>fcn:fft_sink_c</opt>
43                 </option>
44                 <option>
45                         <name>Float</name>
46                         <key>float</key>
47                         <opt>fcn:fft_sink_f</opt>
48                 </option>
49         </param>
50         <param>
51                 <name>Title</name>
52                 <key>title</key>
53                 <value>FFT Plot</value>
54                 <type>string</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>Baseband Freq</name>
64                 <key>baseband_freq</key>
65                 <value>0</value>
66                 <type>real</type>
67         </param>
68         <param>
69                 <name>Y per Div</name>
70                 <key>y_per_div</key>
71                 <value>10</value>
72                 <type>enum</type>
73                 <option>
74                         <name>1 dB</name>
75                         <key>1</key>
76                 </option>
77                 <option>
78                         <name>2 dB</name>
79                         <key>2</key>
80                 </option>
81                 <option>
82                         <name>5 dB</name>
83                         <key>5</key>
84                 </option>
85                 <option>
86                         <name>10 dB</name>
87                         <key>10</key>
88                 </option>
89                 <option>
90                         <name>20 dB</name>
91                         <key>20</key>
92                 </option>
93         </param>
94         <param>
95                 <name>Y Divs</name>
96                 <key>y_divs</key>
97                 <value>10</value>
98                 <type>int</type>
99         </param>
100         <param>
101                 <name>Ref Level (dB)</name>
102                 <key>ref_level</key>
103                 <value>50</value>
104                 <type>real</type>
105         </param>
106         <param>
107                 <name>Ref Scale (p2p)</name>
108                 <key>ref_scale</key>
109                 <value>2.0</value>
110                 <type>real</type>
111         </param>
112         <param>
113                 <name>FFT Size</name>
114                 <key>fft_size</key>
115                 <value>1024</value>
116                 <type>int</type>
117         </param>
118         <param>
119                 <name>Refresh Rate</name>
120                 <key>fft_rate</key>
121                 <value>30</value>
122                 <type>int</type>
123         </param>
124         <param>
125                 <name>Peak Hold</name>
126                 <key>peak_hold</key>
127                 <value>False</value>
128                 <type>enum</type>
129                 <hide>#if $peak_hold() == 'True' then 'none' else 'part'#</hide>
130                 <option>
131                         <name>On</name>
132                         <key>True</key>
133                 </option>
134                 <option>
135                         <name>Off</name>
136                         <key>False</key>
137                 </option>
138         </param>
139         <param>
140                 <name>Average</name>
141                 <key>average</key>
142                 <value>False</value>
143                 <type>enum</type>
144                 <hide>#if $average() == 'True' then 'none' else 'part'#</hide>
145                 <option>
146                         <name>On</name>
147                         <key>True</key>
148                 </option>
149                 <option>
150                         <name>Off</name>
151                         <key>False</key>
152                 </option>
153         </param>
154         <param>
155                 <name>Average Alpha</name>
156                 <key>avg_alpha</key>
157                 <value>0</value>
158                 <type>real</type>
159                 <hide>#if $average() == 'True' then 'none' else 'all'#</hide>
160         </param>
161         <param>
162                 <name>Grid Position</name>
163                 <key>grid_pos</key>
164                 <value></value>
165                 <type>grid_pos</type>
166         </param>
167         <param>
168                 <name>Notebook</name>
169                 <key>notebook</key>
170                 <value></value>
171                 <type>notebook</type>
172         </param>
173         <sink>
174                 <name>in</name>
175                 <type>$type</type>
176         </sink>
177         <doc>
178 Set Average Alpha to 0 for automatic setting.
179
180 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
181
182 Use the Notebook Param (notebook-id, page-index) to place the graphical element inside of a notebook page.
183         </doc>
184 </block>