src/jalview/io/JnetAnnotationMaker.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.io;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.Annotation;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.util.MessageManager;
  28
  29 public class JnetAnnotationMaker
  30 {
  31   public static void add_annotation(JPredFile prediction, AlignmentI al,
  32           int firstSeq, boolean noMsa) throws Exception
  33   {
  34     JnetAnnotationMaker.add_annotation(prediction, al, firstSeq, noMsa,
  35             (int[]) null);
  36   }
  37
  38   /**
  39    * adds the annotation parsed by prediction to al.
  40    *
  41    * @param prediction
  42    *          JPredFile
  43    * @param al
  44    *          AlignmentI
  45    * @param firstSeq
  46    *          int the index of the sequence to attach the annotation to (usually
  47    *          zero)
  48    * @param noMsa
  49    *          boolean
  50    * @param delMap
  51    *          mapping from columns in JPredFile prediction to residue number in
  52    *          al.getSequence(firstSeq)
  53    */
  54   public static void add_annotation(JPredFile prediction, AlignmentI al,
  55           int firstSeq, boolean noMsa, int[] delMap) throws Exception
  56   {
  57     int i = 0;
  58     SequenceI[] preds = prediction.getSeqsAsArray();
  59     // in the future we could search for the query
  60     // sequence in the alignment before calling this function.
  61     SequenceI seqRef = al.getSequenceAt(firstSeq);
  62     int width = preds[0].getSequence().length;
  63     int[] gapmap = al.getSequenceAt(firstSeq).gapMap();
  64     if ((delMap != null && delMap.length > width)
  65             || (delMap == null && gapmap.length != width))
  66     {
  67       throw (new Exception(
  68               MessageManager
  69                       .formatMessage(
  70                               "exception.number_of_residues_in_query_sequence_differ_from_prediction",
  71                               new String[] {
  72                                   (delMap == null ? "" : MessageManager
  73                                           .getString("label.mapped")),
  74                                   al.getSequenceAt(firstSeq).getName(),
  75                                   al.getSequenceAt(firstSeq)
  76                                           .getSequenceAsString(),
  77                                   Integer.valueOf(width).toString() })));
  78     }
  79
  80     AlignmentAnnotation annot;
  81     Annotation[] annotations = null;
  82
  83     int existingAnnotations = 0;
  84     if (al.getAlignmentAnnotation() != null)
  85     {
  86       existingAnnotations = al.getAlignmentAnnotation().length;
  87     }
  88
  89     Annotation[] sol = new Annotation[al.getWidth()];
  90     boolean firstsol = true;
  91
  92     while (i < preds.length)
  93     {
  94       String id = preds[i].getName().toUpperCase();
  95
  96       if (id.startsWith("LUPAS") || id.startsWith("JNET")
  97               || id.startsWith("JPRED"))
  98       {
  99         if (id.startsWith("JNETSOL"))
 100         {
 101           float amnt = (id.endsWith("25") ? 3f : id.endsWith("5") ? 6f : 9f);
 102           for (int spos = 0; spos < width; spos++)
 103           {
 104             int sposw = (delMap == null) ? gapmap[spos]
 105                     : gapmap[delMap[spos]];
 106             if (firstsol)
 107             {
 108               sol[sposw] = new Annotation(0f);
 109             }
 110             if (preds[i].getCharAt(spos) == 'B'
 111                     && (sol[sposw].value == 0f || sol[sposw].value < amnt))
 112             {
 113               sol[sposw].value = amnt;
 114             }
 115           }
 116           firstsol = false;
 117         }
 118         else
 119         {
 120           // some other kind of annotation
 121           annotations = new Annotation[al.getWidth()];
 122           /*
 123            * if (delMap!=null) { for (int j=0; j<annotations.length; j++)
 124            * annotations[j] = new Annotation("","",'',0); }
 125            */
 126           if (id.equals("JNETPRED") || id.equals("JNETPSSM")
 127                   || id.equals("JNETFREQ") || id.equals("JNETHMM")
 128                   || id.equals("JNETALIGN") || id.equals("JPRED"))
 129           {
 130             if (delMap == null)
 131             {
 132               for (int j = 0; j < width; j++)
 133               {
 134                 annotations[gapmap[j]] = new Annotation("", "",
 135                         preds[i].getCharAt(j), 0);
 136               }
 137             }
 138             else
 139             {
 140               for (int j = 0; j < width; j++)
 141               {
 142                 annotations[gapmap[delMap[j]]] = new Annotation("", "",
 143                         preds[i].getCharAt(j), 0);
 144               }
 145             }
 146           }
 147           else if (id.equals("JNETCONF"))
 148           {
 149             if (delMap == null)
 150             {
 151               for (int j = 0; j < width; j++)
 152               {
 153                 float value = new Float(preds[i].getCharAt(j) + "")
 154                         .floatValue();
 155                 annotations[gapmap[j]] = new Annotation(
 156                         preds[i].getCharAt(j) + "", "",
 157                         preds[i].getCharAt(j), value);
 158               }
 159             }
 160             else
 161             {
 162               for (int j = 0; j < width; j++)
 163               {
 164                 float value = new Float(preds[i].getCharAt(j) + "")
 165                         .floatValue();
 166                 annotations[gapmap[delMap[j]]] = new Annotation(
 167                         preds[i].getCharAt(j) + "", "",
 168                         preds[i].getCharAt(j), value);
 169               }
 170             }
 171           }
 172           else
 173           {
 174             if (delMap == null)
 175             {
 176               for (int j = 0; j < width; j++)
 177               {
 178                 annotations[gapmap[j]] = new Annotation(
 179                         preds[i].getCharAt(j) + "", "", ' ', 0);
 180               }
 181             }
 182             else
 183             {
 184               for (int j = 0; j < width; j++)
 185               {
 186                 annotations[gapmap[delMap[j]]] = new Annotation(
 187                         preds[i].getCharAt(j) + "", "", ' ', 0);
 188               }
 189             }
 190           }
 191
 192           if (id.equals("JNETCONF"))
 193           {
 194             annot = new AlignmentAnnotation(preds[i].getName(),
 195                     "JNet Output", annotations, 0f, 10f,
 196                     AlignmentAnnotation.BAR_GRAPH);
 197           }
 198           else
 199           {
 200             annot = new AlignmentAnnotation(preds[i].getName(),
 201                     "JNet Output", annotations);
 202           }
 203
 204           if (seqRef != null)
 205           {
 206             annot.createSequenceMapping(seqRef, 1, true);
 207             seqRef.addAlignmentAnnotation(annot);
 208           }
 209
 210           al.addAnnotation(annot);
 211           al.setAnnotationIndex(annot, al.getAlignmentAnnotation().length
 212                   - existingAnnotations - 1);
 213         }
 214         if (noMsa)
 215         {
 216           al.deleteSequence(preds[i]);
 217         }
 218       }
 219
 220       i++;
 221     }
 222     if (!firstsol)
 223     {
 224       // add the solvent accessibility
 225       annot = new AlignmentAnnotation(
 226               "Jnet Burial",
 227               "<html>Prediction of Solvent Accessibility<br/>levels are<ul><li>0 - Exposed</li><li>3 - 25% or more S.A. accessible</li><li>6 - 5% or more S.A. accessible</li><li>9 - Buried (<5% exposed)</li></ul>",
 228               sol, 0f, 9f, AlignmentAnnotation.BAR_GRAPH);
 229
 230       annot.validateRangeAndDisplay();
 231       if (seqRef != null)
 232       {
 233         annot.createSequenceMapping(seqRef, 1, true);
 234         seqRef.addAlignmentAnnotation(annot);
 235       }
 236       al.addAnnotation(annot);
 237       al.setAnnotationIndex(annot, al.getAlignmentAnnotation().length
 238               - existingAnnotations - 1);
 239     }
 240     // Hashtable scores = prediction.getScores();
 241
 242     /*
 243      * addFloatAnnotations(al, gapmap, (Vector)scores.get("JNETPROPH"),
 244      * "JnetpropH", "Jnet Helix Propensity", 0f,1f,1);
 245      *
 246      * addFloatAnnotations(al, gapmap, (Vector)scores.get("JNETPROPB"),
 247      * "JnetpropB", "Jnet Beta Sheet Propensity", 0f,1f,1);
 248      *
 249      * addFloatAnnotations(al, gapmap, (Vector)scores.get("JNETPROPC"),
 250      * "JnetpropC", "Jnet Coil Propensity", 0f,1f,1);
 251      */
 252
 253   }
 254 }