Home       Trees       Index       Help   
Package atmopy :: Package display :: Module basemap_ext
[show private | hide private]
[frames | no frames]

Module atmopy.display.basemap_ext

Function Summary
  cbar()
Displays a colorbar.
  disp(map, data, **kwargs)
Displays a 2D array on a given map.
  dispcf(map, data, V, **kwargs)
Displays a 2D array on a given map with filled contours.
numpy.array getd(config, filename, Nt, Nz, Ny, Nx)
Reads data from a binary file.
Basemap getm(config, y_min, x_min, Delta_y, Delta_x, Ny, Nx, cbar, open_figure, resolution, area_thresh)
Generates a map with Basemap.
(Basemap, numpy.array) getmd(config, cbar)
Reads data from a binary file and generates the corresponding map.

Function Details

cbar()

Displays a colorbar.

disp(map, data, **kwargs)

Displays a 2D array on a given map.
Parameters:
map - The map on which data is displayed.
           (type=Basemap)
data - Data (2D) to be displayed.
           (type=2D numpy.array)

dispcf(map, data, V=None, **kwargs)

Displays a 2D array on a given map with filled contours.
Parameters:
map - The map on which data is displayed.
           (type=Basemap)
data - Data (2D) to be displayed.
           (type=2D numpy.array)
V - The number of levels or the list of thresholds for the contours.
           (type=integer, list or 1D numpy.array)

getd(config=None, filename='', Nt=None, Nz=None, Ny=None, Nx=None)

Reads data from a binary file.
Parameters:
config - The configuration or the configuration file.
           (type=Config or string)
filename - The file to be loaded. If filename is empty, then the file from 'config' is loaded.
           (type=string)
Nt - The number of time steps in the file to be loaded. If it is not given, it is read in 'config'.
           (type=integer.)
Nz - The number of levels in the file to be loaded. If it is not given, it is read in 'config'.
           (type=integer.)
Ny - The number of space steps along y in the file to be loaded. If it is not given, it is read in 'config'.
           (type=integer.)
Nx - The number of space steps along xin the file to be loaded. If it is not given, it is read in 'config'.
           (type=integer.)
Returns:
The data.
           (type=numpy.array)

getm(config=None, y_min=None, x_min=None, Delta_y=None, Delta_x=None, Ny=None, Nx=None, cbar=True, open_figure=True, resolution='l', area_thresh=1000)

Generates a map with Basemap.
Parameters:
config - The configuration or the configuration file.
           (type=Config or string)
cbar - True if there is a colormap, false otherwise.
           (type=Boolean)
open_figure - Should a figure be opened?
           (type=Boolean)
Returns:
The map.
           (type=Basemap)

getmd(config, cbar=True)

Reads data from a binary file and generates the corresponding map.
Parameters:
config - The configuration or the configuration file.
           (type=Config or string)
cbar - True is there is a colormap, false otherwise.
           (type=Boolean)
Returns:
The map and the data.
           (type=(Basemap, numpy.array))

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Tue May 19 10:37:13 2009 http://epydoc.sf.net