src/MCview/PDBChain.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package MCview;
  19
  20 import java.util.*;
  21
  22 import java.awt.*;
  23
  24 import jalview.analysis.*;
  25 import jalview.datamodel.*;
  26 import jalview.schemes.*;
  27 import jalview.structure.StructureMapping;
  28
  29 public class PDBChain
  30 {
  31   /**
  32    * SequenceFeature group for PDB File features added to sequences
  33    */
  34   private static final String PDBFILEFEATURE = "PDBFile";
  35
  36   private static final String IEASTATUS = "IEA:jalview";
  37
  38   public String id;
  39
  40   public Vector bonds = new Vector();
  41
  42   public Vector atoms = new Vector();
  43
  44   public Vector residues = new Vector();
  45
  46   public int offset;
  47
  48   public Sequence sequence;
  49
  50   public boolean isVisible = true;
  51
  52   public int pdbstart = 0;
  53
  54   public int pdbend = 0;
  55
  56   public int seqstart = 0;
  57
  58   public int seqend = 0;
  59
  60   public String pdbid = "";
  61
  62   public PDBChain(String pdbid, String id)
  63   {
  64     this.pdbid = pdbid.toLowerCase();
  65     this.id = id;
  66   }
  67
  68   public String print()
  69   {
  70     String tmp = "";
  71
  72     for (int i = 0; i < bonds.size(); i++)
  73     {
  74       tmp = tmp + ((Bond) bonds.elementAt(i)).at1.resName + " "
  75               + ((Bond) bonds.elementAt(i)).at1.resNumber + " " + offset
  76               + "\n";
  77     }
  78
  79     return tmp;
  80   }
  81
  82   public void makeExactMapping(AlignSeq as, SequenceI s1)
  83   {
  84     int pdbpos = as.getSeq2Start() - 2;
  85     int alignpos = s1.getStart() + as.getSeq1Start() - 3;
  86
  87     for (int i = 0; i < as.astr1.length(); i++)
  88     {
  89       if (as.astr1.charAt(i) != '-')
  90       {
  91         alignpos++;
  92       }
  93
  94       if (as.astr2.charAt(i) != '-')
  95       {
  96         pdbpos++;
  97       }
  98
  99       if (as.astr1.charAt(i) == as.astr2.charAt(i))
 100       {
 101         Residue res = (Residue) residues.elementAt(pdbpos);
 102         Enumeration en = res.atoms.elements();
 103         while (en.hasMoreElements())
 104         {
 105           Atom atom = (Atom) en.nextElement();
 106           atom.alignmentMapping = alignpos;
 107         }
 108       }
 109     }
 110   }
 111
 112   /**
 113    * copy over the RESNUM seqfeatures from the internal chain sequence to the
 114    * mapped sequence
 115    *
 116    * @param seq
 117    * @param status
 118    *          The Status of the transferred annotation
 119    * @return the features added to sq (or its dataset)
 120    */
 121   public SequenceFeature[] transferRESNUMFeatures(SequenceI seq,
 122           String status)
 123   {
 124     SequenceI sq = seq;
 125     while (sq != null && sq.getDatasetSequence() != null)
 126     {
 127       sq = sq.getDatasetSequence();
 128       if (sq == sequence)
 129       {
 130         return null;
 131       }
 132     }
 133     /**
 134      * Remove any existing features for this chain if they exist ?
 135      * SequenceFeature[] seqsfeatures=seq.getSequenceFeatures(); int
 136      * totfeat=seqsfeatures.length; // Remove any features for this exact chain
 137      * ? for (int i=0; i<seqsfeatures.length; i++) { }
 138      */
 139     if (status == null)
 140     {
 141       status = PDBChain.IEASTATUS;
 142     }
 143     SequenceFeature[] features = sequence.getSequenceFeatures();
 144     for (int i = 0; i < features.length; i++)
 145     {
 146       if (features[i].getFeatureGroup().equals(pdbid))
 147       {
 148         SequenceFeature tx = new SequenceFeature(features[i]);
 149         tx.setBegin(1 + ((Atom) ((Residue) residues.elementAt(tx.getBegin()
 150                 - offset)).atoms.elementAt(0)).alignmentMapping);
 151         tx.setEnd(1 + ((Atom) ((Residue) residues.elementAt(tx.getEnd()
 152                 - offset)).atoms.elementAt(0)).alignmentMapping);
 153         tx
 154                 .setStatus(status
 155                         + ((tx.getStatus() == null || tx.getStatus()
 156                                 .length() == 0) ? "" : ":" + tx.getStatus()));
 157         if (tx.begin != 0 && tx.end != 0)
 158           sq.addSequenceFeature(tx);
 159       }
 160     }
 161     return features;
 162   }
 163
 164   public void makeCaBondList()
 165   {
 166     for (int i = 0; i < (residues.size() - 1); i++)
 167     {
 168       Residue tmpres = (Residue) residues.elementAt(i);
 169       Residue tmpres2 = (Residue) residues.elementAt(i + 1);
 170       Atom at1 = tmpres.findAtom("CA");
 171       Atom at2 = tmpres2.findAtom("CA");
 172
 173       if ((at1 != null) && (at2 != null))
 174       {
 175         if (at1.chain.equals(at2.chain))
 176         {
 177           makeBond(at1, at2);
 178         }
 179       }
 180       else
 181       {
 182         System.out.println("not found " + i);
 183       }
 184     }
 185   }
 186
 187   public void makeBond(Atom at1, Atom at2)
 188   {
 189     float[] start = new float[3];
 190     float[] end = new float[3];
 191
 192     start[0] = at1.x;
 193     start[1] = at1.y;
 194     start[2] = at1.z;
 195
 196     end[0] = at2.x;
 197     end[1] = at2.y;
 198     end[2] = at2.z;
 199
 200     bonds.addElement(new Bond(start, end, at1, at2));
 201   }
 202
 203   public void makeResidueList()
 204   {
 205     int count = 0;
 206     Object symbol;
 207     boolean nucleotide = false;
 208     StringBuffer seq = new StringBuffer();
 209     Vector resFeatures = new Vector();
 210     Vector resAnnotation = new Vector();
 211     int i, iSize = atoms.size() - 1;
 212     int resNumber = -1;
 213     for (i = 0; i <= iSize; i++)
 214     {
 215       Atom tmp = (Atom) atoms.elementAt(i);
 216       resNumber = tmp.resNumber;
 217       int res = resNumber;
 218
 219       if (i == 0)
 220       {
 221         offset = resNumber;
 222       }
 223
 224       Vector resAtoms = new Vector();
 225       // Add atoms to a vector while the residue number
 226       // remains the same as the first atom's resNumber (res)
 227       while ((resNumber == res) && (i < atoms.size()))
 228       {
 229         resAtoms.addElement((Atom) atoms.elementAt(i));
 230         i++;
 231
 232         if (i < atoms.size())
 233         {
 234           resNumber = ((Atom) atoms.elementAt(i)).resNumber;
 235         }
 236         else
 237         {
 238           resNumber++;
 239         }
 240       }
 241
 242       // We need this to keep in step with the outer for i = loop
 243       i--;
 244
 245       // Make a new Residue object with the new atoms vector
 246       residues.addElement(new Residue(resAtoms, resNumber - 1, count));
 247
 248       Residue tmpres = (Residue) residues.lastElement();
 249       Atom tmpat = (Atom) tmpres.atoms.elementAt(0);
 250       // Make A new SequenceFeature for the current residue numbering
 251       SequenceFeature sf = new SequenceFeature("RESNUM", tmpat.resName
 252               + ":" + tmpat.resNumIns + " " + pdbid + id, "", offset
 253               + count, offset + count, pdbid);
 254       // MCview.PDBChain.PDBFILEFEATURE);
 255       resFeatures.addElement(sf);
 256       resAnnotation.addElement(new Annotation(tmpat.tfactor));
 257       // Keep totting up the sequence
 258       if ((symbol = ResidueProperties.getAA3Hash().get(tmpat.resName)) == null)
 259       {
 260         if (ResidueProperties.nucleotideIndex[tmpat.resName.charAt(0)] == -1)
 261         {
 262           seq.append("X");
 263           // System.err.println("PDBReader:Null aa3Hash for " +
 264           // tmpat.resName);
 265         }
 266         else
 267         {
 268           // nucleotide flag
 269           nucleotide = true;
 270           seq.append(tmpat.resName.charAt(0));
 271         }
 272       }
 273       else
 274       {
 275         if (nucleotide)
 276         {
 277           System.err
 278                   .println("Warning: mixed nucleotide and amino acid chain.. its gonna do bad things to you!");
 279         }
 280         seq.append(ResidueProperties.aa[((Integer) symbol).intValue()]);
 281       }
 282       count++;
 283     }
 284
 285     if (id.length() < 1)
 286     {
 287       id = " ";
 288     }
 289
 290     sequence = new Sequence(id, seq.toString(), offset, resNumber - 1); // Note:
 291     // resNumber-offset
 292     // ~=
 293     // seq.size()
 294     // Add normalised feature scores to RESNUM indicating start/end of sequence
 295     // sf.setScore(offset+count);
 296
 297     // System.out.println("PDB Sequence is :\nSequence = " + seq);
 298     // System.out.println("No of residues = " + residues.size());
 299     for (i = 0, iSize = resFeatures.size(); i < iSize; i++)
 300     {
 301       sequence.addSequenceFeature((SequenceFeature) resFeatures
 302               .elementAt(i));
 303       resFeatures.setElementAt(null, i);
 304     }
 305     Annotation[] annots = new Annotation[resAnnotation.size()];
 306     float max = 0;
 307     for (i = 0, iSize = annots.length; i < iSize; i++)
 308     {
 309       annots[i] = (Annotation) resAnnotation.elementAt(i);
 310       if (annots[i].value > max)
 311         max = annots[i].value;
 312       resAnnotation.setElementAt(null, i);
 313     }
 314     AlignmentAnnotation tfactorann = new AlignmentAnnotation(
 315             "PDB.TempFactor", "Temperature Factor for "
 316                     + sequence.getName(), annots, 0, max,
 317             AlignmentAnnotation.LINE_GRAPH);
 318     tfactorann.setSequenceRef(sequence);
 319     sequence.addAlignmentAnnotation(tfactorann);
 320   }
 321
 322   public void setChargeColours()
 323   {
 324     for (int i = 0; i < bonds.size(); i++)
 325     {
 326       try
 327       {
 328         Bond b = (Bond) bonds.elementAt(i);
 329
 330         if (b.at1.resName.equalsIgnoreCase("ASP")
 331                 || b.at1.resName.equalsIgnoreCase("GLU"))
 332         {
 333           b.startCol = Color.red;
 334         }
 335         else if (b.at1.resName.equalsIgnoreCase("LYS")
 336                 || b.at1.resName.equalsIgnoreCase("ARG"))
 337         {
 338           b.startCol = Color.blue;
 339         }
 340         else if (b.at1.resName.equalsIgnoreCase("CYS"))
 341         {
 342           b.startCol = Color.yellow;
 343         }
 344         else
 345         {
 346           b.startCol = Color.lightGray;
 347         }
 348
 349         if (b.at2.resName.equalsIgnoreCase("ASP")
 350                 || b.at2.resName.equalsIgnoreCase("GLU"))
 351         {
 352           b.endCol = Color.red;
 353         }
 354         else if (b.at2.resName.equalsIgnoreCase("LYS")
 355                 || b.at2.resName.equalsIgnoreCase("ARG"))
 356         {
 357           b.endCol = Color.blue;
 358         }
 359         else if (b.at2.resName.equalsIgnoreCase("CYS"))
 360         {
 361           b.endCol = Color.yellow;
 362         }
 363         else
 364         {
 365           b.endCol = Color.lightGray;
 366         }
 367       } catch (Exception e)
 368       {
 369         Bond b = (Bond) bonds.elementAt(i);
 370         b.startCol = Color.gray;
 371         b.endCol = Color.gray;
 372       }
 373     }
 374   }
 375
 376   public void setChainColours(jalview.schemes.ColourSchemeI cs)
 377   {
 378     Bond b;
 379     int index;
 380     for (int i = 0; i < bonds.size(); i++)
 381     {
 382       try
 383       {
 384         b = (Bond) bonds.elementAt(i);
 385
 386         index = ((Integer) ResidueProperties.aa3Hash.get(b.at1.resName))
 387                 .intValue();
 388         b.startCol = cs.findColour(ResidueProperties.aa[index].charAt(0));
 389
 390         index = ((Integer) ResidueProperties.aa3Hash.get(b.at2.resName))
 391                 .intValue();
 392         b.endCol = cs.findColour(ResidueProperties.aa[index].charAt(0));
 393
 394       } catch (Exception e)
 395       {
 396         b = (Bond) bonds.elementAt(i);
 397         b.startCol = Color.gray;
 398         b.endCol = Color.gray;
 399       }
 400     }
 401   }
 402
 403   public void setChainColours(Color col)
 404   {
 405     for (int i = 0; i < bonds.size(); i++)
 406     {
 407       Bond tmp = (Bond) bonds.elementAt(i);
 408       tmp.startCol = col;
 409       tmp.endCol = col;
 410     }
 411   }
 412
 413   public AlignmentAnnotation[] transferResidueAnnotation(SequenceI seq,
 414           String status)
 415   {
 416     AlignmentAnnotation[] transferred = null;
 417
 418     return transferred;
 419
 420   }
 421
 422   /**
 423    * copy any sequence annotation onto the sequence mapped using the provided
 424    * StructureMapping
 425    *
 426    * @param mapping
 427    */
 428   public void transferResidueAnnotation(StructureMapping mapping)
 429   {
 430     SequenceI sq = mapping.getSequence();
 431     if (sq != null)
 432     {
 433       if (sequence != null && sequence.getAnnotation() != null)
 434       {
 435
 436       }
 437       float min = -1, max = 0;
 438       Annotation[] an = new Annotation[sq.getEnd() - sq.getStart() + 1];
 439       for (int i = sq.getStart(), j = sq.getEnd(), k = 0; i <= j; i++, k++)
 440       {
 441         int prn = mapping.getPDBResNum(k + 1);
 442
 443         an[k] = new Annotation((float) prn);
 444         if (min == -1)
 445         {
 446           min = k;
 447           max = k;
 448         }
 449         else
 450         {
 451           if (min > k)
 452           {
 453             min = k;
 454           }
 455           else if (max < k)
 456           {
 457             max = k;
 458           }
 459         }
 460       }
 461       sq
 462               .addAlignmentAnnotation(new AlignmentAnnotation("PDB.RESNUM",
 463                       "PDB Residue Numbering for " + this.pdbid + ":"
 464                               + this.id, an, (float) min, (float) max,
 465                       AlignmentAnnotation.LINE_GRAPH));
 466     }
 467   }
 468 }