src/jalview/schemes/TCoffeeColourScheme.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.schemes;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.AnnotatedCollectionI;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.SequenceCollectionI;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.io.TCoffeeScoreFile;
  30
  31 import java.awt.Color;
  32 import java.util.ArrayList;
  33 import java.util.IdentityHashMap;
  34 import java.util.Map;
  35
  36 /**
  37  * Defines the color score for T-Coffee MSA
  38  * <p>
  39  * See http://tcoffee.org
  40  *
  41  *
  42  * @author Paolo Di Tommaso
  43  *
  44  */
  45 public class TCoffeeColourScheme extends ResidueColourScheme
  46 {
  47
  48   static final Color[] colors = { new Color(102, 102, 255), // #6666FF
  49       new Color(0, 255, 0), // #00FF00
  50       new Color(102, 255, 0), // #66FF00
  51       new Color(204, 255, 0), // #CCFF00
  52       new Color(255, 255, 0), // #FFFF00
  53       new Color(255, 204, 0), // #FFCC00
  54       new Color(255, 153, 0), // #FF9900
  55       new Color(255, 102, 0), // #FF6600
  56       new Color(255, 51, 0), // #FF3300
  57       new Color(255, 34, 0) // #FF2000
  58   };
  59
  60   IdentityHashMap<SequenceI, Color[]> seqMap;
  61
  62   /**
  63    * the color scheme needs to look at the alignment to get and cache T-COFFEE
  64    * scores
  65    *
  66    * @param alignment
  67    *          - annotated sequences to be searched
  68    */
  69   public TCoffeeColourScheme(AnnotatedCollectionI alignment)
  70   {
  71     alignmentChanged(alignment, null);
  72   }
  73
  74   @Override
  75   public void alignmentChanged(AnnotatedCollectionI alignment,
  76           Map<SequenceI, SequenceCollectionI> hiddenReps)
  77   {
  78     // TODO: if sequences have been represented and they have scores, could
  79     // compute an average sequence score for the representative
  80
  81     // assume only one set of TCOFFEE scores - but could have more than one
  82     // potentially.
  83     ArrayList<AlignmentAnnotation> annots = new ArrayList<AlignmentAnnotation>();
  84     // Search alignment to get all tcoffee annotation and pick one set of
  85     // annotation to use to colour seqs.
  86     seqMap = new IdentityHashMap<SequenceI, Color[]>();
  87     AnnotatedCollectionI alcontext = alignment instanceof AlignmentI ? alignment
  88             : alignment.getContext();
  89     if (alcontext == null)
  90     {
  91       return;
  92     }
  93     int w = 0;
  94     for (AlignmentAnnotation al : alcontext
  95             .findAnnotation(TCoffeeScoreFile.TCOFFEE_SCORE))
  96     {
  97       if (al.sequenceRef != null && !al.belowAlignment)
  98       {
  99         annots.add(al);
 100         if (w < al.annotations.length)
 101         {
 102           w = al.annotations.length;
 103         }
 104         Color[] scores = new Color[al.annotations.length];
 105         int i = 0;
 106         for (Annotation an : al.annotations)
 107         {
 108           scores[i++] = (an != null) ? an.colour : Color.white;
 109         }
 110         seqMap.put(al.sequenceRef, scores);
 111       }
 112     }
 113     // TODO: compute average colour for each symbol type in each column - gives
 114     // a second order colourscheme for colouring a sequence logo derived from
 115     // the alignment (colour reflects quality of alignment for each residue
 116     // class)
 117   }
 118
 119   @Override
 120   public Color findColour(char c, int j, SequenceI seq)
 121   {
 122     Color[] cols;
 123
 124     if (seqMap == null || (cols = seqMap.get(seq)) == null)
 125     {
 126       // see above TODO about computing a colour for each residue in each
 127       // column: cc = _rcols[i][indexFor[c]];
 128       return Color.white;
 129     }
 130
 131     if (j < 0 || j >= cols.length)
 132     {
 133       return Color.white;
 134     }
 135     return cols[j];
 136   }
 137
 138   @Override
 139   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
 140           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
 141   {
 142     return new TCoffeeColourScheme(sg);
 143   }
 144 }