-package jalview.schemes;\r
-\r
-import jalview.datamodel.*;\r
-import java.util.*;\r
-import java.awt.*;\r
-\r
-public class ResidueColourScheme implements ColourSchemeI {\r
- Color [] colors;\r
- int threshold = 90;\r
-\r
- public ResidueColourScheme(Color[] colors, int threshold) {\r
- this.colors = colors;\r
- this.threshold = threshold;\r
- }\r
-\r
- public ResidueColourScheme() {\r
- }\r
-\r
- public Color findColour(String aa)\r
- {\r
- return colors[((Integer)(ResidueProperties.aaHash.get(aa))).intValue()];\r
- }\r
-\r
- public Color findColour(SequenceI seq,String s, int j, Vector aa) {\r
- try {\r
- return colors[((Integer)(ResidueProperties.aaHash.get(s))).intValue()];\r
- } catch (Exception e) {\r
- return Color.white;\r
- }\r
- }\r
-\r
- // aa should maybe be a class\r
- public Color getColour(SequenceI seq, int j,Vector aa) {\r
-\r
- Color c = Color.white;\r
- String s = seq.getSequence(j,j+1);\r
-\r
- if (threshold > 0 && aa != null)\r
- {\r
- if (aboveThreshold(aa,seq,j,threshold))\r
- c = findColour(seq,s,j,aa);\r
- }\r
- else\r
- c = findColour(seq,s,j,aa);\r
-\r
-\r
- return c;\r
- }\r
- public int getThreshold() {\r
- return threshold;\r
- }\r
-\r
- public void setThreshold(int ct) {\r
- threshold = ct;\r
- }\r
-\r
- public Vector getColours(SequenceI s, Vector aa) {\r
- Vector colours = new Vector();\r
-\r
- for (int j = 0; j < s.getLength(); j++)\r
- colours.addElement(getColour(s,j,aa));\r
-\r
- return colours;\r
- }\r
-\r
- public Vector getColours(SequenceGroup sg, Vector aa) {\r
- Vector colours = new Vector();\r
-\r
- for (int j = 0; j < sg.getSize(); j++) {\r
- SequenceI s = sg.getSequenceAt(j);\r
-\r
- for (int i = 0; i < s.getLength();i++) {\r
- colours.addElement(getColour(s,i,aa));\r
- }\r
- }\r
- return colours;\r
- }\r
-\r
- public boolean aboveThreshold(Vector aa,SequenceI seq, int j, int threshold) {\r
- String s = seq.getSequence(j,j+1);\r
- Hashtable hash = (Hashtable)aa.elementAt(j);\r
-\r
- if (j < aa.size()) {\r
- String maxRes = (String)hash.get("maxResidue");\r
-\r
- double sc = 0;\r
-\r
- if (((Integer)hash.get("maxCount")).intValue() != -1 && hash.contains(s)) {\r
- int maxCount = ((Integer)hash.get("maxCount")).intValue();\r
- int resCount = ((Integer)hash.get(s)).intValue();\r
-\r
- sc = resCount * 100.0 / resCount;\r
-\r
- // This should be isGap somewhere\r
- if ( !s.equals("-") && !s.equals(".") && !s.equals(" ")) {\r
- if (sc >= (double)threshold) {\r
- return true;\r
- }\r
- }\r
- }\r
- }\r
- return false;\r
- }\r
-\r
- public boolean canThreshold() {\r
- return true;\r
- }\r
- public boolean isUserDefinable() {\r
- return false;\r
- }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.schemes;
+
+import jalview.analysis.Conservation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.AnnotatedCollectionI;
+import jalview.datamodel.ProfileI;
+import jalview.datamodel.ProfilesI;
+import jalview.datamodel.SequenceCollectionI;
+import jalview.datamodel.SequenceI;
+import jalview.util.ColorUtils;
+import jalview.util.Comparison;
+
+import java.awt.Color;
+import java.util.Map;
+
+/**
+ * Base class for residue-based colour schemes
+ */
+public abstract class ResidueColourScheme implements ColourSchemeI
+{
+ public static final String NONE = "None";
+
+ /*
+ * lookup up by character value e.g. 'G' to the colors array index
+ * e.g. if symbolIndex['K'] = 11 then colors[11] is the colour for K
+ */
+ final int[] symbolIndex;
+
+ boolean conservationColouring = false;
+
+ /*
+ * colour for residue characters as indexed by symbolIndex
+ */
+ Color[] colors = null;
+
+ int threshold = 0;
+
+ /* Set when threshold colouring to either pid_gaps or pid_nogaps */
+ protected boolean ignoreGaps = false;
+
+ /*
+ * Consensus data indexed by column
+ */
+ ProfilesI consensus;
+
+ /*
+ * Conservation string as a char array
+ */
+ char[] conservation;
+
+ /*
+ * The conservation slider percentage setting
+ */
+ int inc = 30;
+
+ /**
+ * Creates a new ResidueColourScheme object.
+ *
+ * @param final int[] index table into colors (ResidueProperties.naIndex or
+ * ResidueProperties.aaIndex)
+ * @param colors
+ * colours for symbols in sequences
+ * @param threshold
+ * threshold for conservation shading
+ */
+ public ResidueColourScheme(int[] aaOrnaIndex, Color[] colours,
+ int threshold)
+ {
+ symbolIndex = aaOrnaIndex;
+ this.colors = colours;
+ this.threshold = threshold;
+ }
+
+ /**
+ * Creates a new ResidueColourScheme object with a lookup table for indexing
+ * the colour map
+ */
+ public ResidueColourScheme(int[] aaOrNaIndex)
+ {
+ symbolIndex = aaOrNaIndex;
+ }
+
+ /**
+ * Creates a new ResidueColourScheme object - default constructor for
+ * non-sequence dependent colourschemes
+ */
+ public ResidueColourScheme()
+ {
+ symbolIndex = null;
+ }
+
+ /**
+ * Returns the colour for symbol 'A'. Intended for use in a 'fixed colour'
+ * colour scheme (for example a feature colour).
+ */
+ @Override
+ public Color findColour()
+ {
+ // TODO delete this method in favour of ColorUtils.parseColourString()?
+ return findColour('A');
+ }
+
+ /**
+ * Find a colour without an index in a sequence
+ */
+ @Override
+ public Color findColour(char c)
+ {
+ return colors == null ? Color.white : colors[symbolIndex[c]];
+ }
+
+ @Override
+ public Color findColour(char c, int j, SequenceI seq)
+ {
+ Color currentColour;
+
+ if (colors != null && symbolIndex != null && (threshold == 0)
+ || aboveThreshold(c, j))
+ {
+ currentColour = colors[symbolIndex[c]];
+ }
+ else
+ {
+ currentColour = Color.white;
+ }
+
+ if (conservationColouring)
+ {
+ currentColour = applyConservation(currentColour, j);
+ }
+
+ return currentColour;
+ }
+
+ /**
+ * Get the percentage threshold for this colour scheme
+ *
+ * @return Returns the percentage threshold
+ */
+ @Override
+ public int getThreshold()
+ {
+ return threshold;
+ }
+
+ /**
+ * Sets the percentage consensus threshold value, and whether gaps are ignored
+ * in percentage identity calculation
+ *
+ * @param consensusThreshold
+ * @param ignoreGaps
+ */
+ @Override
+ public void setThreshold(int consensusThreshold, boolean ignoreGaps)
+ {
+ threshold = consensusThreshold;
+ this.ignoreGaps = ignoreGaps;
+ }
+
+ /**
+ * Answers true if there is a consensus profile for the specified column, and
+ * the given residue matches the consensus (or joint consensus) residue for
+ * the column, and the percentage identity for the profile is equal to or
+ * greater than the current threshold; else answers false. The percentage
+ * calculation depends on whether or not we are ignoring gapped sequences.
+ *
+ * @param residue
+ * @param column
+ * (index into consensus profiles)
+ *
+ * @return
+ * @see #setThreshold(int, boolean)
+ */
+ public boolean aboveThreshold(char residue, int column)
+ {
+ if ('a' <= residue && residue <= 'z')
+ {
+ // TO UPPERCASE !!!
+ // Faster than toUpperCase
+ residue -= ('a' - 'A');
+ }
+
+ if (consensus == null)
+ {
+ return false;
+ }
+
+ ProfileI profile = consensus.get(column);
+
+ /*
+ * test whether this is the consensus (or joint consensus) residue
+ */
+ if (profile != null
+ && profile.getModalResidue().contains(String.valueOf(residue)))
+ {
+ if (profile.getPercentageIdentity(ignoreGaps) >= threshold)
+ {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ @Override
+ public boolean conservationApplied()
+ {
+ return conservationColouring;
+ }
+
+ @Override
+ public void setConservationApplied(boolean conservationApplied)
+ {
+ conservationColouring = conservationApplied;
+ }
+
+ @Override
+ public void setConservationInc(int i)
+ {
+ inc = i;
+ }
+
+ @Override
+ public int getConservationInc()
+ {
+ return inc;
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @param consensus
+ * DOCUMENT ME!
+ */
+ @Override
+ public void setConsensus(ProfilesI consensus)
+ {
+ if (consensus == null)
+ {
+ return;
+ }
+
+ this.consensus = consensus;
+ }
+
+ @Override
+ public void setConservation(Conservation cons)
+ {
+ if (cons == null)
+ {
+ conservationColouring = false;
+ conservation = null;
+ }
+ else
+ {
+ conservationColouring = true;
+ int iSize = cons.getConsSequence().getLength();
+ conservation = new char[iSize];
+ for (int i = 0; i < iSize; i++)
+ {
+ conservation[i] = cons.getConsSequence().getCharAt(i);
+ }
+ }
+
+ }
+
+ /**
+ * Applies a combination of column conservation score, and conservation
+ * percentage slider, to 'bleach' out the residue colours towards white.
+ * <p>
+ * If a column is fully conserved (identical residues, conservation score 11,
+ * shown as *), or all 10 physico-chemical properties are conserved
+ * (conservation score 10, shown as +), then the colour is left unchanged.
+ * <p>
+ * Otherwise a 'bleaching' factor is computed and applied to the colour. This
+ * is designed to fade colours for scores of 0-9 completely to white at slider
+ * positions ranging from 18% - 100% respectively.
+ *
+ * @param currentColour
+ * @param column
+ *
+ * @return bleached (or unmodified) colour
+ */
+ Color applyConservation(Color currentColour, int column)
+ {
+ if (conservation == null || conservation.length <= column)
+ {
+ return currentColour;
+ }
+ char conservationScore = conservation[column];
+
+ /*
+ * if residues are fully conserved (* or 11), or all properties
+ * are conserved (+ or 10), leave colour unchanged
+ */
+ if (conservationScore == '*' || conservationScore == '+'
+ || conservationScore == (char) 10
+ || conservationScore == (char) 11)
+ {
+ return currentColour;
+ }
+
+ if (Comparison.isGap(conservationScore))
+ {
+ return Color.white;
+ }
+
+ /*
+ * convert score 0-9 to a bleaching factor 1.1 - 0.2
+ */
+ float bleachFactor = (11 - (conservationScore - '0')) / 10f;
+
+ /*
+ * scale this up by 0-5 (percentage slider / 20)
+ * as a result, scores of: 0 1 2 3 4 5 6 7 8 9
+ * fade to white at slider value: 18 20 22 25 29 33 40 50 67 100%
+ */
+ bleachFactor *= (inc / 20f);
+
+ return ColorUtils.bleachColour(currentColour, bleachFactor);
+ }
+
+ @Override
+ public void alignmentChanged(AnnotatedCollectionI alignment,
+ Map<SequenceI, SequenceCollectionI> hiddenReps)
+ {
+ }
+
+ /**
+ * Answers false if the colour scheme is nucleotide or peptide specific, and
+ * the data does not match, else true. Override to modify or extend this test
+ * as required.
+ */
+ @Override
+ public boolean isApplicableTo(AnnotatedCollectionI ac)
+ {
+ if (!isPeptideSpecific() && !isNucleotideSpecific())
+ {
+ return true;
+ }
+
+ /*
+ * inspect the data context (alignment dataset) for residue type
+ */
+ boolean nucleotide = false;
+ AnnotatedCollectionI context = ac.getContext();
+ if (context != null)
+ {
+ if (context instanceof AlignmentI)
+ {
+ nucleotide = ((AlignmentI) context).isNucleotide();
+ }
+ else
+ {
+ // not sure what's going on, play safe
+ return true;
+ }
+ }
+ else if (ac instanceof AlignmentI)
+ {
+ nucleotide = ((AlignmentI) ac).isNucleotide();
+ }
+ else
+ {
+ return true;
+ }
+
+ /*
+ * does data type match colour scheme type?
+ */
+ return (nucleotide && isNucleotideSpecific())
+ || (!nucleotide && isPeptideSpecific());
+ }
+
+ /**
+ * Answers true if the colour scheme is normally only for peptide data
+ *
+ * @return
+ */
+ public boolean isPeptideSpecific()
+ {
+ return false;
+ }
+
+ /**
+ * Answers true if the colour scheme is normally only for nucleotide data
+ *
+ * @return
+ */
+ public boolean isNucleotideSpecific()
+ {
+ return false;
+ }
+}
git://source.jalview.org / jalview.git / blobdiff