1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
"""
Script to render the images for the Mayavi user guide.
This scipts requires image magic to be installed.
"""
# Author: Gael Varoquaux <gael dot varoquaux at normalesup dot org>
# Copyright (c) 2007, Enthought, Inc.
# License: BSD Style.
import os
from mayavi import mlab
from mayavi.scripts import mayavi2
from inspect import getmembers
IMAGE_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)),
'mayavi', 'generated_images')
#############################################################################
def capture_image(func, filename):
""" Runs a function doing some mayavi drawing and save the resulting
scene to a file.
"""
mlab.clf()
func()
if not filename[-4:] in ('.jpg', '.png'):
filename = '%s.jpg' % filename
mlab.savefig(filename , size=(400, 400) )
os.system('convert %s -trim %s' % (filename, filename))
def illustrate_module(module, directory=IMAGE_DIR):
""" Uses the test functions of the modules (discovery ala nose) to
create images for each function tested.
"""
for name, func in getmembers(module):
if not callable(func) or not name.lower().startswith('test'):
continue
if name.lower().endswith('anim'):
continue
# LaTeX doesn't like '.' in filename (sucks), so we replace them.
filename = directory + os.sep + module.__name__.replace('.', '_') \
+ '_' + name[5:]
capture_image(func, filename=filename)
#############################################################################
# Entry point
@mlab.show
def main():
mlab.figure(bgcolor=(1, 1, 1), fgcolor=(0, 0, 0), size=(400, 400))
print("Generating the mlab images...")
illustrate_module(mlab)
mayavi2.close()
print("Done generating the mlab images")
print("Generating the example pages")
from render_examples import render_examples
render_examples(render_images=True)
print("Done generating the example pages")
if __name__ == '__main__':
main()
|
