esys.pyvisi.streamline.StreamLine

Class StreamLine

Class that shows the direction of particles of a vector field using streamlines.The streamlines can either be colored or grey-scaled, depending on the lookup table used. If the streamlines are colored, there are two possible coloring modes: (1) using vector data or (2) using scalar data.

init(self, scene, data_collector, viewport=0, color_mode=`'vector'`, lut=`'color'`, cell_to_point=False, outline=True)
(Constructor)

Initialise the StreamLine.

Parameters:

scene (Scene object) - Scene in which objects are to be rendered on
data_collector (DataCollector object) - Deal with source of data for visualisation
viewport (Viewport constant) - Viewport in which the object is to be rendered on
color_mode (ColorMode constant) - Type of color mode
lut (Lut constant) - Lookup table color scheme
cell_to_point (Boolean) - Converts cell data to point data (by averaging)
outline (Boolean) - Places an outline around the domain surface

Overrides: tube.Tube.__init__

Attention: The source can either be point or cell data. If the source is cell data, a conversion to point data may or may not be required, in order for the object to be rendered correctly. If a conversion is needed, the 'cell_to_point' flag must be set to 'True', otherwise 'False' (which is the default). On occasions, an inaccurate object may be rendered from cell data even after conversion.

_isModified(self)

Return whether the StreamLine or DataCollector has been modified.

Returns: Boolean: True or False

_render(self, scene)

Render the streamline.

Parameters:

scene (Scene object) - Scene in which objects are to be rendered on

Class StreamLine

__init__(self, scene, data_collector, viewport=0, color_mode='vector', lut='color', cell_to_point=False, outline=True) (Constructor)

_isModified(self)

_render(self, scene)

init(self, scene, data_collector, viewport=0, color_mode=`'vector'`, lut=`'color'`, cell_to_point=False, outline=True)
(Constructor)