Debian Codegraph @

examples/README.examples

raw
1 This directory contains some example uses of Raster3D, which
2 may serve as confirmation of successful installation or as
3 models for general use.
4
5 Most of the example scripts assume that ImageMagick is installed
6 on your system as an image viewer. If it is, then executing these
7 shell scripts should produce an image on your X-windows screen.
8
9 There is a small picture gallery of the example images included
10 in the HTML documentation ../html/r3d_examples.html
11
12 The ./msms subdirectory contains source code for filters to
13 convert molecular surfaces calculated using msms into Raster3D
14 files, and an example of use.
15
16 Example 1
17 =========
18
19 Example 1 illustrates the use of object types 8 + 9 to change the
20 material properties for individual objects in the figure.
21 It also illustrates using file indirection and the library of
22 special materials included in the Raster3D distribution kit.
23 The library is made known to the system by setting the environmental
24 variable R3D_LIB.
25
26 You can run example1.script or else type something
27 like:
28 setenv R3D_LIB ../materials
29 render < example5.r3d | display avs:- (ImageMagick)
30 or
31 render -sgi test.rgb < example5.r3d ; ipaste test.rgb (SGI)
32 or
33 render -tiff test.tiff < example5.r3d (TIFF file)
34
35
36 Example 2
37 =========
38
39 Example 2 excercises the utilities balls and rods.
40 example2.sgi is the same as example2.script, except that it
41 assumes that you are using the SGI libimage utilities as a viewer.
42
43
44 Examples 3, 4, and 5
45 ====================
46
47 The 3rd, 4th, and 5th examples provided here correspond to a figure of
48 the galactose binding site in the E. coli Heat-labile enterotoxin.
49 The figure was composed and generated using the program MOLSCRIPT,
50 by Per Kraulis. I have included three files here:
51
52 example3.mol - the MOLSCRIPT input file
53 example3.ps - the output from MOLSCRIPT when run in PostScript mode
54 (should be displayable using a PostScript viewer)
55 example3.r3d - the output from MOLSCRIPT when run in Raster3D mode
56
57 The example3.script will just render and display the example.r3d file.
58
59 The example4.script requires that Molscript is installed and
60 that you have built TIFF support into the Raster3D package. It should
61 start with the Molscript input file and produce a TIFF file containing
62 the same image produced by example3. If you have Molscript V2.0 you
63 should see labels in the Raster3D image; earlier versions of Molscript
64 did not pass labels through to Raster3D.
65
66 Example 5 adds a transparent molecular surface around the galactose
67 molecule in example 3. This is a fairly complicated example which
68 illustrates merging Raster3D input files created by two different
69 programs, in this case Molscript and GRASP. I have included a
70 Raster3D input file produced from a GRASP V1.1 surface file by a
71 conversion program. I have not included the actual GRASP file because
72 the format of such files is both version and machine dependent. A copy
73 of the "ungrasp" utility program I used for conversion is included in
74 the directory ../grasp, but you may have to modify this source depending
75 on your local installation.
76 This example illustrates:
77 - the inclusion of a molecular surface file
78 - the specification of a transparent surface
79 - application of a post-multiplied rotation/translation matrix
80 - uncompression of a gzipped input file during processing
81
82 Note: It would be a more informative figure if the accessible surface
83 of the protein were shown, rather than that of the bound sugar. However
84 this would have required inclusion of an absolutely huge surface
85 description file so I judged it impractical. A JPEG figure illustrating
86 Raster3D rendering of a protein surface should be available on the
87 Raster3D distribution site.
88
89
90 Example 6
91 =========
92
93 Example 6 demonstrates the Version 2.5 command line options to render.
94
95
96 Example 7
97 =========
98
99 Example 7 demonstrates support for PostScript labels added to the
100 render program in version 2.5. Label commands in the input file are
101 converted to PostScript while the scene is being rendered. The resulting
102 PostScript file is fed through ghostscript to produce a raster image
103 containing the labels. Finally the two raster images, one containing
104 the molecular graphics and the second containing the labels, are
105 composited to yield a single image file with both molecules and labels.
106 This procedure is automated by the label3d script.
107
108
109 Example 8
110 =========
111
112 Demonstrates the creation of a stereo pair using the stereo3d command.
113 It also illustrates the use of the ribbon command to draw a minimal
114 representation of the protein backbone.
115
116
117 Example 9
118 =========
119
120 This example shows the use of the Raster3D Termal Ellipsoid Program
121 (rastep) to display isosurfaces corresponding to anisotropic
122 displacement parameters Uij.