X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FBinarySequence.java;h=ed57dce238e1b650cc883daf8ff073cda3b744ab;hb=37de9310bec3501cbc6381e0c3dcb282fcaad812;hp=af10e1d180a37114726ace7c78888867c4f25d5c;hpb=c3c305755d392741176209a0274a47897ac4d8a8;p=jalview.git diff --git a/src/jalview/datamodel/BinarySequence.java b/src/jalview/datamodel/BinarySequence.java index af10e1d..ed57dce 100755 --- a/src/jalview/datamodel/BinarySequence.java +++ b/src/jalview/datamodel/BinarySequence.java @@ -1,154 +1,203 @@ -/* -* Jalview - A Sequence Alignment Editor and Viewer -* Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle -* -* This program 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 2 -* of the License, or (at your option) any later version. -* -* This program 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 this program; if not, write to the Free Software -* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA -*/ -package jalview.datamodel; - -import jalview.schemes.*; - - - -/** - * DOCUMENT ME! - * - * @author $author$ - * @version $Revision$ - */ -public class BinarySequence extends Sequence -{ - int[] binary; - double[] dbinary; - - /** - * Creates a new BinarySequence object. - * - * @param s DOCUMENT ME! - */ - public BinarySequence(String s) - { - super("", s, 0, s.length()); - } - - /** - * DOCUMENT ME! - */ - public void encode() - { - // Set all matrix to 0 - dbinary = new double[getSequence().length() * 21]; - - int nores = 21; - - for (int i = 0; i < dbinary.length; i++) - { - dbinary[i] = 0.0; - } - - for (int i = 0; i < getSequence().length(); i++) - { - int aanum = 20; - - try - { - aanum = ResidueProperties.aaIndex[getSequence().charAt(i)]; - } - catch (NullPointerException e) - { - aanum = 20; - } - - if (aanum > 20) - { - aanum = 20; - } - - dbinary[(i * nores) + aanum] = 1.0; - } - } - - /** - * DOCUMENT ME! - */ - public void blosumEncode() - { - // Set all matrix to 0 - dbinary = new double[getSequence().length() * 21]; - - int nores = 21; - - //for (int i = 0; i < dbinary.length; i++) { - // dbinary[i] = 0.0; - //} - for (int i = 0; i < getSequence().length(); i++) - { - int aanum = 20; - - try - { - aanum = ResidueProperties.aaIndex[getSequence().charAt(i)]; - } - catch (NullPointerException e) - { - aanum = 20; - } - - if (aanum > 20) - { - aanum = 20; - } - - // Do the blosum thing - for (int j = 0; j < 20; j++) - { - dbinary[(i * nores) + j] = ResidueProperties.getBLOSUM62()[aanum][j]; - } - } - } - - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public String toBinaryString() - { - String out = ""; - - for (int i = 0; i < binary.length; i++) - { - out += (new Integer(binary[i])).toString(); - - if (i < (binary.length - 1)) - { - out += " "; - } - } - - return out; - } - - /** - * DOCUMENT ME! - * - * @return DOCUMENT ME! - */ - public double[] getDBinary() - { - return dbinary; - } - -} +/* + * 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 . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ +package jalview.datamodel; + +import jalview.schemes.ResidueProperties; +import jalview.schemes.ScoreMatrix; + +/** + * Encode a sequence as a numeric vector using either classic residue binary + * encoding or convolved with residue substitution matrix. + * + * @author $author$ + * @version $Revision$ + */ +public class BinarySequence extends Sequence +{ + public class InvalidSequenceTypeException extends Exception + { + + public InvalidSequenceTypeException(String string) + { + super(string); + } + + } + + int[] binary; + + double[] dbinary; + + boolean isNa = false; + + /** + * Creates a new BinarySequence object. + * + * @param s + * DOCUMENT ME! + */ + public BinarySequence(String s, boolean isNa) + { + super("", s, 0, s.length()); + this.isNa = isNa; + } + + /** + * clear the dbinary matrix + * + * @return nores - dimension of sequence symbol encoding for this sequence + */ + private int initMatrixGetNoRes() + { + int nores = (isNa) ? ResidueProperties.maxNucleotideIndex + : ResidueProperties.maxProteinIndex; + // Set all matrix to 0 + dbinary = new double[getSequence().length * nores]; + + for (int i = 0; i < dbinary.length; i++) + { + dbinary[i] = 0.0; + } + return nores; + } + + private int[] getSymbolmatrix() + { + return (isNa) ? ResidueProperties.nucleotideIndex + : ResidueProperties.aaIndex; + } + + /** + * DOCUMENT ME! + */ + public void encode() + { + int nores = initMatrixGetNoRes(); + final int[] sindex = getSymbolmatrix(); + for (int i = 0; i < getSequence().length; i++) + { + int aanum = nores - 1; + + try + { + aanum = sindex[getCharAt(i)]; + } catch (NullPointerException e) + { + aanum = nores - 1; + } + + if (aanum >= nores) + { + aanum = nores - 1; + } + + dbinary[(i * nores) + aanum] = 1.0; + } + } + + /** + * ancode using substitution matrix given in matrix + * + * @param matrix + */ + public void matrixEncode(final ScoreMatrix matrix) + throws InvalidSequenceTypeException + { + if (isNa != matrix.isDNA()) + { + throw new InvalidSequenceTypeException("matrix " + + matrix.getClass().getCanonicalName() + + " is not a valid matrix for " + + (isNa ? "nucleotide" : "protein") + "sequences"); + } + matrixEncode(matrix.isDNA() ? ResidueProperties.nucleotideIndex + : ResidueProperties.aaIndex, matrix.getMatrix()); + } + + private void matrixEncode(final int[] aaIndex, final int[][] matrix) + { + // Set all matrix to 0 + // dbinary = new double[getSequence().length * 21]; + + int nores = initMatrixGetNoRes(); + + // for (int i = 0; i < dbinary.length; i++) { + // dbinary[i] = 0.0; + // } + for (int i = 0, iSize = getSequence().length; i < iSize; i++) + { + int aanum = nores - 1; + + try + { + aanum = aaIndex[getCharAt(i)]; + } catch (NullPointerException e) + { + aanum = nores - 1; + } + + if (aanum >= nores) + { + aanum = nores - 1; + } + + // Do the blosum^H^H^H^H^H score matrix summation thing + + for (int j = 0; j < nores; j++) + { + dbinary[(i * nores) + j] = matrix[aanum][j]; + } + } + } + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ + public String toBinaryString() + { + String out = ""; + + for (int i = 0; i < binary.length; i++) + { + out += (new Integer(binary[i])).toString(); + + if (i < (binary.length - 1)) + { + out += " "; + } + } + + return out; + } + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ + public double[] getDBinary() + { + return dbinary; + } + +}