File: rods.l

package info (click to toggle)
raster3d 3.0-3-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 4,900 kB
  • ctags: 1,557
  • sloc: fortran: 9,536; ansic: 1,060; makefile: 317; sh: 250; csh: 15
file content (146 lines) | stat: -rw-r--r-- 5,131 bytes parent folder | download | duplicates (5)
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
.ad l
.nh
.TH RODS 1 " 8 May 1999" "Raster3D"
.SH NAME

rods - Raster3D preprocessor for ball-and-stick models 
.SH SYNOPSIS
.PP
.B rods [\fI-h\fP] [\fI-b\fP] [\fI-radius R\fP] \fI[-Bcolor Bmin Bmax\fP]
.PP
\fIRods\fP reads a file describing atom colours and/or a 
PDB coordinate file and produces a file containing Raster3D descriptor
records.
The file produced by \fIrods\fP
may be fed directly to \fIrender\fP or it may be combined with descriptor
files produced by other Raster3D utilities.
.PP
.SH EXAMPLES
.PP
To describe a simple bonds-only model coloured by residue type:
.PP
     cat mycolours.pdb protein.pdb | rods | render > mypicture.png
.PP
To render the same molecule as ball-and-stick:
.PP
     cat mycolours.pdb protein.pdb | rods -b | render > mypicture.png
.SH OPTIONS

.B "-h"
.PP
Suppress header records in output.  
By default \fIrods\fP will produce an output file which starts with 
header records containing a default set of scaling and processing
options.
The \fI-h\fP flag will suppress these header records so that the output
file contains only object descriptors.
This option is useful for producing files which describe only part
of a scene, and which are to be later combined with descriptor files
produced by other programs.

.B "-b"
.PP
By default \fIrods\fP will describe bonds only; the -b flag will
cause it to include spheres at the atom positions also, yielding
a ball-and-stick representation.  

.B "-radius R"
.PP
By default \fIrods\fP will draw bonds as cylinders with a 0.2A radius.
The radius option allows you to change this cylindrical radius.

.B "-Bcolor Bmin Bmax"
.PP
Assign colors based on B values rather than from atom or residue types.
Atoms with B <= Bmin will be colored dark blue; atoms with B >= Bmax
will be colored light red; atoms with Bmin < B < Bmax will be assigned
colors shading smoothly through the spectrum from blue to red.

.SH DESCRIPTION
.PP 
The input to \fIrods\fP consists of a single text file
containing colour information and atomic coordinates in 
PDB data bank format.
Coordinates are output as Raster3D descriptor records
with colours and sphere radii assigned according to the COLO
records described below.  
Ball-and-stick figures have atoms drawn at 0.2 * VanderWaals radius, 
connected by rods with a default 0.2A cylindrical radius.
Bonds are drawn for atoms which lie closer to each other than
0.6 * (sum of VanderWaals radii).
By default the output file contains a set of header records as
required by the \fIrender\fP program.
The header is constructed to include a TMAT matrix corresponding to
the transformation matrix contained in
file \fIsetup.matrix\fP (if it exists), or to the Eulerian angles
contained in file \fIsetup.angles\fP (if it exists).

.PP 
Colours are assigned to atoms using a matching process,
using COLOUR records prepended to the input PDB file.
If no COLOUR records are present in the input file, atoms
will  receive default CPK colors (C=grey, O=red, N=blue, S=yellow, P=green,
other=magenta).
Raster3D uses a pseudo-PDB record type with the same basic
layout as the above but with COLO in the first 4 columns:
 
   Columns
 
    1 -  4   COLO
 
    7 - 30   Mask (described below)
 
   31 - 38   Red component
 
   39 - 46   Green component
 
   47 - 54   Blue component
 
   55 - 60   van der Waals radius in Angstroms
 
   61 - 80   Comments
 
Note that the Red, Green, and Blue components are in the same positions
as the X, Y, and Z components of an ATOM or HETA record, and the van der
Waals radius goes in place of the Occupancy.  
The Red, Green, and Blue components must all be in the range 0 to 1.

The Mask field is used in the matching process as follows.  
First the program reads in and stores all the ATOM, HETA, and
COLO records in input order.  Then it goes through each stored
ATOM/HETA record in turn, and searches for a COLO record that matches
the ATOM/HETA record in all of columns 7 through 30.  The first such
COLO record to be found determines the colour and radius of the atom.

In order that one COLO record can provide colour and radius
specifications for more than one atom (e.g., based on residue or atom
type, or any other criterion for which labels can be given somewhere in
columns 7 through 30), the "#" symbol is used as a wildcard. I.e. a #
in a COLO record matches any character in the
corresponding column in an ATOM or HETA record.  All other characters
must match literally to count as a match.  Note that the very last COLO
record in the input should have # symbols in all of columns 7 through
30 in order to provide a colour for any atom whose ATOM/HETA record
fails to match any previous COLO record.  This idea of matching masks for
colour specifications is due to Colin Broughton.

.SH ENVIRONMENT
The files setup.matrix and setup.angles, if they exist, 
affect the header records produced by \fIrods\fP.

.SH SOURCE
 
.B web URL:
 	http://www.bmsc.washington.edu/raster3d/raster3d.html
 
.B contact:		
 	Ethan A Merritt
 	University of Washington, Seattle WA 98195
 	merritt@u.washington.edu

.SH SEE ALSO
render(l), ribbon(l), balls(l)
.PP
.SH AUTHORS
	Ethan A Merritt