help/html/features/pdbviewer.html

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