test/jalview/ext/rbvi/chimera/ChimeraXCommandsTest.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.ext.rbvi.chimera;
  22
  23 import static org.testng.Assert.assertEquals;
  24 import static org.testng.Assert.assertTrue;
  25
  26 import jalview.datamodel.Alignment;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.ColumnSelection;
  29 import jalview.datamodel.Sequence;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.gui.AlignFrame;
  32 import jalview.gui.SequenceRenderer;
  33 import jalview.schemes.JalviewColourScheme;
  34 import jalview.structure.StructureMapping;
  35 import jalview.structure.StructureSelectionManager;
  36
  37 import java.awt.Color;
  38 import java.util.HashMap;
  39 import java.util.LinkedHashMap;
  40 import java.util.List;
  41 import java.util.Map;
  42
  43 import org.testng.annotations.Test;
  44
  45 public class ChimeraXCommandsTest
  46 {
  47
  48   @Test(groups = { "Functional" })
  49   public void testBuildColourCommands()
  50   {
  51
  52     Map<Object, AtomSpecModel> map = new LinkedHashMap<>();
  53     ChimeraCommands.addAtomSpecRange(map, Color.blue, 0, 2, 5, "A");
  54     ChimeraCommands.addAtomSpecRange(map, Color.blue, 0, 7, 7, "B");
  55     ChimeraCommands.addAtomSpecRange(map, Color.blue, 0, 9, 23, "A");
  56     ChimeraCommands.addAtomSpecRange(map, Color.blue, 1, 1, 1, "A");
  57     ChimeraCommands.addAtomSpecRange(map, Color.blue, 1, 4, 7, "B");
  58     ChimeraCommands.addAtomSpecRange(map, Color.yellow, 1, 8, 8, "A");
  59     ChimeraCommands.addAtomSpecRange(map, Color.yellow, 1, 3, 5, "A");
  60     ChimeraCommands.addAtomSpecRange(map, Color.red, 0, 3, 5, "A");
  61     ChimeraCommands.addAtomSpecRange(map, Color.red, 0, 6, 9, "A");
  62
  63     // Colours should appear in the Chimera command in the order in which
  64     // they were added; within colour, by model, by chain, ranges in start order
  65     String command = new ChimeraXCommands().buildColourCommands(map).get(0);
  66     assertEquals(
  67             command,
  68             "color #0/A:2-5,9-23/B:7|#1/A:1/B:4-7 #0000ff; color #1/A:3-5,8 #ffff00; color #0/A:3-9 #ff0000");
  69   }
  70
  71   @Test(groups = { "Functional" })
  72   public void testBuildSetAttributeCommands()
  73   {
  74     /*
  75      * make a map of { featureType, {featureValue, {residue range specification } } }
  76      */
  77     Map<String, Map<Object, AtomSpecModel>> featuresMap = new LinkedHashMap<>();
  78     Map<Object, AtomSpecModel> featureValues = new HashMap<>();
  79
  80     /*
  81      * start with just one feature/value...
  82      */
  83     featuresMap.put("chain", featureValues);
  84     ChimeraCommands.addAtomSpecRange(featureValues, "X", 0, 8, 20, "A");
  85
  86     ChimeraXCommands commandGenerator = new ChimeraXCommands();
  87     List<String> commands = commandGenerator
  88             .buildSetAttributeCommands(featuresMap);
  89     assertEquals(1, commands.size());
  90
  91     /*
  92      * feature name gets a jv_ namespace prefix
  93      * feature value is quoted in case it contains spaces
  94      */
  95     assertEquals(commands.get(0),
  96             "setattr #0/A:8-20 res jv_chain 'X' create true");
  97
  98     // add same feature value, overlapping range
  99     ChimeraCommands.addAtomSpecRange(featureValues, "X", 0, 3, 9, "A");
 100     // same feature value, contiguous range
 101     ChimeraCommands.addAtomSpecRange(featureValues, "X", 0, 21, 25, "A");
 102     commands = commandGenerator.buildSetAttributeCommands(featuresMap);
 103     assertEquals(1, commands.size());
 104     assertEquals(commands.get(0),
 105             "setattr #0/A:3-25 res jv_chain 'X' create true");
 106
 107     // same feature value and model, different chain
 108     ChimeraCommands.addAtomSpecRange(featureValues, "X", 0, 21, 25, "B");
 109     // same feature value and chain, different model
 110     ChimeraCommands.addAtomSpecRange(featureValues, "X", 1, 26, 30, "A");
 111     commands = commandGenerator.buildSetAttributeCommands(featuresMap);
 112     assertEquals(1, commands.size());
 113     assertEquals(commands.get(0),
 114             "setattr #0/A:3-25/B:21-25|#1/A:26-30 res jv_chain 'X' create true");
 115
 116     // same feature, different value
 117     ChimeraCommands.addAtomSpecRange(featureValues, "Y", 0, 40, 50, "A");
 118     commands = commandGenerator.buildSetAttributeCommands(featuresMap);
 119     assertEquals(2, commands.size());
 120     // commands are ordered by feature type but not by value
 121     // so use contains to test for the expected command:
 122     assertTrue(commands
 123             .contains(
 124                     "setattr #0/A:3-25/B:21-25|#1/A:26-30 res jv_chain 'X' create true"));
 125     assertTrue(commands
 126             .contains("setattr #0/A:40-50 res jv_chain 'Y' create true"));
 127
 128     featuresMap.clear();
 129     featureValues.clear();
 130     featuresMap.put("side-chain binding!", featureValues);
 131     ChimeraCommands.addAtomSpecRange(featureValues,
 132             "<html>metal <a href=\"http:a.b.c/x\"> 'ion!", 0, 7, 15,
 133             "A");
 134     // feature names are sanitised to change non-alphanumeric to underscore
 135     // feature values are sanitised to encode single quote characters
 136     commands = commandGenerator.buildSetAttributeCommands(featuresMap);
 137     assertTrue(commands.contains(
 138             "setattr #0/A:7-15 res jv_side_chain_binding_ '<html>metal <a href=\"http:a.b.c/x\"> &#39;ion!' create true"));
 139   }
 140
 141   @Test(groups = { "Functional" })
 142   public void testColourBySequence_hiddenColumns()
 143   {
 144     /*
 145      * load these sequences, coloured by Strand propensity,
 146      * with columns 2-4 hidden
 147      */
 148     SequenceI seq1 = new Sequence("seq1", "MHRSQSSSGG");
 149     SequenceI seq2 = new Sequence("seq2", "MVRSNGGSSS");
 150     AlignmentI al = new Alignment(new SequenceI[] { seq1, seq2 });
 151     AlignFrame af = new AlignFrame(al, 800, 500);
 152     af.changeColour_actionPerformed(JalviewColourScheme.Strand.toString());
 153     ColumnSelection cs = new ColumnSelection();
 154     cs.addElement(2);
 155     cs.addElement(3);
 156     cs.addElement(4);
 157     af.getViewport().setColumnSelection(cs);
 158     af.hideSelColumns_actionPerformed(null);
 159     SequenceRenderer sr = new SequenceRenderer(af.getViewport());
 160     SequenceI[][] seqs = new SequenceI[][] { { seq1 }, { seq2 } };
 161     String[] files = new String[] { "seq1.pdb", "seq2.pdb" };
 162     StructureSelectionManager ssm = new StructureSelectionManager();
 163
 164     /*
 165      * map residues 1-10 to residues 21-30 (atoms 105-150) in structures
 166      */
 167     HashMap<Integer, int[]> map = new HashMap<>();
 168     for (int pos = 1; pos <= seq1.getLength(); pos++)
 169     {
 170       map.put(pos, new int[] { 20 + pos, 5 * (20 + pos) });
 171     }
 172     StructureMapping sm1 = new StructureMapping(seq1, "seq1.pdb", "pdb1",
 173             "A", map, null);
 174     ssm.addStructureMapping(sm1);
 175     StructureMapping sm2 = new StructureMapping(seq2, "seq2.pdb", "pdb2",
 176             "B", map, null);
 177     ssm.addStructureMapping(sm2);
 178
 179     String[] commands = new ChimeraXCommands()
 180             .colourBySequence(ssm, files, seqs, sr, af.alignPanel);
 181     assertEquals(1, commands.length);
 182     String theCommand = commands[0];
 183     // M colour is #82827d (see strand.html help page)
 184     assertTrue(theCommand.contains("color #0/A:21|#1/B:21 #82827d"));// #0:21.A|#1:21.B"));
 185     // H colour is #60609f
 186     assertTrue(theCommand.contains("color #0/A:22 #60609f"));
 187     // V colour is #ffff00
 188     assertTrue(theCommand.contains("color #1/B:22 #ffff00"));
 189     // hidden columns are Gray (128, 128, 128)
 190     assertTrue(theCommand.contains("color #0/A:23-25|#1/B:23-25"));
 191     // S and G are both coloured #4949b6
 192     assertTrue(theCommand.contains("color #0/A:26-30|#1/B:26-30"));
 193   }
 194 }