API Reference for Enthought Tool Suite 2.7.1

Variables

• app_title

  Application title:

  app_title = 'Chaco Plot Window: %s'
  
  

• axis_menu

  PlotAxis menu:

  axis_menu = """
      Edit...: self.edit()
  """
  
  

• BIG

  Numerical constants:

  BIG = 1e+020
  
  

• canvas_menu

  PlotCanvas menu:

  canvas_menu = """
      Add title:                  self.user_handler.add_title(self,1)
      Add overlay:                self.user_handler.add_overlay(self,1)
      Save as
          Single page...:         self.user_handler.create_file(self,0)
          One value per page...:  self.user_handler.create_file(self,2)
      Edit...:                    self.edit()
  """
  
  

• color_re

  color_re = re.compile('[ymcrgbwk]')
  
  

• color_schemes

  Color schemes:

  color_schemes = [ ('blue', 'solid'), ('red', 'solid'), ('black', 'solid'), ('magenta', 'solid'), ('blue', 'dot'), ('red', 'dot'), ('black', 'dot'), ('magenta', 'dot'), ('blue', 'dash'), ('red', 'dash'), ('black', 'dash'), ('magenta', 'dash') ]
  
  

• color_trans

  color_trans = { Const('y') : Const('yellow'), Const('m') : Const('magenta'), Const('c') : Const('cyan'), Const('r') : Const('red'), Const('g') : Const('green'), Const('b') : Const('blue'), Const('w') : Const('white'), Const('k') : Const('black') }
  
  

• DEBUG

  DEBUG = True
  
  

• default_menu

  PlotOverlay, PlotTitle and PlotLabel menu:

  default_menu = """
      Remove:  self.user_handler.remove_object(self)
      Edit...: self.edit()
  """
  
  

• draw

  draw = redraw
  
  

• file_types

  Valid save file types:

  file_types = [ '.pdf', '.png', '.jpg', '.pcx', '.tif' ]
  
  

• image_sizes

  Standard images sizes:

  image_sizes = ((320, 240), (640, 480), (800, 600), (1024, 768), (1280, 1024), (1600, 1200))
  
  

• line_re

  line_re = re.compile('--|-\\.|[-:]')
  
  

• line_trans

  line_trans = { Const('-') : Const('solid'), Const(':') : Const('dot'), Const('-.') : Const('dot dash'), Const('--') : Const('dash') }
  
  

• marker_re

  This one isn't quite right:

  marker_re = re.compile('[ox+s^v]|(?:[^-])[.]')
  
  

• marker_trans

  marker_trans = { Const('.') : Const('dot'), Const('o') : Const('circle'), Const('x') : Const('cross'), Const('+') : Const('plus'), Const('s') : Const('square'), Const('^') : Const('triangle'), Const('v') : Const('down triangle') }
  
  

• NotImplemented

  NotImplemented = 'NotImplemented'
  
  

• object

  Currently selected object:

  object = None
  
  

• plot_frame_menu

  plot_frame_menu = """
      &File
          Save as
              Single page...:         self.create_file(None,0)
              One canvas per page...: self.create_file(None,1)
              One value per page...:  self.create_file(None,2)
          ---
          Close | Ctrl-Q:             self.on_exit()
      &Edit
          Clear:                      self.clear_canvas()
      &Options
          Image size
              320 x 240  : self.set_image_size(0)
              640 x 480  : self.set_image_size(1)
              800 x 600  : self.set_image_size(2)
             1024 x 768  : self.set_image_size(3)
             1280 x 1024 : self.set_image_size(4)
             1600 x 1200 : self.set_image_size(5)
  """
  
  

• ShellPlotFrame_factory

  ShellPlotFrame_factory = ShellPlot
  
  

• simple_types

  simple_types = (str, float, int)
  
  

• SizeMismatch

  Exceptions:

  SizeMismatch = 'SizeMismatch'
  
  

• SMALL

  SMALL = 9.9999999999999995e-021
  
  

• value_menu

  PlotValue menu:

  value_menu = """
      Add axis:             self.user_handler.add_axis(self,1)
      Remove axis:          self.user_handler.remove_axis(self)
      Add title:            self.user_handler.add_title(self,1)
      Add overlay:          self.user_handler.add_overlay(self,1)
      Save as
          Single page...:   self.user_handler.create_file(self,0)
      Remove:               self.user_handler.remove_object(self)
      Edit...:              self.edit()
  """
  
  

• xlabel

  xlabel = xtitle
  
  

• ylabel

  ylabel = ytitle
  
  

Classes

• ShellPlot
• ShellPlotFrame

Function summary

