*/
package jalview.schemes;
-import jalview.analysis.Conservation;
import jalview.datamodel.AnnotatedCollectionI;
-import jalview.datamodel.ProfilesI;
import jalview.datamodel.SequenceCollectionI;
import jalview.datamodel.SequenceI;
public interface ColourSchemeI
{
/**
- * Returns the fixed colour for the colour scheme. For use when the colour
- * does not vary.
- *
- * @return
- */
- Color findColour();
-
- /**
* Returns the colour for the given character. For use when the colour depends
* only on the symbol.
*
* @param symbol
* @param position
* @param seq
+ * @param consensusResidue
+ * the modal symbol (e.g. K) or symbols (e.g. KF) for the column
+ * @param pid
+ * the percentage identity of the column's consensus (if known)
* @return
*/
- Color findColour(char symbol, int position, SequenceI seq);
-
- /**
- * Assigns the given consensus profile for the colourscheme
- */
- void setConsensus(ProfilesI hconsensus);
-
- /**
- * Assigns the given conservation to the colourscheme
- *
- * @param c
- */
- void setConservation(Conservation c);
-
- /**
- * Enable or disable conservation shading for this colourscheme
- *
- * @param conservationApplied
- */
- void setConservationApplied(boolean conservationApplied);
-
- /**
- * Answers true if conservation shading is enabled for this colourscheme
- *
- * @return
- */
- boolean conservationApplied();
-
- /**
- * Sets the scale factor for bleaching of colour in unconserved regions
- *
- * @param i
- */
- void setConservationInc(int i);
-
- /**
- * Returns the scale factor for bleaching colour in unconserved regions
- *
- * @return
- */
- int getConservationInc();
-
- /**
- * Returns the percentage identity threshold for applying colourscheme
- *
- * @return
- */
- int getThreshold();
-
- /**
- * Sets the percentage identity threshold and type of %age identity
- * calculation for shading
- *
- * @param pct
- * 0..100 percentage identity for applying this colourscheme
- * @param ignoreGaps
- * when true, calculate PID without including gapped positions
- */
- void setThreshold(int pct, boolean ignoreGaps);
+ Color findColour(char symbol, int position, SequenceI seq,
+ String consensusResidue, float pid);
/**
* Recalculate dependent data using the given sequence collection, taking
*/
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;
*/
final int[] symbolIndex;
- boolean conservationColouring = false;
-
/*
* colour for residue characters as indexed by symbolIndex
*/
Color[] colors = null;
/* 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.
*
* ResidueProperties.aaIndex)
* @param colors
* colours for symbols in sequences
- * @param threshold
- * threshold for conservation shading
*/
- public ResidueColourScheme(int[] aaOrnaIndex, Color[] colours,
- int threshold)
+ public ResidueColourScheme(int[] aaOrnaIndex, Color[] colours)
{
symbolIndex = aaOrnaIndex;
this.colors = colours;
- this.threshold = threshold;
}
/**
}
/**
- * 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
return colors == null ? Color.white : colors[symbolIndex[c]];
}
- @Override
- public Color findColour(char c, int j, SequenceI seq)
- {
- Color colour = Color.white;
-
- if (colors != null && symbolIndex != null)
- {
- colour = colors[symbolIndex[c]];
- }
- colour = adjustColour(c, j, colour);
-
- return colour;
- }
-
- /**
- * Adjusts colour by applying thresholding or conservation shading, if in
- * force. That is
- * <ul>
- * <li>if there is a threshold set for colouring, and the residue doesn't
- * match the consensus (or a joint consensus) residue, or the consensus score
- * is not above the threshold, then the colour is set to white</li>
- * <li>if conservation colouring is selected, the colour is faded by an amount
- * depending on the conservation score for the column, and the conservation
- * colour threshold</li>
- * </ul>
- *
- * @param symbol
- * @param column
- * @param colour
- * @return
- */
- protected Color adjustColour(char symbol, int column, Color colour)
- {
- if (!aboveThreshold(symbol, column))
- {
- colour = Color.white;
- }
-
- if (conservationColouring)
- {
- colour = applyConservation(colour, column);
- }
- return colour;
- }
-
/**
- * Get the percentage threshold for this colour scheme
- *
- * @return Returns the percentage threshold
+ * Default is to call the overloaded method that ignores consensus. A colour
+ * scheme that depends on consensus (for example, Blosum62), should override
+ * this method instead.
*/
@Override
- public int getThreshold()
+ public Color findColour(char c, int j, SequenceI seq,
+ String consensusResidue, float pid)
{
- return threshold;
+ return findColour(c, j, seq);
}
- /**
- * 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)
+ protected Color findColour(char c, int j, SequenceI seq)
{
- if (threshold == 0)
- {
- return true;
- }
- 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;
- }
+ Color colour = Color.white;
- if (Comparison.isGap(conservationScore))
+ if (colors != null && symbolIndex != null && c < symbolIndex.length
+ && symbolIndex[c] < colors.length)
{
- return Color.white;
+ colour = colors[symbolIndex[c]];
}
+ // colour = adjustColour(c, j, colour);
- /*
- * 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);
+ return colour;
}
@Override
git://source.jalview.org / jalview.git / commitdiff