JAL-1551 spotlessApply
[jalview.git] / help / help / html / features / pdbviewer.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *  
13  * Jalview is distributed in the hope that it will be useful, but 
14  * WITHOUT ANY WARRANTY; without even the implied warranty 
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
16  * PURPOSE.  See the GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
20  * The Jalview Authors are detailed in the 'AUTHORS' file.
21  -->
22 <head>
23 <title>PDB Viewer</title>
24 </head>
25 <body>
26   <p>
27     <strong>The Jalview internal PDB Viewer</strong><br> Since
28     Jalview 2.3, the <a href="jmol.html">Jmol PDB Viewer</a> is the main
29     method for <a href="viewingpdbs.html">viewing PDB structures</a>.
30     The documentation below concerns the original Jalview PDB viewer,
31     which is only used in situations where Jmol is unavailable or cannot
32     operate.
33   </p>
34   <p>
35     <strong>The PDB Viewer Window</strong>
36   <p>
37     This interactive structure viewing window is opened by selecting
38     entries from the <strong>&quot;Structure&#8594;&quot;</strong>
39     submenu of the <a href="../menus/popupMenu.html">sequence id
40       pop-up menu</a>. The internal PDB viewer is not able to show
41     superpositions, so no other options are provided. Structures can
42     only be viewed for sequences which have an <a
43       href="viewingpdbs.html">associated PDB structure</a>, and the
44     PDB Viewer will only be associated with the particular alignment
45     view from which it was opened.
46   </p>
47   <p>
48     <strong>Controls</strong>
49   </p>
50   <p>The structure is rendered as an alpha-carbon trace. Moving the
51     mouse over the structure brings up tooltips with a residue name and
52     PDB sequence position. If a mapping exists to a residue in the
53     associated sequence, then this will be highlighted in the associated
54     view in its alignment window, and vice versa for viewing the
55     coordinates associated with a particular residue in the sequence in
56     a particular view on the alignment.</p>
57   <p>Selecting a residue highlights its associated sequence residue
58     and alpha carbon location.</p>
59   <p>
60   <table>
61     <tr>
62       <td><strong>Action</strong></td>
63       <td><strong>Windows</strong></td>
64       <td><strong>Unix</strong></td>
65       <td><strong>Mac/OSX</strong></td>
66     </tr>
67     <tr>
68       <td>Select/<br> Deselect<br> Residue
69       </td>
70       <td>Left Click</td>
71       <td>Left Click</td>
72       <td>Click</td>
73     </tr>
74     <tr>
75       <td>Rotate View</td>
76       <td>Left Click and Drag</td>
77       <td>Left Click and Drag</td>
78       <td>Click and Drag</td>
79     </tr>
80     <tr>
81       <td>Roll View</td>
82       <td>Right Click and drag</td>
83       <td>Right Click and Drag</td>
84       <td>TODO</td>
85     </tr>
86     <tr>
87       <td>Move Origin</td>
88       <td>Middle-Button and Drag</td>
89       <td>Middle-Button and Drag</td>
90       <td>TODO</td>
91     </tr>
92     <tr>
93       <td>Zoom In</td>
94       <td>Up Arrow</td>
95       <td>Up Arrow</td>
96       <td>Up Arrow</td>
97     </tr>
98     <tr>
99       <td>Zoom Out</td>
100       <td>Down Arrow</td>
101       <td>Down Arrow</td>
102       <td>Down Arrow</td>
103     </tr>
104   </table>
105   </p>
106   <p>There are three menus:
107   <ul>
108     <li><Strong>File<br>
109     </strong>
110       <ul>
111         <li><strong>Save As<br>
112         </strong><em>Saves the current view as an EPS or PNG file.</em></li>
113         <li><strong>View Mapping<br>
114         </strong><em> Opens a text window showing the alignment between the
115             residues corresponding to alpha-carbon atoms in the PDB
116             structure and the residues in the associated sequence.</em></li>
117       </ul></li>
118     <li><strong>Colours<br>
119     </strong>
120       <ul>
121         <li><strong>By Sequence<br>
122         </strong><em> Colours each residue in the structure with the colour
123             of its corresponding residue in the associated sequence as
124             rendered in the associated alignment view, including any
125             UniProt sequence features or region colourings.<br>
126             Residues which only exist in the PDB structure are coloured
127             white if they are insertions (relative to the associated
128             sequence in the alignment) and grey if they are N or C
129             terminal flanks outside the region mapped to the alignment
130             window's sequence.
131         </em></li>
132         <li><strong>By Chain<br>
133         </strong><em> Assigns a random colour to each PDB chain.</em>
134         <li><strong>Charge &amp; Cysteine<br>
135         </strong><em> Highlights cysteines in yellow, anionic (Aspartic Acid
136             or Glutamic Acid) residues in red, and cationic (Lysine or
137             Arginine) residues in blue.</em></li>
138         <li><strong><em>Standard and User Defined
139               Jalview colourschemes.<br>
140           </em></strong> The remaining entries apply the colourschemes available from
141           the standard and user defined <a
142           href="../colourSchemes/index.html">amino acid
143             colours</a>.</em></li>
144       </ul></li>
145     <li><strong>View<br>
146     </strong><em> These options can be turned off to improve performance
147         when viewing large structures, some at the expense of visual
148         clarity.</em>
149       <ul>
150         <li><strong>Wireframe<br>
151         </strong><em> Draws thin lines rather than thick lines for the
152             alpha-carbon trace.</em></li>
153         <li><strong>Depthcue<br>
154         </strong><em>Shades the structure so parts of the structure near the
155             front of the view are brighter than those further away.</em></li>
156         <li><strong>Z Buffering<br>
157         </strong><em> Applies depth sorting to correctly render occluded
158             regions of the backbone trace.</em></li>
159         <li><strong>Show All Chains<br>
160         </strong><em> When turned on, shows all chains in the PDB file, not
161             just the one associated with a sequence in the alignment
162             window.</em></li>
163         <!--  NOT YET IMPLEMENTED <li><strong>Associate View</strong><br>
164                 Change which view on the associated sequence's alignment is to be
165                 associated with the PDB viewer.-->
166       </ul></li>
167   </ul>
168   </p>
169   <p>
170     <strong>Notes for PDB Viewing in the Jalview Applet</strong>
171   <p>The applet can only load PDB files by copying and pasting the
172     text into the popup window which appears when &quot;Show PDB
173     Structure&quot; is selected after right clicking on a sequence name.</p>
174 </body>
175 </html>