Source code for simphony_mayavi.snapshot

import sys

from mayavi import mlab
from mayavi.tools.tools import _typical_distance

from simphony.cuds.abstractmesh import ABCMesh
from simphony.cuds.abstractparticles import ABCParticles
from simphony.cuds.abstractlattice import ABCLattice

from simphony_mayavi.sources.api import CUDSSource


def snapshot(cuds, filename):
    """ Shave a snapshot of the cuds object using the default visualisation.

     Parameters
     ----------
     cuds :
         A top level cuds object (e.g. a mesh). The method will detect
         the type of object and create the appropriate visualisation.

     filename : string
         The filename to use for the output file.

    """
    size = 800, 600

    if sys.platform == 'win32':
        mlab.options.offscreen = True
    else:
        figure = mlab.gcf()
        figure.scene.off_screen_rendering = True

    try:
        if isinstance(cuds, ABCMesh):
            source = CUDSSource(cuds=cuds)
            mlab.pipeline.surface(source, name=cuds.name)
        elif isinstance(cuds, ABCParticles):
            source = CUDSSource(cuds=cuds)
            scale_factor = _typical_distance(source.data) * 0.5
            mlab.pipeline.glyph(
                source, name=cuds.name,
                scale_factor=scale_factor, scale_mode='none')
            surface = mlab.pipeline.surface(source)
            surface.actor.mapper.scalar_visibility = False
        elif isinstance(cuds, ABCLattice):
            source = CUDSSource(cuds=cuds)
            scale_factor = _typical_distance(source.data) * 0.5
            mlab.pipeline.glyph(
                source, name=cuds.name,
                scale_factor=scale_factor, scale_mode='none')
        else:
            msg = 'Provided object {} is not of any known cuds type'
            raise TypeError(msg.format(type(cuds)))
        mlab.savefig(filename, size, magnification=1.0)
    finally:
        mlab.clf()
        mlab.close()