diff options
author | jblum | 2008-09-10 01:23:21 +0000 |
---|---|---|
committer | jblum | 2008-09-10 01:23:21 +0000 |
commit | 924831afcdb187b3de670be6fd1f6147d62be5cf (patch) | |
tree | c041fcf3ac23b033529175ea6558d889dd4bff88 /gr-wxgui/src/python/plotter | |
parent | 237cb72e70ab4b88612bba1189b65a486337991a (diff) | |
download | gnuradio-924831afcdb187b3de670be6fd1f6147d62be5cf.tar.gz gnuradio-924831afcdb187b3de670be6fd1f6147d62be5cf.tar.bz2 gnuradio-924831afcdb187b3de670be6fd1f6147d62be5cf.zip |
Replaced """! with """. Exclamation mark showed in doxygen docs.
git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@9549 221aa14e-8319-0410-a670-987f0aec2ac5
Diffstat (limited to 'gr-wxgui/src/python/plotter')
-rw-r--r-- | gr-wxgui/src/python/plotter/channel_plotter.py | 16 | ||||
-rw-r--r-- | gr-wxgui/src/python/plotter/plotter_base.py | 40 | ||||
-rw-r--r-- | gr-wxgui/src/python/plotter/waterfall_plotter.py | 22 |
3 files changed, 39 insertions, 39 deletions
diff --git a/gr-wxgui/src/python/plotter/channel_plotter.py b/gr-wxgui/src/python/plotter/channel_plotter.py index e7e83e5fa..8fa28410b 100644 --- a/gr-wxgui/src/python/plotter/channel_plotter.py +++ b/gr-wxgui/src/python/plotter/channel_plotter.py @@ -41,7 +41,7 @@ MARKERY_KEY = 'marker' class channel_plotter(grid_plotter_base): def __init__(self, parent): - """! + """ Create a new channel plotter. """ #init @@ -50,14 +50,14 @@ class channel_plotter(grid_plotter_base): self.enable_legend(False) def _gl_init(self): - """! + """ Run gl initialization tasks. """ glEnableClientState(GL_VERTEX_ARRAY) self._grid_compiled_list_id = glGenLists(1) def enable_legend(self, enable=None): - """! + """ Enable/disable the legend. @param enable true to enable @return the enable state when None @@ -69,7 +69,7 @@ class channel_plotter(grid_plotter_base): self.unlock() def draw(self): - """! + """ Draw the grid and waveforms. """ self.lock() @@ -100,7 +100,7 @@ class channel_plotter(grid_plotter_base): self.unlock() def _draw_waveforms(self): - """! + """ Draw the waveforms for each channel. Scale the waveform data to the grid using gl matrix operations. """ @@ -134,7 +134,7 @@ class channel_plotter(grid_plotter_base): glPopMatrix() def _populate_point_label(self, x_val, y_val): - """! + """ Get the text the will populate the point label. Give X and Y values for the current point. Give values for the channel at the X coordinate. @@ -164,7 +164,7 @@ class channel_plotter(grid_plotter_base): return label_str def _draw_legend(self): - """! + """ Draw the legend in the upper right corner. For each channel, draw a rectangle out of the channel color, and overlay the channel text on top of the rectangle. @@ -189,7 +189,7 @@ class channel_plotter(grid_plotter_base): x_off -= w + 4*LEGEND_BOX_PADDING def set_waveform(self, channel, samples, color_spec, marker=None): - """! + """ Set the waveform for a given channel. @param channel the channel key @param samples the waveform samples diff --git a/gr-wxgui/src/python/plotter/plotter_base.py b/gr-wxgui/src/python/plotter/plotter_base.py index bc42eed1e..6d5349a5f 100644 --- a/gr-wxgui/src/python/plotter/plotter_base.py +++ b/gr-wxgui/src/python/plotter/plotter_base.py @@ -42,12 +42,12 @@ POINT_LABEL_PADDING = 3 # OpenGL WX Plotter Canvas ################################################## class _plotter_base(wx.glcanvas.GLCanvas): - """! + """ Plotter base class for all plot types. """ def __init__(self, parent): - """! + """ Create a new plotter base. Initialize the GLCanvas with double buffering. Initialize various plotter flags. @@ -68,14 +68,14 @@ class _plotter_base(wx.glcanvas.GLCanvas): def unlock(self): self._global_lock.release() def _on_size(self, event): - """! + """ Flag the resize event. The paint event will handle the actual resizing. """ self._resized_flag = True def _on_paint(self, event): - """! + """ Respond to paint events, call update. Initialize GL if this is the first paint event. """ @@ -101,7 +101,7 @@ class _plotter_base(wx.glcanvas.GLCanvas): self.draw() def update(self): - """! + """ Force a paint event. Record the timestamp. """ @@ -111,7 +111,7 @@ class _plotter_base(wx.glcanvas.GLCanvas): def clear(self): glClear(GL_COLOR_BUFFER_BIT) def changed(self, state=None): - """! + """ Set the changed flag if state is not None. Otherwise return the changed flag. """ @@ -140,7 +140,7 @@ class grid_plotter_base(_plotter_base): self.Bind(wx.EVT_LEAVE_WINDOW, self._on_leave_window) def _on_motion(self, event): - """! + """ Mouse motion, record the position X, Y. """ self.lock() @@ -150,7 +150,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def _on_leave_window(self, event): - """! + """ Mouse leave window, set the position to None. """ self.lock() @@ -159,7 +159,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def enable_point_label(self, enable=None): - """! + """ Enable/disable the point label. @param enable true to enable @return the enable state when None @@ -171,7 +171,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def set_title(self, title): - """! + """ Set the title. @param title the title string """ @@ -181,7 +181,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def set_x_label(self, x_label, x_units=''): - """! + """ Set the x label and units. @param x_label the x label string @param x_units the x units string @@ -193,7 +193,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def set_y_label(self, y_label, y_units=''): - """! + """ Set the y label and units. @param y_label the y label string @param y_units the y units string @@ -205,7 +205,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def set_x_grid(self, x_min, x_max, x_step, x_scalar=1.0): - """! + """ Set the x grid parameters. @param x_min the left-most value @param x_max the right-most value @@ -221,7 +221,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def set_y_grid(self, y_min, y_max, y_step, y_scalar=1.0): - """! + """ Set the y grid parameters. @param y_min the bottom-most value @param y_max the top-most value @@ -237,7 +237,7 @@ class grid_plotter_base(_plotter_base): self.unlock() def _draw_grid(self): - """! + """ Draw the border, grid, title, and units. """ ################################################## @@ -306,7 +306,7 @@ class grid_plotter_base(_plotter_base): ) def _get_tick_label(self, tick): - """! + """ Format the tick value and create a gl text. @param tick the floating point tick value @return the tick label text @@ -315,7 +315,7 @@ class grid_plotter_base(_plotter_base): return gltext.Text(tick_str, font_size=TICK_TEXT_FONT_SIZE) def _get_ticks(self, min, max, step, scalar): - """! + """ Determine the positions for the ticks. @param min the lower bound @param max the upper bound @@ -337,7 +337,7 @@ class grid_plotter_base(_plotter_base): return [i*step*scalar for i in range(start, stop+1)] def _draw_line(self, coor1, coor2): - """! + """ Draw a line from coor1 to coor2. @param corr1 a tuple of x, y, z @param corr2 a tuple of x, y, z @@ -348,7 +348,7 @@ class grid_plotter_base(_plotter_base): glEnd() def _draw_rect(self, x, y, width, height, fill=True): - """! + """ Draw a rectangle on the x, y plane. X and Y are the top-left corner. @param x the left position of the rectangle @@ -365,7 +365,7 @@ class grid_plotter_base(_plotter_base): glEnd() def _draw_point_label(self): - """! + """ Draw the point label for the last mouse motion coordinate. The mouse coordinate must be an X, Y tuple. The label will be drawn at the X, Y coordinate. diff --git a/gr-wxgui/src/python/plotter/waterfall_plotter.py b/gr-wxgui/src/python/plotter/waterfall_plotter.py index 42c17da86..4dc19f672 100644 --- a/gr-wxgui/src/python/plotter/waterfall_plotter.py +++ b/gr-wxgui/src/python/plotter/waterfall_plotter.py @@ -38,7 +38,7 @@ PADDING = 35, 60, 40, 60 #top, right, bottom, left ceil_log2 = lambda x: 2**int(math.ceil(math.log(x)/math.log(2))) def _get_rbga(red_pts, green_pts, blue_pts, alpha_pts=[(0, 0), (1, 0)]): - """! + """ Get an array of 256 rgba values where each index maps to a color. The scaling for red, green, blue, alpha are specified in piece-wise functions. The piece-wise functions consist of a set of x, y coordinates. @@ -87,7 +87,7 @@ COLORS = { ################################################## class waterfall_plotter(grid_plotter_base): def __init__(self, parent): - """! + """ Create a new channel plotter. """ #init @@ -103,14 +103,14 @@ class waterfall_plotter(grid_plotter_base): self.set_color_mode(COLORS.keys()[0]) def _gl_init(self): - """! + """ Run gl initialization tasks. """ self._grid_compiled_list_id = glGenLists(1) self._waterfall_texture = glGenTextures(1) def draw(self): - """! + """ Draw the grid and waveforms. """ self.lock() @@ -133,7 +133,7 @@ class waterfall_plotter(grid_plotter_base): self.unlock() def _draw_waterfall(self): - """! + """ Draw the waterfall from the texture. The texture is circularly filled and will wrap around. Use matrix modeling to shift and scale the texture onto the coordinate plane. @@ -176,7 +176,7 @@ class waterfall_plotter(grid_plotter_base): glDisable(GL_TEXTURE_2D) def _populate_point_label(self, x_val, y_val): - """! + """ Get the text the will populate the point label. Give the X value for the current point. @param x_val the current x value @@ -186,7 +186,7 @@ class waterfall_plotter(grid_plotter_base): return '%s: %s %s'%(self.x_label, common.label_format(x_val), self.x_units) def _draw_legend(self): - """! + """ Draw the color scale legend. """ if not self._color_mode: return @@ -213,7 +213,7 @@ class waterfall_plotter(grid_plotter_base): txt.draw_text(wx.Point(x, y)) def _resize_texture(self, flag=None): - """! + """ Create the texture to fit the fft_size X num_lines. @param flag the set/unset or update flag """ @@ -230,7 +230,7 @@ class waterfall_plotter(grid_plotter_base): self._resize_texture_flag = False def set_color_mode(self, color_mode): - """! + """ Set the color mode. New samples will be converted to the new color mode. Old samples will not be recolorized. @@ -244,7 +244,7 @@ class waterfall_plotter(grid_plotter_base): self.unlock() def set_num_lines(self, num_lines): - """! + """ Set number of lines. Powers of two only. @param num_lines the new number of lines @@ -256,7 +256,7 @@ class waterfall_plotter(grid_plotter_base): self.unlock() def set_samples(self, samples, minimum, maximum): - """! + """ Set the samples to the waterfall. Convert the samples to color data. @param samples the array of floats |