help/html/features/jmol.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   4  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19 <head>
  20 <title>The Jmol PDB Viewer</title>
  21 </head>
  22 <body>
  23 <p><strong>The Jmol PDB Viewer</strong></p>
  24 <p>Since Jalview 2.3, <a href="http://jmol.sourceforge.net/">Jmol</a>
  25 has been integrated into Jalview for interactively viewing structures
  26 opened by selecting the <strong>&quot;Structure&#8594;View PDB
  27 entry:&quot;</strong> option in the <a href="../menus/popupMenu.html">sequence
  28 id pop-up menu</a> (if you can't see this, then you need to <a
  29         href="viewingpdbs.html">associate a PDB structure</a> with the
  30 sequence). Jmol is available from the Jalview desktop and should also
  31 run in the JalviewLite applet, providing the browser supports Java 1.5.
  32 If Jmol is not available, then the original <a href="pdbviewer.html">internal
  33 pdb viewer</a> will be used as a fallback.</p>
  34 <p><a name="align"><strong>Superposing structures based
  35 on their aligned sequences</strong></a><br>
  36 If several structures are available on the alignment, you may add
  37 additional structures to an existing Jmol view by selecting their entry
  38 in the appropriate pop-up menu. Jalview will ask you if you wish to add
  39 the structure to the existing alignment, and if you do, it will import
  40 and superimpose the new PDB file using the corresponding positions from
  41 the alignment. If the alignment is subsequently edited, you can use the
  42 <a href="#sAlign"><em>Jmol&#8594;Align</em></a> menu option from the
  43 menu bar of the structure view window to superpose the structures using
  44 the updated alignment.<br>
  45 <em>Sequence based structure superposition was added in Jalview 2.6</em>
  46 </p>
  47 <p><strong>Controls</strong><br>
  48 The structure is by default rendered as a ribbon diagram. Moving the
  49 mouse over the structure brings up tooltips giving the residue name, PDB
  50 residue number and chain code, atom name and number
  51 ([RES]Num:Chain.AtomName#AtomNumber). If a mapping exists to a residue
  52 in any associated sequences, then this will be highlighted in each one's
  53 alignment window. The converse also occurs - moving the mouse over an
  54 associated residue in an alignment window highlights the associated
  55 atoms in the displayed structures.</p>
  56 <p>Selecting a residue highlights its associated sequence residue
  57 and alpha carbon location. Double clicking an atom allows distances to
  58 be measured from it to any other atom in the structure.</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>Rotate View</td>
  69                 <td>Left Click and Drag</td>
  70                 <td>Left Click and Drag</td>
  71                 <td>Click and Drag</td>
  72         </tr>
  73         <tr>
  74                 <td>Zoom</td>
  75                 <td>Shift + Left Click<br>
  76                 drag mouse up or down</td>
  77                 <td>Shift + Left Click<br>
  78                 or middle button<br>
  79                 drag mouse up or down</td>
  80                 <td>Left-Alt + Click and drag mouse up or down</td>
  81         </tr>
  82         <tr>
  83                 <td>Select/<br>
  84                 Deselect<br>
  85                 Residue</td>
  86                 <td>Left Click</td>
  87                 <td>Left Click</td>
  88                 <td>Click</td>
  89         </tr>
  90         <tr>
  91                 <td>Roll View</td>
  92                 <td>Shift + Left Click<br>
  93                 drag mouse to left or right</td>
  94                 <td>Shift + Left Click<br>
  95                 or middle button<br>
  96                 drag mouse to left or right</td>
  97                 <td>Left-Alt + Click and drag mouse to left or right</td>
  98         </tr>
  99         <tr>
 100                 <td>Move Origin</td>
 101                 <td>Shift+Control+Left Click<br>
 102                 or Middle Button<br>
 103                 + Drag</td>
 104                 <td>Middle-Button<br>
 105                 and<br>
 106                 drag</td>
 107                 <td>Shift+Control+Left Click<br>
 108                 or Middle Button<br>
 109                 and drag</td>
 110         </tr>
 111         <tr>
 112                 <td>Jmol Menu</td>
 113                 <td>Right-Click</td>
 114                 <td>Right-Click</td>
 115                 <td>Apple-Click</td>
 116         </tr>
 117 </table>
 118 </p>
 119 <p>The window has up to five menus:
 120 <ul>
 121         <li><Strong>File<br>
 122         </strong>
 123         <ul>
 124                 <li><strong>Save As<br>
 125                 </strong><em>Save the displayed PDB File, or the current view as an EPS or
 126                 PNG file.</em></li>
 127                 <li><strong>View Mapping<br>
 128                 </strong><em> Opens a text window showing the alignment between the
 129                 residues corresponding to alpha-carbon atoms in the PDB structure and
 130                 the residues in the associated sequence.</em></li>
 131         </ul>
 132         </li>
 133         <li><strong>View</strong>
 134         <ul>
 135                 <li><strong>Show Chains<br>
 136                 </strong><em>Select which of the PDB file's chains are to be displayed.</em></li>
 137                 <li><strong>Colour by ..<br></strong><em>Submenu allowing specific alignment views to be selected for colouring associated chains in the structure display. This menu contains all the alignment views associated with the structure view, with those used to colour the view indicated by ticks. Addditionally, it contains the following menu entries:</em>
 138                 <ul><li><strong>Select many views<br></strong><em>When this option is enabled, selecting an alignment view adds it to the set used to colour the structures. Use this when colouring structures related to a number of alignments involving different domains or chains which are shown in the same structure view.</em>
 139                 </li>
 140     <li><strong>Select all views<br></strong><em>This is only enabled when </em><strong>Select many views</strong><em> is also enabled, and will add all associated views to the set used to colour the structure display.</em>
 141   </li>
 142     <li><strong>Invert selection<br></strong><em>This is only enabled when </em><strong>Select many views</strong><em> is also enabled, and will replace the current set of views with any remaining views not currently used to colour the structure display.</em>
 143   </li></ul></li>
 144         <li><strong>Colours<br>
 145         </strong>
 146         <ul>
 147                 <li><strong>By Sequence<br>
 148                 </strong><em> Colours each residue in the structure with the colour of its
 149                 corresponding residue in the associated sequence as rendered in the
 150                 associated alignment views, including any Uniprot sequence features or
 151                 region colourings.<br/>Pick which of the associated alignment views are used to colour the structures using the <strong>View&#8594;Colour by ..</strong> sub menu.</em><br>
 152                 Residues which only exist in the PDB structure are coloured white if
 153                 they are insertions (relative to the associated sequence in the
 154                 alignment) and grey if they are N or C terminal flanks outside the
 155                 region mapped to the alignment window's sequence.</em></li>
 156                 <li><strong>By Chain<br>
 157                 </strong><em> Assigns a random colour to each PDB chain.</em>
 158                 <li><strong>Charge &amp; Cysteine<br>
 159                 </strong><em> Highlights cysteines in yellow, anionic (Aspartic Acid or
 160                 Glutamic Acid) residues in red, and cationic (Lysine or Arginine)
 161                 residues in blue.</em></li>
 162                 <li><strong>Colour with Jmol<br></strong><em>Defers any colouring operations to Jmol. Select this if you want to use the Jmol scripting interface or menu to modify the view directly.</em></li>
 163                 <li><strong>Standard and User Defined Jalview
 164                 colourschemes.<br>
 165                 </strong><em>The remaining entries apply the colourschemes available from
 166                 the standard and user defined <a href="../colourSchemes/index.html">amino
 167                 acid colours</a>.</em></li>
 168         </ul>
 169         </li>
 170         <li><strong>Jmol<br>
 171         </strong><em>This pulldown menu is only displayed if there are multiple
 172         structures shown in the Jmol window, and Jalview can also locate at
 173         least two of the structures in the currently associated alignment view.</em>
 174         <ul>
 175                 <li><strong><a name="sAlign">Align</a> <br>
 176                 </strong><em> When selected, the associated alignment will be used to
 177                 superimpose all the structures in the view onto the first structure in
 178                 the alignment. The regions used to calculate the superposition will be
 179                 highlighted using the 'Cartoon' rendering style, and the remaining
 180                 data shown as a chain trace.<br>
 181                 (This option was introduced in Jalview 2.6)</em></li>
 182         </ul>
 183         </li>
 184         <li><strong>Help<br>
 185         </strong>
 186         <ul>
 187                 <li><strong>Jmol Help<br>
 188                 </strong><em>Access the Jmol Help documentation in a new browser window.</em></li>
 189         </ul>
 190         </li>
 191 </ul>
 192 </p>
 193 <p><strong>Functionality provided by Jmol</strong></p>
 194 <p>Jmol's own functions are accessed by clicking the 'Jmol' logo or
 195 right-clicking in the structure display area. Either way will open the
 196 Jmol pop-up menu, which provides access to a number of features for
 197 controlling the colour and display of molecules, adding measurements and
 198 labels, plotting surfaces, and display animation. The 'Set Picking' menu
 199 controls the behaviour of single and double mouse clicking on the
 200 structure, and the 'Console' option opens the Jmol scripting console.</p>
 201 <p>The state of each Jmol display is stored within <a
 202         href="jalarchive.html">jalview archives</a> as a Jmol state recovery
 203 script file. This means that any Jmol visualization effects that you add
 204 beyond those provided by Jalview will be able to be stored and recovered
 205 along with the displayed alignments in Jalview.</p>
 206 <p><strong>More Information</strong></p>
 207 <p>Jmol is a sophisticated program in its own right, with its own
 208 command console and scripting language. Only the essentials have been
 209 described here - the interested reader is referred to <a
 210         href="http://jmol.sourceforge.net/docs/">Jmol's own comprehensive
 211 online documentation</a>.</p>
 212 </p>
 213 </body>
 214 </html>