Package esys :: Package lsm :: Package examples :: Module DisplacementPlotter
[hide private]
[frames] | no frames]

Module DisplacementPlotter

Classes [hide private]
  Data
Objects store position and displacement vectors.
Functions [hide private]
 
surfaceRenderDisplacements(fileName, zField, subsample, scaleMultiplier, imageSize)
Renders a surface of displacements data.
optparse.OptionParser
getOptionParser()
Returns an object for parsing command line arguemnts.
Variables [hide private]
  __doc__ = ...
  parser = getOptionParser()
  fileName = args [0]
Function Details [hide private]

surfaceRenderDisplacements(fileName, zField, subsample, scaleMultiplier, imageSize)

 

Renders a surface of displacements data.

Parameters:
  • fileName - name of the data file.
  • zField (string in ["dx", "dy", "dm", "vx", "vy", "vm"].) - Which component of the data is used for the surface heights.
  • subsample (int >= 1) - A subset of data is rendered for subsample > 1.
  • scaleMultiplier (float) - Scale factor for surface heights.

getOptionParser()

 

Returns an object for parsing command line arguemnts.

Returns: optparse.OptionParser
a parser initialised with some relevent command line options.

Variables Details [hide private]

__doc__

Value:
"""
Defines functions for rendering displacement data as a 3D surface.
This module can be as a C{__main__} and has the following usage::
%s
""" %("  "+ string.replace(getOptionParser().format_help(), "\n", "\n \
 "))