• as_matrix(a)
• as_vector(a)
• autoscale()
• axis(*setting)
• bar(*data, **traits)
• barh(*data, **traits)
• bwd()
• close(which_one = None)
• col(a)
• colorbar(title = '', weight = 0.10000000000000001)
• colormap(palette, min_value = None, max_value = None)
• contour(data, x = None, y = None, numlevels = 10, filled = False, line_color = 'blue', colormap = None, line_weight = 1, alpha = None, origin = 'bottom left')
• contourf(data, x = None, y = None, numlevels = 10, line_color = 'black', colormap = None, alpha = None)
• current()
• errorbar(*data, **traits)
• figure(which_one = None)
• get_plot_group(data)
• grid(state = None)
• hist(*data, **traits)
• hline(*data, **traits)
• hold(state = None)
• hstack(tup)
• image(data, x = None, y = None, colormap = None, scale = False, _contourhelper = False, origin = 'bottom left', discrete_colormap = None, alpha = None, **kwtraits)
• imagesc(img, x = None, y = None, colormap = None, scale = True, _contourhelper = False, origin = 'bottom left', alpha = None, **kwtraits)
• imread(filename)
• is1D(a)
• is2D(a)
• markers(visible = None)
• plot(*data, **kwtraits)
• plot_groups(data)
• process_format(format)
• redraw()
• remove_bad_vals(x)
• row(a)
• save(file_name, format = None)
• scatter(X, Y, C = 'b', marker = 'o', **traits)
• stem(*data)
• subplot(*data, **traits)
• text(*data, **traits)
• title(text)
• values_from_group(group)
• vline(*data, **traits)
• xaxis(*arange)
• xtitle(text)
• yaxis(*arange)
• ytitle(text)

Functions

• as_matrix(a)
• as_vector(a)
• autoscale()
• axis(*setting)

  Correct usage is: axis('fit'|'auto'|x_lo,x_hi,y_lo,y_hi)

• bar(*data, **traits)

  Correct usage is: bar([x,]Y[,width][,'grouped'|'stacked'][,bar_color])

• barh(*data, **traits)

  Correct usage is: barh([x,]Y[,width][,'grouped'|'stacked'][,bar_color])

• bwd()
• close(which_one = None)
• col(a)
• colorbar(title = '', weight = 0.10000000000000001)

  Add a colorbar for the active figure to the current figure.

  title

  a title for the colorbar

  weight

  a relative weight to size the colorbar

• colormap(palette, min_value = None, max_value = None)

  Set the colormap on the active figure.

• contour(data, x = None, y = None, numlevels = 10, filled = False, line_color = 'blue', colormap = None, line_weight = 1, alpha = None, origin = 'bottom left')

  Contour plot -- takes a matrix of heights and number of contour levels, and displays a contour plot of the data, optionally backed with an scaled colormap of the data behind it.

• contourf(data, x = None, y = None, numlevels = 10, line_color = 'black', colormap = None, alpha = None)
• current()
• errorbar(*data, **traits)

  Correct usage is: errorbar([X,]Y,E[,U][,color])

• figure(which_one = None)
• get_plot_group(data)
• grid(state = None)

  Correct usage is: grid([True|False])

• hist(*data, **traits)

  Correct usage is: hist(Y[,x|n][,color])

• hline(*data, **traits)

  Correct usage is: hline(y[,'=label'][,color])

• hold(state = None)

  Correct usage is: hold([True|False])

• hstack(tup)
• image(data, x = None, y = None, colormap = None, scale = False, _contourhelper = False, origin = 'bottom left', discrete_colormap = None, alpha = None, **kwtraits)

  Plot an image. Data is either a 2 dimensional array, in which case we treat it as a colormap plot. You may specifiy a colormap object, otherwise a standard grayscale colormap is used. If the data is a 3 dimensional array, it should be a width x height x 3 array, with the final dimension being Red, Green, and Blue values. These can be floats in the range [0,1], or integers in the range [0,255]. If scale is True on a colormapped plot, image will auto-scale your data to linearly fit in the [0,1] range. You may also specify scale=(min,max), in which case, that range will be taken as the proper range of pixels in the colormap. You may optionally specify x and y, which control the x and y range into which the image will be plotted. By default the image will be plotted into the coordinates of the matrix, i.e. 1 pixel in the matrix = 1 unit on the scale.

• imagesc(img, x = None, y = None, colormap = None, scale = True, _contourhelper = False, origin = 'bottom left', alpha = None, **kwtraits)

  imagesc is just like image with auto-scaling on by default.

• imread(filename)

  Read an image file into an array. Accepts a file name and will automatically handle most formats (as provided for by PIL)

• is1D(a)
• is2D(a)
• markers(visible = None)
• plot(*data, **kwtraits)
• plot_groups(data)
• process_format(format)
• redraw()
• remove_bad_vals(x)
• row(a)
• save(file_name, format = None)
• scatter(X, Y, C = 'b', marker = 'o', **traits)

  Correct usage is: scatter(X,Y[,C][,markertype]

• stem(*data)
• subplot(*data, **traits)

  Correct usage is: subplot(rows,columns,index) or subplot(rci)

• text(*data, **traits)

  Correct usage is: text(x,y,text[,color])

• title(text)

  Correct usage is: title(text)

• values_from_group(group)
• vline(*data, **traits)

  Correct usage is: vline(y[,'=label'][,color])

• xaxis(*arange)

  Correct usage is: xaxis(low|'normal'|'auto'|'tight'|'fit', [high[,tick_interval]])

• xtitle(text)

  Correct usage is: xtitle(text)

• yaxis(*arange)

  Correct usage is: yaxis(low|'normal'|'auto'|'tight'|'fit', [high[,tick_interval]])

• ytitle(text)

  Correct usage is: ytitle(text)

Imported Names

Copyright © 2002-2008 Enthought, Inc.