Clover icon

jalviewX

  1. Project Clover database Wed Oct 31 2018 15:13:58 GMT
  2. Package jalview.datamodel

File Mapping.java

 

Coverage histogram

../../img/srcFileCovDistChart8.png
19% of files have more coverage

Code metrics

118
175
32
2
739
420
101
0.58
5.47
16
3.16

Classes

Class Line # Actions
Mapping 30 121 77 70
0.7046413470.5%
Mapping.AlignedCodonIterator 39 54 24 7
0.9204545692%
 

Contributing tests

This file is covered by 112 tests. .

Source view

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.datamodel;
22   
23    import jalview.util.Comparison;
24    import jalview.util.MapList;
25   
26    import java.util.Iterator;
27    import java.util.NoSuchElementException;
28    import java.util.Vector;
29   
 
30    public class Mapping
31    {
32    /**
33    * An iterator that serves the aligned codon positions (with their protein
34    * products).
35    *
36    * @author gmcarstairs
37    *
38    */
 
39    public class AlignedCodonIterator implements Iterator<AlignedCodon>
40    {
41    /*
42    * The gap character used in the aligned sequence
43    */
44    private final char gap;
45   
46    /*
47    * The characters of the aligned sequence e.g. "-cGT-ACgTG-"
48    */
49    private final SequenceI alignedSeq;
50   
51    /*
52    * the sequence start residue
53    */
54    private int start;
55   
56    /*
57    * Next position (base 0) in the aligned sequence
58    */
59    private int alignedColumn = 0;
60   
61    /*
62    * Count of bases up to and including alignedColumn position
63    */
64    private int alignedBases = 0;
65   
66    /*
67    * [start, end] from ranges (base 1)
68    */
69    private Iterator<int[]> fromRanges;
70   
71    /*
72    * [start, end] to ranges (base 1)
73    */
74    private Iterator<int[]> toRanges;
75   
76    /*
77    * The current [start, end] (base 1) from range
78    */
79    private int[] currentFromRange = null;
80   
81    /*
82    * The current [start, end] (base 1) to range
83    */
84    private int[] currentToRange = null;
85   
86    /*
87    * The next 'from' position (base 1) to process
88    */
89    private int fromPosition = 0;
90   
91    /*
92    * The next 'to' position (base 1) to process
93    */
94    private int toPosition = 0;
95   
96    /**
97    * Constructor
98    *
99    * @param seq
100    * the aligned sequence
101    * @param gapChar
102    */
 
103  15 toggle public AlignedCodonIterator(SequenceI seq, char gapChar)
104    {
105  15 this.alignedSeq = seq;
106  15 this.start = seq.getStart();
107  15 this.gap = gapChar;
108  15 fromRanges = map.getFromRanges().iterator();
109  15 toRanges = map.getToRanges().iterator();
110  15 if (fromRanges.hasNext())
111    {
112  15 currentFromRange = fromRanges.next();
113  15 fromPosition = currentFromRange[0];
114    }
115  15 if (toRanges.hasNext())
116    {
117  15 currentToRange = toRanges.next();
118  15 toPosition = currentToRange[0];
119    }
120    }
121   
122    /**
123    * Returns true unless we have already traversed the whole mapping.
124    */
 
125  97 toggle @Override
126    public boolean hasNext()
127    {
128  97 if (fromRanges.hasNext())
129    {
130  13 return true;
131    }
132  84 if (currentFromRange == null || fromPosition >= currentFromRange[1])
133    {
134  14 return false;
135    }
136  70 return true;
137    }
138   
139    /**
140    * Returns the next codon's aligned positions, and translated value.
141    *
142    * @throws NoSuchElementException
143    * if hasNext() would have returned false
144    * @throws IncompleteCodonException
145    * if not enough mapped bases are left to make up a codon
146    */
 
147  49 toggle @Override
148    public AlignedCodon next() throws IncompleteCodonException
149    {
150  49 if (!hasNext())
151    {
152  0 throw new NoSuchElementException();
153    }
154   
155  49 int[] codon = getNextCodon();
156  48 int[] alignedCodon = getAlignedCodon(codon);
157   
158  48 String peptide = getPeptide();
159  48 int peptideCol = toPosition - 1 - Mapping.this.to.getStart();
160  48 return new AlignedCodon(alignedCodon[0], alignedCodon[1],
161    alignedCodon[2], peptide, peptideCol);
162    }
163   
164    /**
165    * Retrieve the translation as the 'mapped to' position in the mapped to
166    * sequence.
167    *
168    * @return
169    * @throws NoSuchElementException
170    * if the 'toRange' is exhausted (nothing to map to)
171    */
 
172  49 toggle private String getPeptide()
173    {
174    // TODO should ideally handle toRatio other than 1 as well...
175    // i.e. code like getNextCodon()
176  49 if (toPosition <= currentToRange[1])
177    {
178  48 SequenceI seq = Mapping.this.to;
179  48 char pep = seq.getCharAt(toPosition - seq.getStart());
180  48 toPosition++;
181  48 return String.valueOf(pep);
182    }
183  1 if (!toRanges.hasNext())
184    {
185  0 throw new NoSuchElementException(
186    "Ran out of peptide at position " + toPosition);
187    }
188  1 currentToRange = toRanges.next();
189  1 toPosition = currentToRange[0];
190  1 return getPeptide();
191    }
192   
193    /**
194    * Get the (base 1) dataset positions for the next codon in the mapping.
195    *
196    * @throws IncompleteCodonException
197    * if less than 3 remaining bases are mapped
198    */
 
199  49 toggle private int[] getNextCodon()
200    {
201  49 int[] codon = new int[3];
202  49 int codonbase = 0;
203   
204  211 while (codonbase < 3)
205    {
206  163 if (fromPosition <= currentFromRange[1])
207    {
208    /*
209    * Add next position from the current start-end range
210    */
211  146 codon[codonbase++] = fromPosition++;
212    }
213    else
214    {
215    /*
216    * Move to the next range - if there is one
217    */
218  17 if (!fromRanges.hasNext())
219    {
220  1 throw new IncompleteCodonException();
221    }
222  16 currentFromRange = fromRanges.next();
223  16 fromPosition = currentFromRange[0];
224    }
225    }
226  48 return codon;
227    }
228   
229    /**
230    * Get the aligned column positions (base 0) for the given sequence
231    * positions (base 1), by counting ungapped characters in the aligned
232    * sequence.
233    *
234    * @param codon
235    * @return
236    */
 
237  48 toggle private int[] getAlignedCodon(int[] codon)
238    {
239  48 int[] aligned = new int[codon.length];
240  192 for (int i = 0; i < codon.length; i++)
241    {
242  144 aligned[i] = getAlignedColumn(codon[i]);
243    }
244  48 return aligned;
245    }
246   
247    /**
248    * Get the aligned column position (base 0) for the given sequence position
249    * (base 1).
250    *
251    * @param sequencePos
252    * @return
253    */
 
254  144 toggle private int getAlignedColumn(int sequencePos)
255    {
256    /*
257    * allow for offset e.g. treat pos 8 as 2 if sequence starts at 7
258    */
259  144 int truePos = sequencePos - (start - 1);
260  144 int length = alignedSeq.getLength();
261  365 while (alignedBases < truePos && alignedColumn < length)
262    {
263  221 char c = alignedSeq.getCharAt(alignedColumn++);
264  221 if (c != gap && !Comparison.isGap(c))
265    {
266  172 alignedBases++;
267    }
268    }
269  144 return alignedColumn - 1;
270    }
271   
 
272  0 toggle @Override
273    public void remove()
274    {
275    // ignore
276    }
277   
278    }
279   
280    /*
281    * Contains the start-end pairs mapping from the associated sequence to the
282    * sequence in the database coordinate system. It also takes care of step
283    * difference between coordinate systems.
284    */
285    MapList map = null;
286   
287    /*
288    * The sequence that map maps the associated sequence to (if any).
289    */
290    SequenceI to = null;
291   
292    /*
293    * optional sequence id for the 'from' ranges
294    */
295    private String mappedFromId;
296   
 
297  663 toggle public Mapping(MapList map)
298    {
299  663 super();
300  663 this.map = map;
301    }
302   
 
303  450 toggle public Mapping(SequenceI to, MapList map)
304    {
305  450 this(map);
306  450 this.to = to;
307    }
308   
309    /**
310    * create a new mapping from
311    *
312    * @param to
313    * the sequence being mapped
314    * @param exon
315    * int[] {start,end,start,end} series on associated sequence
316    * @param is
317    * int[] {start,end,...} ranges on the reference frame being mapped
318    * to
319    * @param i
320    * step size on associated sequence
321    * @param j
322    * step size on mapped frame
323    */
 
324  12 toggle public Mapping(SequenceI to, int[] exon, int[] is, int i, int j)
325    {
326  12 this(to, new MapList(exon, is, i, j));
327    }
328   
329    /**
330    * create a duplicate (and independent) mapping object with the same reference
331    * to any SequenceI being mapped to.
332    *
333    * @param map2
334    */
 
335  8 toggle public Mapping(Mapping map2)
336    {
337  8 if (map2 != this && map2 != null)
338    {
339  8 if (map2.map != null)
340    {
341  8 map = new MapList(map2.map);
342    }
343  8 to = map2.to;
344  8 mappedFromId = map2.mappedFromId;
345    }
346    }
347   
348    /**
349    * @return the map
350    */
 
351  772 toggle public MapList getMap()
352    {
353  772 return map;
354    }
355   
356    /**
357    * @param map
358    * the map to set
359    */
 
360  2 toggle public void setMap(MapList map)
361    {
362  2 this.map = map;
363    }
364   
365    /**
366    * Equals that compares both the to references and MapList mappings.
367    *
368    * @param o
369    * @return
370    * @see MapList#equals
371    */
 
372  39 toggle @Override
373    public boolean equals(Object o)
374    {
375  39 if (o == null || !(o instanceof Mapping))
376    {
377  0 return false;
378    }
379  39 Mapping other = (Mapping) o;
380  39 if (other == this)
381    {
382  6 return true;
383    }
384  33 if (other.to != to)
385    {
386  27 return false;
387    }
388  6 if ((map != null && other.map == null)
389    || (map == null && other.map != null))
390    {
391  0 return false;
392    }
393  6 if ((map == null && other.map == null) || map.equals(other.map))
394    {
395  0 return true;
396    }
397  6 return false;
398    }
399   
400    /**
401    * Returns a hashCode made from the sequence and maplist
402    */
 
403  2 toggle @Override
404    public int hashCode()
405    {
406  2 int hashCode = (this.to == null ? 1 : this.to.hashCode());
407  2 if (this.map != null)
408    {
409  2 hashCode = hashCode * 31 + this.map.hashCode();
410    }
411   
412  2 return hashCode;
413    }
414   
415    /**
416    * get the 'initial' position in the associated sequence for a position in the
417    * mapped reference frame
418    *
419    * @param mpos
420    * @return
421    */
 
422  4782 toggle public int getPosition(int mpos)
423    {
424  4782 if (map != null)
425    {
426  4782 int[] mp = map.shiftTo(mpos);
427  4782 if (mp != null)
428    {
429  4768 return mp[0];
430    }
431    }
432  14 return mpos;
433    }
434   
435    /**
436    * gets boundary in direction of mapping
437    *
438    * @param position
439    * in mapped reference frame
440    * @return int{start, end} positions in associated sequence (in direction of
441    * mapped word)
442    */
 
443  0 toggle public int[] getWord(int mpos)
444    {
445  0 if (map != null)
446    {
447  0 return map.getToWord(mpos);
448    }
449  0 return null;
450    }
451   
452    /**
453    * width of mapped unit in associated sequence
454    *
455    */
 
456  57 toggle public int getWidth()
457    {
458  57 if (map != null)
459    {
460  57 return map.getFromRatio();
461    }
462  0 return 1;
463    }
464   
465    /**
466    * width of unit in mapped reference frame
467    *
468    * @return
469    */
 
470  57 toggle public int getMappedWidth()
471    {
472  57 if (map != null)
473    {
474  57 return map.getToRatio();
475    }
476  0 return 1;
477    }
478   
479    /**
480    * get mapped position in the associated reference frame for position pos in
481    * the associated sequence.
482    *
483    * @param pos
484    * @return
485    */
 
486  9 toggle public int getMappedPosition(int pos)
487    {
488  9 if (map != null)
489    {
490  9 int[] mp = map.shiftFrom(pos);
491  9 if (mp != null)
492    {
493  4 return mp[0];
494    }
495    }
496  5 return pos;
497    }
498   
 
499  0 toggle public int[] getMappedWord(int pos)
500    {
501  0 if (map != null)
502    {
503  0 int[] mp = map.shiftFrom(pos);
504  0 if (mp != null)
505    {
506  0 return new int[] { mp[0], mp[0] + mp[2] * (map.getToRatio() - 1) };
507    }
508    }
509  0 return null;
510    }
511   
512    /**
513    * locates the region of feature f in the associated sequence's reference
514    * frame
515    *
516    * @param f
517    * @return one or more features corresponding to f
518    */
 
519  1572 toggle public SequenceFeature[] locateFeature(SequenceFeature f)
520    {
521  1572 if (true)
522    { // f.getBegin()!=f.getEnd()) {
523  1572 if (map != null)
524    {
525  1572 int[] frange = map.locateInFrom(f.getBegin(), f.getEnd());
526  1572 if (frange == null)
527    {
528    // JBPNote - this isprobably not the right thing to doJBPHack
529  0 return null;
530    }
531  1572 SequenceFeature[] vf = new SequenceFeature[frange.length / 2];
532  3144 for (int i = 0, v = 0; i < frange.length; i += 2, v++)
533    {
534  1572 vf[v] = new SequenceFeature(f, frange[i], frange[i + 1],
535    f.getFeatureGroup(), f.getScore());
536  1572 if (frange.length > 2)
537    {
538  0 vf[v].setDescription(f.getDescription() + "\nPart " + (v + 1));
539    }
540    }
541  1572 return vf;
542    }
543    }
544   
545    // give up and just return the feature.
546  0 return new SequenceFeature[] { f };
547    }
548   
549    /**
550    * return a series of contigs on the associated sequence corresponding to the
551    * from,to interval on the mapped reference frame
552    *
553    * @param from
554    * @param to
555    * @return int[] { from_i, to_i for i=1 to n contiguous regions in the
556    * associated sequence}
557    */
 
558  3 toggle public int[] locateRange(int from, int to)
559    {
560  3 if (map != null)
561    {
562  3 if (from <= to)
563    {
564  3 from = (map.getToLowest() < from) ? from : map.getToLowest();
565  3 to = (map.getToHighest() > to) ? to : map.getToHighest();
566  3 if (from > to)
567    {
568  0 return null;
569    }
570    }
571    else
572    {
573  0 from = (map.getToHighest() > from) ? from : map.getToHighest();
574  0 to = (map.getToLowest() < to) ? to : map.getToLowest();
575  0 if (from < to)
576    {
577  0 return null;
578    }
579    }
580  3 return map.locateInFrom(from, to);
581    }
582  0 return new int[] { from, to };
583    }
584   
585    /**
586    * return a series of mapped contigs mapped from a range on the associated
587    * sequence
588    *
589    * @param from
590    * @param to
591    * @return
592    */
 
593  12 toggle public int[] locateMappedRange(int from, int to)
594    {
595  12 if (map != null)
596    {
597   
598  12 if (from <= to)
599    {
600  12 from = (map.getFromLowest() < from) ? from : map.getFromLowest();
601  12 to = (map.getFromHighest() > to) ? to : map.getFromHighest();
602  12 if (from > to)
603    {
604  0 return null;
605    }
606    }
607    else
608    {
609  0 from = (map.getFromHighest() > from) ? from : map.getFromHighest();
610  0 to = (map.getFromLowest() < to) ? to : map.getFromLowest();
611  0 if (from < to)
612    {
613  0 return null;
614    }
615    }
616  12 return map.locateInTo(from, to);
617    }
618  0 return new int[] { from, to };
619    }
620   
621    /**
622    * return a new mapping object with a maplist modifed to only map the visible
623    * regions defined by viscontigs.
624    *
625    * @param viscontigs
626    * @return
627    */
 
628  2 toggle public Mapping intersectVisContigs(int[] viscontigs)
629    {
630  2 Mapping copy = new Mapping(this);
631  2 if (map != null)
632    {
633  2 int vpos = 0;
634  2 int apos = 0;
635  2 Vector toRange = new Vector();
636  2 Vector fromRange = new Vector();
637  5 for (int vc = 0; vc < viscontigs.length; vc += 2)
638    {
639    // find a mapped range in this visible region
640  3 int[] mpr = locateMappedRange(1 + viscontigs[vc],
641    viscontigs[vc + 1] - 1);
642  3 if (mpr != null)
643    {
644  6 for (int m = 0; m < mpr.length; m += 2)
645    {
646  3 toRange.addElement(new int[] { mpr[m], mpr[m + 1] });
647  3 int[] xpos = locateRange(mpr[m], mpr[m + 1]);
648  9 for (int x = 0; x < xpos.length; x += 2)
649    {
650  6 fromRange.addElement(new int[] { xpos[x], xpos[x + 1] });
651    }
652    }
653    }
654    }
655  2 int[] from = new int[fromRange.size() * 2];
656  2 int[] to = new int[toRange.size() * 2];
657  2 int[] r;
658  8 for (int f = 0, fSize = fromRange.size(); f < fSize; f++)
659    {
660  6 r = (int[]) fromRange.elementAt(f);
661  6 from[f * 2] = r[0];
662  6 from[f * 2 + 1] = r[1];
663    }
664  5 for (int f = 0, fSize = toRange.size(); f < fSize; f++)
665    {
666  3 r = (int[]) toRange.elementAt(f);
667  3 to[f * 2] = r[0];
668  3 to[f * 2 + 1] = r[1];
669    }
670  2 copy.setMap(
671    new MapList(from, to, map.getFromRatio(), map.getToRatio()));
672    }
673  2 return copy;
674    }
675   
676    /**
677    * get the sequence being mapped to - if any
678    *
679    * @return null or a dataset sequence
680    */
 
681  597 toggle public SequenceI getTo()
682    {
683  597 return to;
684    }
685   
686    /**
687    * set the dataset sequence being mapped to if any
688    *
689    * @param tto
690    */
 
691  182 toggle public void setTo(SequenceI tto)
692    {
693  182 to = tto;
694    }
695   
696    /**
697    * Returns an iterator which can serve up the aligned codon column positions
698    * and their corresponding peptide products
699    *
700    * @param seq
701    * an aligned (i.e. possibly gapped) sequence
702    * @param gapChar
703    * @return
704    */
 
705  15 toggle public Iterator<AlignedCodon> getCodonIterator(SequenceI seq,
706    char gapChar)
707    {
708  15 return new AlignedCodonIterator(seq, gapChar);
709    }
710   
711    /**
712    * Readable representation for debugging only, not guaranteed not to change
713    */
 
714  2 toggle @Override
715    public String toString()
716    {
717  2 return String.format("%s %s", this.map.toString(),
718  2 this.to == null ? "" : this.to.getName());
719    }
720   
721    /**
722    * Returns the identifier for the 'from' range sequence, or null if not set
723    *
724    * @return
725    */
 
726  12 toggle public String getMappedFromId()
727    {
728  12 return mappedFromId;
729    }
730   
731    /**
732    * Sets the identifier for the 'from' range sequence
733    */
 
734  382 toggle public void setMappedFromId(String mappedFromId)
735    {
736  382 this.mappedFromId = mappedFromId;
737    }
738   
739    }
  • Report generated by OpenClover v 4.2.1 on Wed Oct 31 2018 15:15:54 GMT using coverage data from Wed Oct 31 2018 15:15:47 GMT.
  • Clover free edition.