test/jalview/structures/models/AAStructureBindingModelTest.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * 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
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.structures.models;
  22
  23 import static org.testng.Assert.assertEquals;
  24 import static org.testng.Assert.assertFalse;
  25 import static org.testng.Assert.assertNotNull;
  26 import static org.testng.Assert.assertTrue;
  27
  28 import jalview.api.AlignmentViewPanel;
  29 import jalview.api.SequenceRenderer;
  30 import jalview.datamodel.Alignment;
  31 import jalview.datamodel.AlignmentI;
  32 import jalview.datamodel.ColumnSelection;
  33 import jalview.datamodel.PDBEntry;
  34 import jalview.datamodel.PDBEntry.Type;
  35 import jalview.datamodel.Sequence;
  36 import jalview.datamodel.SequenceI;
  37 import jalview.ext.rbvi.chimera.ChimeraCommands;
  38 import jalview.gui.AlignFrame;
  39 import jalview.gui.JvOptionPane;
  40 import jalview.gui.StructureViewer.ViewerType;
  41 import jalview.io.DataSourceType;
  42 import jalview.io.FileFormats;
  43 import jalview.schemes.JalviewColourScheme;
  44 import jalview.structure.AtomSpec;
  45 import jalview.structure.AtomSpecModel;
  46 import jalview.structure.StructureCommandI;
  47 import jalview.structure.StructureMapping;
  48 import jalview.structure.StructureSelectionManager;
  49
  50 import java.awt.Color;
  51 import java.io.IOException;
  52 import java.util.Arrays;
  53 import java.util.BitSet;
  54 import java.util.HashMap;
  55 import java.util.List;
  56 import java.util.Map;
  57
  58 import org.testng.annotations.BeforeClass;
  59 import org.testng.annotations.BeforeMethod;
  60 import org.testng.annotations.Test;
  61
  62 import junit.extensions.PA;
  63
  64 /**
  65  * Unit tests for non-abstract methods of abstract base class
  66  *
  67  * @author gmcarstairs
  68  *
  69  */
  70 public class AAStructureBindingModelTest
  71 {
  72
  73   @BeforeClass(alwaysRun = true)
  74   public void setUpJvOptionPane()
  75   {
  76     JvOptionPane.setInteractiveMode(false);
  77     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  78   }
  79
  80   /*
  81    * Scenario: Jalview has 4 sequences, corresponding to 1YCS (chains A and B), 3A6S|B, 1OOT|A
  82    */
  83   private static final String PDB_1 = "HEADER    COMPLEX (ANTI-ONCOGENE/ANKYRIN REPEATS) 30-SEP-96   1YCS              \n"
  84           + "ATOM      2  CA  VAL A  97      24.134   4.926  45.821  1.00 47.43           C  \n"
  85           + "ATOM      9  CA  PRO A  98      25.135   8.584  46.217  1.00 41.60           C  \n"
  86           + "ATOM     16  CA  SER A  99      28.243   9.596  44.271  1.00 39.63           C  \n"
  87           + "ATOM     22  CA  GLN A 100      31.488  10.133  46.156  1.00 35.60           C  \n"
  88           // artificial jump in residue numbering to prove it is correctly
  89           // mapped:
  90           + "ATOM     31  CA  LYS A 102      33.323  11.587  43.115  1.00 41.69           C  \n"
  91           + "ATOM   1857  CA  GLU B 374       9.193 -16.005  95.870  1.00 54.22           C  \n"
  92           + "ATOM   1866  CA  ILE B 375       7.101 -14.921  92.847  1.00 46.82           C  \n"
  93           + "ATOM   1874  CA  VAL B 376      10.251 -13.625  91.155  1.00 47.80           C  \n"
  94           + "ATOM   1881  CA  LYS B 377      11.767 -17.068  91.763  1.00 50.21           C  \n"
  95           + "ATOM   1890  CA  PHE B 378       8.665 -18.948  90.632  1.00 44.85           C  \n";
  96
  97   private static final String PDB_2 = "HEADER    HYDROLASE                               09-SEP-09   3A6S              \n"
  98           + "ATOM      2  CA  MET B   1      15.366 -11.648  24.854  1.00 32.05           C  \n"
  99           + "ATOM     10  CA  LYS B   2      16.846  -9.215  22.340  1.00 25.68           C  \n"
 100           + "ATOM     19  CA  LYS B   3      15.412  -6.335  20.343  1.00 19.42           C  \n"
 101           + "ATOM     28  CA  LEU B   4      15.629  -5.719  16.616  1.00 15.49           C  \n"
 102           + "ATOM     36  CA  GLN B   5      14.412  -2.295  15.567  1.00 12.19           C  \n";
 103
 104   private static final String PDB_3 = "HEADER    STRUCTURAL GENOMICS                     04-MAR-03   1OOT              \n"
 105           + "ATOM      2  CA  SER A   7      29.427   3.330  -6.578  1.00 32.50           C  \n"
 106           + "ATOM      8  CA  PRO A   8      29.975   3.340  -2.797  1.00 17.62           C  \n"
 107           + "ATOM     16  CA ALYS A   9      26.958   3.024  -0.410  0.50  8.78           C  \n"
 108           + "ATOM     33  CA  ALA A  10      26.790   4.320   3.172  1.00 11.98           C  \n"
 109           + "ATOM     39  CA AVAL A  12      24.424   3.853   6.106  0.50 13.83           C  \n";
 110
 111   /**
 112    * Multichain PDB with identical sequences imported - Binding should correctly
 113    * recover chain mappings for each derived sequence
 114    */
 115   private static final String PDB_4_MC = "HEADER    HYDROLASE                               09-SEP-09   3A6S              \n"
 116           + "ATOM      2  CA  MET A   1      15.366 -11.648  24.854  1.00 32.05           C  \n"
 117           + "ATOM     10  CA  LYS A   2      16.846  -9.215  22.340  1.00 25.68           C  \n"
 118           + "ATOM     19  CA  LYS A   3      15.412  -6.335  20.343  1.00 19.42           C  \n"
 119           + "ATOM     28  CA  LEU A   4      15.629  -5.719  16.616  1.00 15.49           C  \n"
 120           + "ATOM     36  CA  GLN A   5      14.412  -2.295  15.567  1.00 12.19           C  \n"
 121           + "ATOM   1030  CA  MET B   1      18.869  -7.572   3.432  1.00 31.52           C  \n"
 122           + "ATOM   1038  CA  LYS B   2      19.182 -10.025   6.313  1.00 26.41           C  \n"
 123           + "ATOM   1047  CA  LYS B   3      17.107 -12.963   7.534  1.00 19.71           C  \n"
 124           + "ATOM   1056  CA  LEU B   4      16.142 -13.579  11.164  1.00 14.81           C  \n"
 125           + "ATOM   1064  CA  GLN B   5      14.648 -17.005  11.785  1.00 13.38           C  \n";
 126
 127   // TODO: JAL-2227 - import mmCIF PISA assembly & identify master/copy chains
 128
 129   @Test(groups= {"Functional"})
 130   public void testImportPDBPreservesChainMappings() throws IOException
 131   {
 132     AlignmentI importedAl = new jalview.io.FormatAdapter().readFile(
 133             PDB_4_MC, DataSourceType.PASTE, FileFormats.getInstance()
 134                     .forName(jalview.io.FileFormat.PDB.toString()));
 135     // ideally, we would match on the actual data for the 'File' handle for
 136     // pasted files,
 137     // see JAL-623 - pasting is still not correctly handled...
 138     PDBEntry importedPDB = new PDBEntry("3A6S", "", Type.PDB,
 139             "Paste");
 140     AAStructureBindingModel binder = new AAStructureBindingModel(
 141             new StructureSelectionManager(), new PDBEntry[]
 142             { importedPDB },
 143             new SequenceI[][]
 144             { importedAl.getSequencesArray() }, null)
 145     {
 146
 147       @Override
 148       public void updateColours(Object source)
 149       {
 150       }
 151
 152       @Override
 153       public void releaseReferences(Object svl)
 154       {
 155       }
 156
 157       @Override
 158       public String[] getStructureFiles()
 159       {
 160         return null;
 161       }
 162
 163       @Override
 164       public void highlightAtoms(List<AtomSpec> atoms)
 165       {
 166       }
 167
 168       @Override
 169       public SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
 170       {
 171         return null;
 172       }
 173
 174       @Override
 175       protected List<String> executeCommand(StructureCommandI command,
 176               boolean getReply)
 177       {
 178         return null;
 179       }
 180
 181       @Override
 182       protected String getModelIdForFile(String chainId)
 183       {
 184         return "";
 185       }
 186
 187       @Override
 188       protected ViewerType getViewerType()
 189       {
 190         return null;
 191       }
 192     };
 193     String[][] chains = binder.getChains();
 194     assertFalse(chains == null || chains[0] == null,
 195             "No chains discovered by binding");
 196     assertEquals(chains[0].length, 2);
 197     assertEquals(chains[0][0], "A");
 198     assertEquals(chains[0][1], "B");
 199   }
 200   AAStructureBindingModel testee;
 201
 202   AlignmentI al = null;
 203
 204   /**
 205    * Set up test conditions with three aligned sequences,
 206    */
 207   @BeforeMethod(alwaysRun = true)
 208   public void setUp()
 209   {
 210     SequenceI seq1a = new Sequence("1YCS|A", "-VPSQK");
 211     SequenceI seq1b = new Sequence("1YCS|B", "EIVKF-");
 212     SequenceI seq2 = new Sequence("3A6S", "MK-KLQ");
 213     SequenceI seq3 = new Sequence("1OOT", "SPK-AV");
 214     al = new Alignment(new SequenceI[] { seq1a, seq1b, seq2, seq3 });
 215     al.setDataset(null);
 216
 217     /*
 218      * give pdb files the name generated by Jalview for PASTE source
 219      */
 220     PDBEntry[] pdbFiles = new PDBEntry[3];
 221     pdbFiles[0] = new PDBEntry("1YCS", "A", Type.PDB, "INLINE1YCS");
 222     pdbFiles[1] = new PDBEntry("3A6S", "B", Type.PDB, "INLINE3A6S");
 223     pdbFiles[2] = new PDBEntry("1OOT", "A", Type.PDB, "INLINE1OOT");
 224     SequenceI[][] seqs = new SequenceI[3][];
 225     seqs[0] = new SequenceI[] { seq1a, seq1b };
 226     seqs[1] = new SequenceI[] { seq2 };
 227     seqs[2] = new SequenceI[] { seq3 };
 228     StructureSelectionManager ssm = new StructureSelectionManager();
 229
 230     ssm.setMapping(new SequenceI[] { seq1a, seq1b }, null, PDB_1,
 231             DataSourceType.PASTE, null);
 232     ssm.setMapping(new SequenceI[] { seq2 }, null, PDB_2,
 233             DataSourceType.PASTE, null);
 234     ssm.setMapping(new SequenceI[] { seq3 }, null, PDB_3,
 235             DataSourceType.PASTE, null);
 236
 237     testee = newBindingModel(pdbFiles, seqs, ssm);
 238   }
 239
 240   /**
 241    * A helper method to construct the test target object
 242    *
 243    * @param pdbFiles
 244    * @param seqs
 245    * @param ssm
 246    */
 247   protected AAStructureBindingModel newBindingModel(PDBEntry[] pdbFiles,
 248           SequenceI[][] seqs,
 249           StructureSelectionManager ssm)
 250   {
 251     AAStructureBindingModel model = new AAStructureBindingModel(ssm,
 252             pdbFiles, seqs, null)
 253     {
 254       @Override
 255       public String[] getStructureFiles()
 256       {
 257         return new String[] { "INLINE1YCS", "INLINE3A6S", "INLINE1OOT" };
 258       }
 259
 260       @Override
 261       public void updateColours(Object source)
 262       {
 263       }
 264
 265       @Override
 266       public void releaseReferences(Object svl)
 267       {
 268       }
 269
 270       @Override
 271       public void highlightAtoms(List<AtomSpec> atoms)
 272       {
 273       }
 274
 275       @Override
 276       public SequenceRenderer getSequenceRenderer(
 277               AlignmentViewPanel alignment)
 278       {
 279         return null;
 280       }
 281
 282       @Override
 283       protected List<String> executeCommand(StructureCommandI command,
 284               boolean getReply)
 285       {
 286         return null;
 287       }
 288
 289       @Override
 290       protected String getModelIdForFile(String chainId)
 291       {
 292         return "";
 293       }
 294
 295       @Override
 296       protected ViewerType getViewerType()
 297       {
 298         return null;
 299       }
 300     };
 301     PA.setValue(model, "commandGenerator", new ChimeraCommands());
 302     return model;
 303   }
 304
 305   /**
 306    * Verify that the method determines that columns 2, 5 and 6 of the alignment
 307    * are alignable in structure
 308    */
 309   @Test(groups = { "Functional" })
 310   public void testFindSuperposableResidues()
 311   {
 312     /*
 313      * create a data bean to hold data per structure file
 314      */
 315     AAStructureBindingModel.SuperposeData[] structs = new AAStructureBindingModel.SuperposeData[testee.getStructureFiles().length];
 316     for (int i = 0; i < structs.length; i++)
 317     {
 318       structs[i] = new AAStructureBindingModel.SuperposeData(al.getWidth(), "0");
 319     }
 320     /*
 321      * initialise BitSet of 'superposable columns' to true (would be false for
 322      * hidden columns)
 323      */
 324     BitSet matched = new BitSet();
 325     for (int i = 0; i < al.getWidth(); i++)
 326     {
 327       matched.set(i);
 328     }
 329
 330     int refStructure = testee
 331             .findSuperposableResidues(al, matched, structs);
 332
 333     assertEquals(refStructure, 0);
 334
 335     /*
 336      * only ungapped, structure-mapped columns are superposable
 337      */
 338     assertFalse(matched.get(0)); // gap in first sequence
 339     assertTrue(matched.get(1));
 340     assertFalse(matched.get(2)); // gap in third sequence
 341     assertFalse(matched.get(3)); // gap in fourth sequence
 342     assertTrue(matched.get(4));
 343     assertTrue(matched.get(5)); // gap in second sequence
 344
 345     assertEquals(structs[0].pdbId, "1YCS");
 346     assertEquals(structs[1].pdbId, "3A6S");
 347     assertEquals(structs[2].pdbId, "1OOT");
 348     assertEquals(structs[0].chain, "A"); // ? struct has chains A _and_ B
 349     assertEquals(structs[1].chain, "B");
 350     assertEquals(structs[2].chain, "A");
 351     // the 0's for unsuperposable positions propagate down the columns:
 352     assertEquals(Arrays.toString(structs[0].pdbResNo),
 353             "[0, 97, 98, 99, 100, 102]");
 354     assertEquals(Arrays.toString(structs[1].pdbResNo),
 355             "[0, 2, 0, 3, 4, 5]");
 356     assertEquals(Arrays.toString(structs[2].pdbResNo),
 357             "[0, 8, 0, 0, 10, 12]");
 358   }
 359
 360   @Test(groups = { "Functional" })
 361   public void testFindSuperposableResidues_hiddenColumn()
 362   {
 363     AAStructureBindingModel.SuperposeData[] structs = new AAStructureBindingModel.SuperposeData[al.getHeight()];
 364     for (int i = 0; i < structs.length; i++)
 365     {
 366       structs[i] = new AAStructureBindingModel.SuperposeData(al.getWidth(), "0");
 367     }
 368     /*
 369      * initialise BitSet of 'superposable columns' to true (would be false for
 370      * hidden columns)
 371      */
 372     BitSet matched = new BitSet();
 373     for (int i = 0; i < al.getWidth(); i++)
 374     {
 375       matched.set(i);
 376     }
 377
 378     // treat column 5 of the alignment as hidden
 379     matched.clear(4);
 380
 381     int refStructure = testee
 382             .findSuperposableResidues(al, matched, structs);
 383
 384     assertEquals(refStructure, 0);
 385
 386     // only ungapped, structure-mapped columns are not superposable
 387     assertFalse(matched.get(0));
 388     assertTrue(matched.get(1));
 389     assertFalse(matched.get(2));
 390     assertFalse(matched.get(3));
 391     assertFalse(matched.get(4)); // superposable, but hidden, column
 392     assertTrue(matched.get(5));
 393   }
 394
 395   @Test(groups = { "Functional" })
 396   public void testBuildColoursMap()
 397   {
 398     /*
 399      * load these sequences, coloured by Strand propensity,
 400      * with columns 2-4 hidden
 401      */
 402     SequenceI seq1 = new Sequence("seq1", "MHRSQSSSGG");
 403     SequenceI seq2 = new Sequence("seq2", "MVRSNGGSSS");
 404     AlignmentI al = new Alignment(new SequenceI[] { seq1, seq2 });
 405     AlignFrame af = new AlignFrame(al, 800, 500);
 406     af.changeColour_actionPerformed(JalviewColourScheme.Strand.toString());
 407     ColumnSelection cs = new ColumnSelection();
 408     cs.addElement(2);
 409     cs.addElement(3);
 410     cs.addElement(4);
 411     af.getViewport().setColumnSelection(cs);
 412     af.hideSelColumns_actionPerformed(null);
 413     SequenceRenderer sr = new jalview.gui.SequenceRenderer(
 414             af.getViewport());
 415     SequenceI[][] seqs = new SequenceI[][] { { seq1 }, { seq2 } };
 416     String[] files = new String[] { "seq1.pdb", "seq2.pdb" };
 417     PDBEntry[] pdbFiles = new PDBEntry[2];
 418     pdbFiles[0] = new PDBEntry("PDB1", "A", Type.PDB, "INLINEPDB1");
 419     pdbFiles[1] = new PDBEntry("PDB2", "B", Type.PDB, "INLINEPDB2");
 420     StructureSelectionManager ssm = new StructureSelectionManager();
 421
 422     /*
 423      * map residues 1-10 to residues 21-30 (atoms 105-150) in structures
 424      */
 425     HashMap<Integer, int[]> map = new HashMap<>();
 426     for (int pos = 1; pos <= seq1.getLength(); pos++)
 427     {
 428       map.put(pos, new int[] { 20 + pos, 5 * (20 + pos) });
 429     }
 430     StructureMapping sm1 = new StructureMapping(seq1, "seq1.pdb", "pdb1",
 431             "A", map, null);
 432     ssm.addStructureMapping(sm1);
 433     StructureMapping sm2 = new StructureMapping(seq2, "seq2.pdb", "pdb2",
 434             "B", map, null);
 435     ssm.addStructureMapping(sm2);
 436
 437     AAStructureBindingModel binding = newBindingModel(pdbFiles, seqs, ssm);
 438
 439     /*
 440      * method under test builds a map of structures residues by colour
 441      * verify the map holds what it should
 442      */
 443     Map<Object, AtomSpecModel> colours = binding.buildColoursMap(ssm, files,
 444             seqs, sr, af.alignPanel);
 445     ChimeraCommands helper = new ChimeraCommands();
 446
 447     /*
 448      * M colour is #82827d (see strand.html help page)
 449      * sequence residue 1 mapped to structure residue 21
 450      */
 451     Color mColor = new Color(0x82827d);
 452     AtomSpecModel atomSpec = colours.get(mColor);
 453     assertNotNull(atomSpec);
 454     assertEquals(helper.getAtomSpec(atomSpec, false), "#0:21.A|#1:21.B");
 455
 456     /*
 457      * H colour is #60609f, seq1.2 mapped to structure 0 residue 22
 458      */
 459     Color hColor = new Color(0x60609f);
 460     atomSpec = colours.get(hColor);
 461     assertNotNull(atomSpec);
 462     assertEquals(helper.getAtomSpec(atomSpec, false), "#0:22.A");
 463
 464     /*
 465      * V colour is #ffff00, seq2.2 mapped to structure 1 residue 22
 466      */
 467     Color vColor = new Color(0xffff00);
 468     atomSpec = colours.get(vColor);
 469     assertNotNull(atomSpec);
 470     assertEquals(helper.getAtomSpec(atomSpec, false), "#1:22.B");
 471
 472     /*
 473      * hidden columns are Gray (128, 128, 128)
 474      * sequence positions 3-5 mapped to structure residues 23-25
 475      */
 476     Color gray = new Color(128, 128, 128);
 477     atomSpec = colours.get(gray);
 478     assertNotNull(atomSpec);
 479     assertEquals(helper.getAtomSpec(atomSpec, false), "#0:23-25.A|#1:23-25.B");
 480
 481     /*
 482      * S and G are both coloured #4949b6, structure residues 26-30
 483      */
 484     Color sgColour = new Color(0x4949b6);
 485     atomSpec = colours.get(sgColour);
 486     assertNotNull(atomSpec);
 487     assertEquals(helper.getAtomSpec(atomSpec, false),
 488             "#0:26-30.A|#1:26-30.B");
 489   }
 490 }