src/jalview/structure/StructureMapping.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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.structure;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.SequenceI;
  25
  26 public class StructureMapping
  27 {
  28   String mappingDetails;
  29
  30   SequenceI sequence;
  31
  32   String pdbfile;
  33
  34   String pdbid;
  35
  36   String pdbchain;
  37
  38   // Mapping index 0 is resNum, index 1 is atomNo
  39   int[][] mapping;
  40
  41   public StructureMapping(SequenceI seq, String pdbfile, String pdbid,
  42           String chain, int[][] mapping, String mappingDetails)
  43   {
  44     sequence = seq;
  45     this.pdbfile = pdbfile;
  46     this.pdbid = pdbid;
  47     this.pdbchain = chain;
  48     this.mapping = mapping;
  49     this.mappingDetails = mappingDetails;
  50   }
  51
  52   public SequenceI getSequence()
  53   {
  54     return sequence;
  55   }
  56
  57   public String getChain()
  58   {
  59     return pdbchain;
  60   }
  61
  62   public String getPdbId()
  63   {
  64     return pdbid;
  65   }
  66
  67   public int getAtomNum(int seqpos)
  68   {
  69     if (mapping.length > seqpos)
  70     {
  71       return mapping[seqpos][1];
  72     }
  73     else
  74     {
  75       return 0;
  76     }
  77   }
  78
  79   public int getPDBResNum(int seqpos)
  80   {
  81     if (mapping.length > seqpos)
  82     {
  83       return mapping[seqpos][0];
  84     }
  85     else
  86     {
  87       return 0;
  88     }
  89   }
  90
  91   public int getSeqPos(int pdbResNum)
  92   {
  93     for (int i = 0; i < mapping.length; i++)
  94     {
  95       if (mapping[i][0] == pdbResNum)
  96       {
  97         return i;
  98       }
  99     }
 100     return -1;
 101   }
 102
 103   /**
 104    * transfer a copy of an alignment annotation row in the PDB chain coordinate
 105    * system onto the mapped sequence
 106    *
 107    * @param ana
 108    * @return the copy that was remapped to the mapped sequence
 109    * @note this method will create a copy and add it to the dataset sequence for
 110    *       the mapped sequence as well as the mapped sequence (if it is not a
 111    *       dataset sequence).
 112    */
 113   public AlignmentAnnotation transfer(AlignmentAnnotation ana)
 114   {
 115     AlignmentAnnotation ala_copy = new AlignmentAnnotation(ana);
 116     SequenceI ds = sequence;
 117     while (ds.getDatasetSequence() != null)
 118     {
 119       ds = ds.getDatasetSequence();
 120     }
 121     ala_copy.remap(ds, mapping, 0, -1, 1);
 122     ds.addAlignmentAnnotation(ala_copy);
 123     if (ds != sequence)
 124     {
 125       // mapping wasn't to an original dataset sequence, so we make a copy on
 126       // the mapped sequence too
 127       ala_copy = new AlignmentAnnotation(ala_copy);
 128       sequence.addAlignmentAnnotation(ala_copy);
 129     }
 130     return ala_copy;
 131   }
 132 }