Subclassing mayavi application example — mayavi 4.7.2 documentation

# Subclassing mayavi application example

This script demonstrates how one can script the Mayavi application by subclassing the application, create a new scene and create a few simple modules.

This should be run as:

    $ python test.py

Python source code: `subclassing_mayavi_application.py`

    # Author: Prabhu Ramachandran <prabhu_r@users.sf.net>
    # Copyright (c) 2005-2020, Enthought, Inc.
    # License: BSD Style.

    # Standard library imports
    from os.path import join, abspath, dirname

    # Enthought library imports
    from mayavi.plugins.app import Mayavi
    from mayavi.scripts.util import get_data_dir

    class MyApp(Mayavi):
        def run(self):
            """This is executed once the application GUI has started.
            *Make sure all other MayaVi specific imports are made here!*
            """
            # Various imports to do different things.
            from mayavi.sources.vtk_file_reader import VTKFileReader
            from mayavi.modules.outline import Outline
            from mayavi.modules.axes import Axes
            from mayavi.modules.grid_plane import GridPlane
            from mayavi.modules.image_plane_widget import ImagePlaneWidget
            from mayavi.modules.text import Text

            script = self.script
            # Create a new scene.
            script.new_scene()

            # Read a VTK (old style) data file.
            r = VTKFileReader()
            r.initialize(join(get_data_dir(dirname(abspath(__file__))), 'heart.vtk'))
            script.add_source(r)

            # Put up some text.
            t = Text(text='MayaVi rules!', x_position=0.2,
                     y_position=0.9, width=0.8)
            t.property.color = 1, 1, 0  # Bright yellow, yeah!
            script.add_module(t)

            # Create an outline for the data.
            o = Outline()
            script.add_module(o)

            # Create an axes for the data.
            a = Axes()
            script.add_module(a)

            # Create an orientation axes for the scene.  This only works with
            # VTK-4.5 and above which is why we have the try block.
            try:
                from mayavi.modules.orientation_axes import OrientationAxes
            except ImportError:
                pass
            else:
                a = OrientationAxes()
                a.marker.set_viewport(0.0, 0.8, 0.2, 1.0)
                script.add_module(a)

            # Create three simple grid plane modules.
            # First normal to 'x' axis.
            gp = GridPlane()
            script.add_module(gp)
            # Second normal to 'y' axis.
            gp = GridPlane()
            gp.grid_plane.axis = 'y'
            script.add_module(gp)
            # Third normal to 'z' axis.
            gp = GridPlane()
            script.add_module(gp)
            gp.grid_plane.axis = 'z'

            # Create one ImagePlaneWidget.
            ipw = ImagePlaneWidget()
            script.add_module(ipw)
            # Set the position to the middle of the data.
            ipw.ipw.slice_position = 16

    if __name__ == '__main__':
        a = MyApp()
        a.main()