*/
package jalview.schemes;
-import jalview.analysis.Conservation;
-import jalview.analysis.Profile;
+import jalview.datamodel.AlignmentI;
import jalview.datamodel.AnnotatedCollectionI;
import jalview.datamodel.SequenceCollectionI;
import jalview.datamodel.SequenceI;
-import jalview.util.MessageManager;
import java.awt.Color;
import java.util.Map;
/**
- * DOCUMENT ME!
- *
- * @author $author$
- * @version $Revision$
+ * Base class for residue-based colour schemes
*/
-public class ResidueColourScheme implements ColourSchemeI
+public abstract class ResidueColourScheme implements ColourSchemeI
{
- final int[] symbolIndex;
+ public static final String NONE = "None";
- boolean conservationColouring = false;
-
- Color[] colors = null;
-
- int threshold = 0;
-
- /* Set when threshold colouring to either pid_gaps or pid_nogaps */
- protected boolean ignoreGaps = false;
+ public static final String USER_DEFINED = "User Defined";
/*
- * Consensus data indexed by column
+ * 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
*/
- Profile[] consensus;
+ final int[] symbolIndex;
/*
- * Conservation string as a char array
+ * colour for residue characters as indexed by symbolIndex
*/
- char[] conservation;
-
- int conservationLength = 0;
+ Color[] colors = null;
- /** DOCUMENT ME!! */
- int inc = 30;
+ /* Set when threshold colouring to either pid_gaps or pid_nogaps */
+ protected boolean ignoreGaps = false;
/**
* 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;
}
/**
}
/**
- * Find a colour without an index in a sequence
+ * Returns the colour for symbol 'A'. Intended for use in a 'fixed colour'
+ * colour scheme (for example a feature colour).
*/
@Override
- public Color findColour(char c)
- {
- return colors == null ? Color.white : colors[symbolIndex[c]];
- }
-
- @Override
- public Color findColour(char c, int j, SequenceI seq)
+ public Color findColour()
{
- 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;
+ // TODO delete this method in favour of ColorUtils.parseColourString()?
+ return findColour('A');
}
/**
- * Get the percentage threshold for this colour scheme
- *
- * @return Returns the percentage threshold
+ * Find a colour without an index in a sequence
*/
@Override
- public int getThreshold()
+ public Color findColour(char c)
{
- return threshold;
+ return colors == null ? Color.white : colors[symbolIndex[c]];
}
/**
- * DOCUMENT ME!
- *
- * @param ct
- * DOCUMENT ME!
+ * 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 void setThreshold(int ct, boolean ignoreGaps)
+ public Color findColour(char c, int j, SequenceI seq,
+ String consensusResidue, float pid)
{
- threshold = ct;
- this.ignoreGaps = ignoreGaps;
+ return findColour(c, j, seq);
}
- /**
- * DOCUMENT ME!
- *
- * @param s
- * DOCUMENT ME!
- * @param j
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public boolean aboveThreshold(char c, int j)
+ protected Color findColour(char c, int j, SequenceI seq)
{
- if ('a' <= c && c <= 'z')
- {
- // TO UPPERCASE !!!
- // Faster than toUpperCase
- c -= ('a' - 'A');
- }
-
- if (consensus == null || consensus.length < j || consensus[j] == null)
- {
- return false;
- }
+ Color colour = Color.white;
- if (consensus[j].getMaxCount() > 0) // != -1))
+ if (colors != null && symbolIndex != null && c < symbolIndex.length
+ && symbolIndex[c] < colors.length)
{
- if (consensus[j].getPercentageIdentity(ignoreGaps) >= threshold)
- {
- return true;
- }
+ colour = colors[symbolIndex[c]];
}
+ // colour = adjustColour(c, j, colour);
- return false;
+ return colour;
}
@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()
+ public void alignmentChanged(AnnotatedCollectionI alignment,
+ Map<SequenceI, SequenceCollectionI> hiddenReps)
{
- return inc;
}
/**
- * DOCUMENT ME!
- *
- * @param consensus
- * DOCUMENT ME!
+ * 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 void setConsensus(Profile[] consensus)
+ public boolean isApplicableTo(AnnotatedCollectionI ac)
{
- if (consensus == null)
+ if (!isPeptideSpecific() && !isNucleotideSpecific())
{
- return;
+ return true;
}
- this.consensus = consensus;
- }
-
- @Override
- public void setConservation(Conservation cons)
- {
- if (cons == null)
+ /*
+ * inspect the data context (alignment) for residue type
+ */
+ boolean nucleotide = false;
+ if (ac instanceof AlignmentI)
{
- conservationColouring = false;
- conservation = null;
+ nucleotide = ((AlignmentI) ac).isNucleotide();
}
else
{
- conservationColouring = true;
- int i, iSize = cons.getConsSequence().getLength();
- conservation = new char[iSize];
- for (i = 0; i < iSize; i++)
+ AnnotatedCollectionI context = ac.getContext();
+ if (context instanceof AlignmentI)
+ {
+ nucleotide = ((AlignmentI) context).isNucleotide();
+ }
+ else
{
- conservation[i] = cons.getConsSequence().getCharAt(i);
+ // not sure what's going on, play safe
+ return true;
}
- conservationLength = conservation.length;
}
+ /*
+ * does data type match colour scheme type?
+ */
+ return (nucleotide && isNucleotideSpecific())
+ || (!nucleotide && isPeptideSpecific());
}
/**
- * DOCUMENT ME!
- *
- * @param s
- * DOCUMENT ME!
- * @param i
- * DOCUMENT ME!
+ * Answers true if the colour scheme is normally only for peptide data
*
- * @return DOCUMENT ME!
+ * @return
*/
-
- Color applyConservation(Color currentColour, int i)
+ public boolean isPeptideSpecific()
{
-
- if ((conservationLength > i) && (conservation[i] != '*')
- && (conservation[i] != '+'))
- {
- if (jalview.util.Comparison.isGap(conservation[i]))
- {
- currentColour = Color.white;
- }
- else
- {
- float t = 11 - (conservation[i] - '0');
- if (t == 0)
- {
- return Color.white;
- }
-
- int red = currentColour.getRed();
- int green = currentColour.getGreen();
- int blue = currentColour.getBlue();
-
- int dr = 255 - red;
- int dg = 255 - green;
- int db = 255 - blue;
-
- dr *= t / 10f;
- dg *= t / 10f;
- db *= t / 10f;
-
- red += (inc / 20f) * dr;
- green += (inc / 20f) * dg;
- blue += (inc / 20f) * db;
-
- if (red > 255 || green > 255 || blue > 255)
- {
- currentColour = Color.white;
- }
- else
- {
- currentColour = new Color(red, green, blue);
- }
- }
- }
- return currentColour;
+ return false;
}
- @Override
- public void alignmentChanged(AnnotatedCollectionI alignment,
- Map<SequenceI, SequenceCollectionI> hiddenReps)
+ /**
+ * Answers true if the colour scheme is normally only for nucleotide data
+ *
+ * @return
+ */
+ public boolean isNucleotideSpecific()
{
+ return false;
}
+ /**
+ * Default method returns true. Override this to return false in colour
+ * schemes that are not determined solely by the sequence symbol.
+ */
@Override
- public ColourSchemeI applyTo(AnnotatedCollectionI sg,
- Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
+ public boolean isSimple()
{
- try
- {
- return getClass().newInstance();
- } catch (Exception q)
- {
- throw new Error(MessageManager.formatMessage(
- "error.implementation_error_cannot_duplicate_colour_scheme",
- new String[] { getClass().getName() }), q);
- }
+ return true;
}
}