Module DisplacementPlotter
Defines functions for rendering displacement data as a 3D surface.
This module can be as a __main__ and has the following
usage:
Usage: (imported) [options] <dataFile>
Displays a fitted surface of displacement/velocity data from the
file <dataFile>. This file is expected to contain lines
of the form "px py pz dx dy dz vx vy vz". The pz and vz components
are ignored.
Options:
-h, --help show this help message and exit
-z Z, --z-component=Z
Defines the component of the displacement or velocity
which is used as the surface height,Z={'dx', 'dy',
'dmagnitude', 'vx', 'vy', 'vmagnitude'} (default
Z="dmagnitude").
-s S, --subsample=S Only every S-th data point is read from file, rest are
skipped (default S=1).
-x S, --scale-multiplier=S
Scale heights by this amount. (default S=1.0).
-i P, --image-size=P Size of the image will be PxP pixels. (default
P=1024).
|
|
Data
Objects store position and displacement vectors.
|
|
|
__doc__ = ...
|
|
|
parser = getOptionParser()
|
|
|
fileName = args [0]
|
|
|
__package__ = 'esys.lsm.examples'
|
|
|
attr = 'esys.lsm.vis.core.Color'
|
|
|
attribute = '__module__'
|
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.
|
|
Returns an object for parsing command line arguemnts.
- Returns:
optparse.OptionParser
- a parser initialised with some relevent command line options.
|
__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
"))
|
|