plot_object

marxs.visualization.mayavi.plot_object(obj, display=None, viewer=None, **kwargs)

Plot any marxs object with using Mayavi as a backend.

This method will inspect the object that is passed in and select the correct plotting method for its shape. The object is added to the mayavi scene specified in the viewer.

Parameters:

objmarxs.base.MarxsElement

The element that should be plotted.

displaydict of None

Dictionary with display settings. If this is None, obj.display is used. If that is also None then the objects is skipped.

viewermayavi.core.scene.Scene

If None, the source is not added to any figure, and will be added automatically by the modules or filters. If False, no figure will be created by modules or filters applied to the source: the source can only be used for testing, or numerical algorithms, not visualization.

kwargs

All other parameters will be passed on to the individual plotting method.

Returns:

outmayavi object

Return the result of a mayavi plotting method.