1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
|
/*
* Copyright 2011, Ben Langmead <langmea@cs.jhu.edu>
*
* This file is part of Bowtie 2.
*
* Bowtie 2 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.
*
* Bowtie 2 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 Bowtie 2. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ALIGNER_RESULT_H_
#define ALIGNER_RESULT_H_
#include <utility>
#include <limits>
#include "mem_ids.h"
#include "ref_coord.h"
#include "read.h"
#include "filebuf.h"
#include "ds.h"
#include "edit.h"
#include "limit.h"
typedef int64_t TAlScore;
#define VALID_AL_SCORE(x) ((x).score_ > MIN_I64)
#define VALID_SCORE(x) ((x) > MIN_I64)
#define INVALIDATE_SCORE(x) ((x) = MIN_I64)
/**
* A generic score object for an alignment. Used for accounting during
* SW and elsewhere. Encapsulates the score, the number of N positions
* and the number gaps in the alignment.
*
* The scale for 'score' is such that a perfect alignment score is 0
* and a score with non-zero penalty is less than 0. So differences
* between scores work as expected, but interpreting an individual
* score (larger is better) as a penalty (smaller is better) requires
* taking the absolute value.
*/
class AlnScore {
public:
/**
* Gapped scores are invalid until proven valid.
*/
inline AlnScore() {
reset();
invalidate();
assert(!valid());
}
/**
* Gapped scores are invalid until proven valid.
*/
inline AlnScore(TAlScore score, int basesAligned, int edits, TAlScore ns, TAlScore gaps) {
score_ = score;
basesAligned_ = basesAligned;
edits_ = edits;
ns_ = ns;
gaps_ = gaps;
assert(valid());
}
/**
* Reset the score.
*/
void reset() {
score_ = basesAligned_ = edits_ = ns_ = gaps_ = 0;
}
/**
* Return an invalid SwScore.
*/
inline static AlnScore INVALID() {
AlnScore s;
s.invalidate();
assert(!s.valid());
return s;
}
/**
* Return true iff this score has a valid value.
*/
inline bool valid() const {
return score_ != MIN_I64;
}
/**
* Make this score invalid (and therefore <= all other scores).
*/
inline void invalidate() {
score_ = MIN_I64;
edits_ = basesAligned_ = std::numeric_limits<int>::min();
ns_ = gaps_ = 0;
assert(!valid());
}
/**
* Increment the number of gaps. If currently invalid, this makes
* the score valid with gaps == 1.
*/
inline void incNs(int nceil) {
if(++ns_ > nceil) {
invalidate();
}
assert_lt(ns_, 0x7fffffff);
}
/**
* Return true iff this score is > score o.
* Note: An "invalid" score is <= all other scores.
*/
inline bool operator>(const AlnScore& o) const {
if(!VALID_AL_SCORE(o)) {
if(!VALID_AL_SCORE(*this)) {
// both invalid
return false;
} else {
// I'm valid, other is invalid
return true;
}
} else if(!VALID_AL_SCORE(*this)) {
// I'm invalid, other is valid
return false;
}
return score_ > o.score_;
}
/**
* Scores are equal iff they're bitwise equal.
*/
inline AlnScore& operator=(const AlnScore& o) {
// Profiling shows many cache misses on following lines
gaps_ = o.gaps_;
basesAligned_ = o.basesAligned_;
ns_ = o.ns_;
edits_ = o.edits_;
score_ = o.score_;
assert_lt(ns_, 0x7fffffff);
return *this;
}
/**
* Scores are equal iff they're bitwise equal.
*/
inline bool operator==(const AlnScore& o) const {
// Profiling shows cache misses on following line
return VALID_AL_SCORE(*this) && VALID_AL_SCORE(o) && score_ == o.score_;
}
/**
* Return true iff the two scores are unequal.
*/
inline bool operator!=(const AlnScore& o) const {
return !(*this == o);
}
/**
* Return true iff this score is >= score o.
*/
inline bool operator>=(const AlnScore& o) const {
if(!VALID_AL_SCORE(o)) {
if(!VALID_AL_SCORE(*this)) {
// both invalid
return false;
} else {
// I'm valid, other is invalid
return true;
}
} else if(!VALID_AL_SCORE(*this)) {
// I'm invalid, other is valid
return false;
}
return score_ >= o.score_;
}
/**
* Return true iff this score is < score o.
*/
inline bool operator<(const AlnScore& o) const {
return !operator>=(o);
}
/**
* Calculate sum of two SwScores.
*/
inline AlnScore operator+(const AlnScore& o) const {
if(!VALID_AL_SCORE(*this)) return *this;
AlnScore s;
s.gaps_ = gaps_ + o.gaps_;
s.basesAligned_ = basesAligned_ + o.basesAligned_;
s.ns_ = ns_ + o.ns_;
s.edits_ = edits_ + o.edits_;
s.score_ = score_ + o.score_;
assert_lt(s.ns_, 0x7fffffff);
return s;
}
/**
* Add given SwScore into this one.
*/
inline AlnScore operator+=(const AlnScore& o) {
if(VALID_AL_SCORE(*this)) {
gaps_ += o.gaps_;
basesAligned_ += o.basesAligned_;
score_ += o.score_;
edits_ += o.edits_;
ns_ += o.ns_;
}
return (*this);
}
TAlScore score() const { return score_; }
TAlScore penalty() const { return -score_; }
TAlScore gaps() const { return gaps_; }
TAlScore ns() const { return ns_; }
int basesAligned() const { return basesAligned_; }
int nedit() const { return edits_; }
// Score accumulated so far (penalties are subtracted starting at 0)
TAlScore score_;
// Number of bases matching between the read and reference
int basesAligned_;
// Edit distance
int edits_;
// Ns accumulated so far. An N opposite a non-gap counts as 1 N
// (even if it's N-to-N)
TAlScore ns_;
// # gaps encountered so far, unless that number exceeds the
// target, in which case the score becomes invalid and therefore <=
// all other scores
TAlScore gaps_;
};
enum {
// This alignment is one of a pair of alignments that form a concordant
// alignment for a read
ALN_FLAG_PAIR_CONCORD_MATE1 = 1,
ALN_FLAG_PAIR_CONCORD_MATE2,
// This alignment is one of a pair of alignments that form a discordant
// alignment for a read
ALN_FLAG_PAIR_DISCORD_MATE1,
ALN_FLAG_PAIR_DISCORD_MATE2,
// This is an unpaired alignment but the read in question is a pair;
// usually, this happens because the read had no reportable paired-end
// alignments
ALN_FLAG_PAIR_UNPAIRED_MATE1,
ALN_FLAG_PAIR_UNPAIRED_MATE2,
// This is an unpaired alignment of an unpaired read
ALN_FLAG_PAIR_UNPAIRED
};
/**
* Encapsulates some general information about an alignment that doesn't belong
* in AlnRes. Specifically:
*
* 1. Whether the alignment is paired
* 2. If it's paried, whether it's concordant or discordant
* 3. Whether this alignment was found after the paired-end categories were
* maxed out
* 4. Whether the relevant unpaired category was maxed out
*/
class AlnFlags {
public:
AlnFlags() {
init(
ALN_FLAG_PAIR_UNPAIRED,
false, // canMax
false, // maxed
false, // maxedPair
false, // nfilt
false, // scfilt
false, // lenfilt
false, // qcfilt
false, // mixedMode
false, // primary
false, // oppAligned
false, // oppFw
false, // scUnMapped
false); // xeq
}
AlnFlags(
int pairing,
bool canMax,
bool maxed,
bool maxedPair,
bool nfilt,
bool scfilt,
bool lenfilt,
bool qcfilt,
bool mixedMode,
bool primary,
bool oppAligned, // opposite mate aligned?
bool oppFw, // opposite mate aligned forward?
bool scUnMapped,
bool xeq)
{
init(pairing, canMax, maxed, maxedPair, nfilt, scfilt,
lenfilt, qcfilt, mixedMode, primary, oppAligned,
oppFw, scUnMapped, xeq);
}
/**
* Initialize given values for all settings.
*/
void init(
int pairing,
bool canMax,
bool maxed,
bool maxedPair,
bool nfilt,
bool scfilt,
bool lenfilt,
bool qcfilt,
bool mixedMode,
bool primary,
bool oppAligned,
bool oppFw,
bool scUnMapped,
bool xeq)
{
assert_gt(pairing, 0);
assert_leq(pairing, ALN_FLAG_PAIR_UNPAIRED);
pairing_ = pairing;
canMax_ = canMax;
maxed_ = maxed;
maxedPair_ = maxedPair;
nfilt_ = nfilt;
scfilt_ = scfilt;
lenfilt_ = lenfilt;
qcfilt_ = qcfilt;
mixedMode_ = mixedMode;
primary_ = primary;
oppAligned_ = oppAligned;
oppFw_ = oppFw;
scUnMapped_ = scUnMapped;
xeq_ = xeq;
}
/**
* Return true iff this alignment is from a paired-end read.
*/
bool partOfPair() const {
assert_gt(pairing_, 0);
return pairing_ < ALN_FLAG_PAIR_UNPAIRED;
}
#ifndef NDEBUG
/**
* Check that the flags are internally consistent.
*/
bool repOk() const {
assert(partOfPair() || !maxedPair_);
return true;
}
#endif
/**
* Print out string representation of YF:i flag for indicating whether and
* why the mate was filtered.
*/
bool printYF(BTString& o, bool first) const;
/**
* Print out string representation of YM:i flag for indicating with the
* mate per se aligned repetitively.
*/
void printYM(BTString& o) const;
/**
* Print out string representation of YM:i flag for indicating with the
* pair containing the mate aligned repetitively.
*/
void printYP(BTString& o) const;
/**
* Print out string representation of these flags.
*/
void printYT(BTString& o) const;
inline int pairing() const { return pairing_; }
inline bool maxed() const { return maxed_; }
inline bool maxedPair() const { return maxedPair_; }
/**
* Return true iff the alignment is not the primary alignment; i.e. not the
* first reported alignment for the fragment.
*/
inline bool isPrimary() const {
return primary_;
}
/**
* Set the primary flag.
*/
void setPrimary(bool primary) {
primary_ = primary;
}
/**
* Return whether both paired and unpaired alignments are considered for
* pairs & their constituent mates
*/
inline bool isMixedMode() const {
return mixedMode_;
}
/**
* Return true iff the alignment params are such that it's possible for a
* read to be suppressed for being repetitive.
*/
inline bool canMax() const {
return canMax_;
}
/**
* Return true iff the alignment was filtered out.
*/
bool filtered() const {
return !nfilt_ || !scfilt_ || !lenfilt_ || !qcfilt_;
}
/**
* Return true iff the read is mate #1 of a pair, regardless of whether it
* aligned as a pair.
*/
bool readMate1() const {
return pairing_ == ALN_FLAG_PAIR_CONCORD_MATE1 ||
pairing_ == ALN_FLAG_PAIR_DISCORD_MATE1 ||
pairing_ == ALN_FLAG_PAIR_UNPAIRED_MATE1;
}
/**
* Return true iff the read is mate #2 of a pair, regardless of whether it
* aligned as a pair.
*/
bool readMate2() const {
return pairing_ == ALN_FLAG_PAIR_CONCORD_MATE2 ||
pairing_ == ALN_FLAG_PAIR_DISCORD_MATE2 ||
pairing_ == ALN_FLAG_PAIR_UNPAIRED_MATE2;
}
/**
* Return true iff the read aligned as either mate of a concordant pair.
*/
bool alignedConcordant() const {
return pairing_ == ALN_FLAG_PAIR_CONCORD_MATE1 ||
pairing_ == ALN_FLAG_PAIR_CONCORD_MATE2;
}
/**
* Return true iff the read aligned as either mate of a discordant pair.
*/
bool alignedDiscordant() const {
return pairing_ == ALN_FLAG_PAIR_DISCORD_MATE1 ||
pairing_ == ALN_FLAG_PAIR_DISCORD_MATE2;
}
/**
* Return true iff the read aligned as either mate of a pair, concordant or
* discordant.
*/
bool alignedPaired() const {
return alignedConcordant() && alignedDiscordant();
}
/**
* Return true iff the read aligned as an unpaired read.
*/
bool alignedUnpaired() const {
return pairing_ == ALN_FLAG_PAIR_UNPAIRED;
}
/**
* Return true iff the read aligned as an unpaired mate from a paired read.
*/
bool alignedUnpairedMate() const {
return pairing_ == ALN_FLAG_PAIR_UNPAIRED_MATE1 ||
pairing_ == ALN_FLAG_PAIR_UNPAIRED_MATE2;
}
bool mateAligned() const {
return oppAligned_;
}
bool isOppFw() const {
return oppFw_;
}
bool scUnMapped() const {
return scUnMapped_;
}
bool xeq() const {
return xeq_;
}
protected:
// See ALN_FLAG_PAIR_* above
int pairing_;
// True iff the alignment params are such that it's possible for a read to
// be suppressed for being repetitive
bool canMax_;
// This alignment is sampled from among many alignments that, taken
// together, cause this mate to align non-uniquely
bool maxed_;
// The paired-end read of which this mate is part has repetitive concordant
// alignments
bool maxedPair_;
bool nfilt_; // read/mate filtered b/c proportion of Ns exceeded ceil
bool scfilt_; // read/mate filtered b/c length can't provide min score
bool lenfilt_; // read/mate filtered b/c less than or equal to seed mms
bool qcfilt_; // read/mate filtered by upstream qc
// Whether both paired and unpaired alignments are considered for pairs &
// their constituent mates
bool mixedMode_;
// The read is the primary read
bool primary_;
// True iff the opposite mate aligned
bool oppAligned_;
// True if opposite mate aligned in the forward direction
bool oppFw_;
// True if soft clipped bases are considered unmapped w/r/t TLEN
bool scUnMapped_;
bool xeq_;
};
static inline ostream& operator<<(ostream& os, const AlnScore& o) {
os << o.score();
return os;
}
// Forward declaration
class BitPairReference;
// A given AlnRes can be one of these three types
enum {
ALN_RES_TYPE_UNPAIRED = 1, // unpaired alignment
ALN_RES_TYPE_UNPAIRED_MATE1, // mate #1 in pair, aligned unpaired
ALN_RES_TYPE_UNPAIRED_MATE2, // mate #2 in pair, aligned unpaired
ALN_RES_TYPE_MATE1, // mate #1 in paired-end alignment
ALN_RES_TYPE_MATE2 // mate #2 in paired-end alignment
};
/**
* Seed alignment summary
*/
struct SeedAlSumm {
SeedAlSumm() { reset(); }
void reset() {
nonzTot = nonzFw = nonzRc = 0;
nrangeTot = nrangeFw = nrangeRc = 0;
neltTot = neltFw = neltRc = 0;
minNonzRangeFw = minNonzRangeRc = 0;
maxNonzRangeFw = maxNonzRangeRc = 0;
minNonzEltFw = minNonzEltRc = 0;
maxNonzEltFw = maxNonzEltRc = 0;
}
size_t nonzTot;
size_t nonzFw;
size_t nonzRc;
size_t nrangeTot;
size_t nrangeFw;
size_t nrangeRc;
size_t neltTot;
size_t neltFw;
size_t neltRc;
size_t minNonzRangeFw;
size_t minNonzRangeRc;
size_t maxNonzRangeFw;
size_t maxNonzRangeRc;
size_t minNonzEltFw;
size_t minNonzEltRc;
size_t maxNonzEltFw;
size_t maxNonzEltRc;
};
/**
* Encapsulates a stacked alignment, a nice intermediate format for alignments
* from which to left-align gaps, print CIGAR strings, and print MD:Z strings.
*/
class StackedAln {
public:
StackedAln() :
stackRef_(RES_CAT),
stackRel_(RES_CAT),
stackRead_(RES_CAT),
cigOp_(RES_CAT),
cigRun_(RES_CAT),
mdzOp_(RES_CAT),
mdzChr_(RES_CAT),
mdzRun_(RES_CAT)
{
reset();
}
/**
* Reset to an uninitialized state.
*/
void reset() {
inited_ = false;
trimLS_ = trimLH_ = trimRS_ = trimRH_ = 0;
stackRef_.clear();
stackRel_.clear();
stackRead_.clear();
cigDistMm_ = cigCalc_ = false;
cigOp_.clear();
cigRun_.clear();
mdzCalc_ = false;
mdzOp_.clear();
mdzChr_.clear();
mdzRun_.clear();
}
/**
* Return true iff the stacked alignment has been initialized.
*/
bool inited() const { return inited_; }
/**
* Initialized the stacked alignment with respect to a read string, a list of
* edits (expressed left-to-right), and integers indicating how much hard and
* soft trimming has occurred on either end of the read.
*
* s: read sequence
* ed: all relevant edits, including ambiguous nucleotides
* trimLS: # bases soft-trimmed from LHS
* trimLH: # bases hard-trimmed from LHS
* trimRS: # bases soft-trimmed from RHS
* trimRH: # bases hard-trimmed from RHS
*/
void init(
const BTDnaString& s,
const EList<Edit>& ed,
size_t trimLS,
size_t trimLH,
size_t trimRS,
size_t trimRH);
/**
* Left-align all the gaps. If this changes the alignment and the CIGAR or
* MD:Z strings have already been calculated, this renders them invalid.
*
* We left-align gaps with in the following way: for each gap, we check
* whether the character opposite the rightmost gap character is the same
* as the character opposite the character just to the left of the gap. If
* this is the case, we can slide the gap to the left and make the
* rightmost position previously covered by the gap into a non-gap.
*
* This scheme allows us to push the gap past a mismatch. BWA does seem to
* allow this. It's not clear that Bowtie 2 should, since moving the
* mismatch could cause a mismatch with one base quality to be replaced
* with a mismatch with a different base quality.
*/
void leftAlign(bool pastMms);
/**
* Build the CIGAR list, if it hasn't already built. Returns true iff it
* was built for the first time.
*/
bool buildCigar(bool xeq);
/**
* Build the MD:Z list, if it hasn't already built. Returns true iff it
* was built for the first time.
*/
bool buildMdz();
/**
* Write a CIGAR representation of the alignment to the given string and/or
* char buffer.
*/
void writeCigar(BTString* o, char* oc) const;
/**
* Write an MD:Z representation of the alignment to the given string and/or
* char buffer.
*/
void writeMdz(BTString* o, char* oc) const;
/**
* Check internal consistency.
*/
#ifndef NDEBUG
bool repOk() const {
if(inited_) {
assert_eq(stackRef_.size(), stackRead_.size());
assert_eq(stackRef_.size(), stackRel_.size());
}
return true;
}
#endif
protected:
bool inited_; // true iff stacked alignment is initialized
size_t trimLS_; // amount soft-trimmed from the LHS
size_t trimLH_; // amount hard-trimmed from the LHS
size_t trimRS_; // amount soft-trimmed from the RHS
size_t trimRH_; // amount hard-trimmed from the RHS
EList<char> stackRef_; // reference characters
EList<char> stackRel_; // bars relating reference to read characters
EList<char> stackRead_; // read characters
bool cigDistMm_; // distinguish between =/X, rather than just M
bool cigCalc_; // whether we've calculated CIGAR ops/runs
EList<char> cigOp_; // CIGAR operations
EList<size_t> cigRun_; // CIGAR run lengths
bool mdzCalc_; // whether we've calculated MD:Z ops/runs
EList<char> mdzOp_; // MD:Z operations
EList<char> mdzChr_; // MD:Z operations
EList<size_t> mdzRun_; // MD:Z run lengths
};
/**
* Encapsulates an alignment result. The result comprises:
*
* 1. All the nucleotide edits for both mates ('ned').
* 2. All "edits" where an ambiguous reference char is resolved to an
* unambiguous char ('aed').
* 3. The score for the alginment, including summary information about the
* number of gaps and Ns involved.
* 4. The reference id, strand, and 0-based offset of the leftmost character
* involved in the alignment.
* 5. Information about trimming prior to alignment and whether it was hard or
* soft.
* 6. Information about trimming during alignment and whether it was hard or
* soft. Local-alignment trimming is usually soft when aligning nucleotide
* reads.
*
* Note that the AlnRes, together with the Read and an AlnSetSumm (*and* the
* opposite mate's AlnRes and Read in the case of a paired-end alignment),
* should contain enough information to print an entire alignment record.
*
* TRIMMING
*
* Accounting for trimming is tricky. Trimming affects:
*
* 1. The values of the trim* and pretrim* fields.
* 2. The offsets of the Edits in the EList<Edit>s.
* 3. The read extent, if the trimming is soft.
* 4. The read extent and the read sequence and length, if trimming is hard.
*
* Handling 1. is not too difficult. 2., 3., and 4. are handled in setShape().
*/
class AlnRes {
public:
AlnRes() :
ned_(RES_CAT),
aed_(RES_CAT)
{
reset();
}
/**
* Clear all contents.
*/
void reset();
/**
* Reverse all edit lists.
*/
void reverseEdits() {
ned_.reverse();
aed_.reverse();
}
/**
* Invert positions of edits so that they're with respect to the other end
* of the alignment. The assumption is that the .pos fields of the edits
* in the ned_/aed_/ced_ structures are offsets with respect to the first
* aligned character (i.e. after all trimming).
*/
void invertEdits() {
assert(shapeSet_);
assert_gt(rdlen_, 0);
assert_gt(rdrows_, 0);
Edit::invertPoss(ned_, rdexrows_, false);
Edit::invertPoss(aed_, rdexrows_, false);
}
/**
* Return true iff no result has been installed.
*/
bool empty() const {
if(!VALID_AL_SCORE(score_)) {
assert(ned_.empty());
assert(aed_.empty());
assert(!refcoord_.inited());
assert(!refival_.inited());
return true;
} else {
return false;
}
}
/**
* Return the identifier for the reference that the alignment
* occurred in.
*/
inline TRefId refid() const {
assert(shapeSet_);
return refcoord_.ref();
}
/**
* Return the orientation that the alignment occurred in.
*/
inline int orient() const {
assert(shapeSet_);
return refcoord_.orient();
}
/**
* Return the 0-based offset of the alignment into the reference
* sequence it aligned to.
*/
inline TRefOff refoff() const {
assert(shapeSet_);
return refcoord_.off();
}
/**
* Set arguments to coordinates for the upstream-most and downstream-most
* reference positions involved in the alignment.
*/
inline void getCoords(
Coord& st, // out: install starting coordinate here
Coord& en) // out: install ending coordinate here
const
{
assert(shapeSet_);
st.init(refcoord_);
en.init(refcoord_);
en.adjustOff(refExtent() - 1);
}
/**
* Set arguments to coordinates for the upstream-most and downstream-most
* reference positions covered by the read taking any read trimming into
* account. I.e. if the upstream-most offset involved in an alignment is
* 40 but the read was hard-trimmed by 5 on that end, the inferred
* upstream-most covered position is 35.
*/
inline void getExtendedCoords(
Coord& st, // out: install starting coordinate here
Coord& en, // out: install ending coordinate here
const AlnFlags& flags)
const
{
getCoords(st, en);
// Take trimming into account
if (!flags.scUnMapped()) {
int64_t trim_st = (fw() ? trim5p_ : trim3p_);
int64_t trim_en = (fw() ? trim3p_ : trim5p_);
trim_st += (fw() ? pretrim5p_ : pretrim3p_);
trim_en += (fw() ? pretrim3p_ : pretrim5p_);
st.adjustOff(-trim_st);
en.adjustOff( trim_en);
}
}
/**
* Set the upstream-most reference offset involved in the alignment, and
* the extent of the alignment (w/r/t the reference)
*/
void setShape(
TRefId id, // id of reference aligned to
TRefOff off, // offset of first aligned char into ref seq
TRefOff reflen, // length of reference sequence aligned to
bool fw, // aligned to Watson strand?
size_t rdlen, // length of read after hard trimming, before soft
bool pretrimSoft, // whether trimming prior to alignment was soft
size_t pretrim5p, // # poss trimmed form 5p end before alignment
size_t pretrim3p, // # poss trimmed form 3p end before alignment
bool trimSoft, // whether local-alignment trimming was soft
size_t trim5p, // # poss trimmed form 5p end during alignment
size_t trim3p); // # poss trimmed form 3p end during alignment
/**
* Return true iff the reference chars involved in this alignment result
* are entirely within with given bounds.
*/
bool within(
TRefId id,
TRefOff off,
bool fw,
size_t extent) const
{
if(refcoord_.ref() == id &&
refcoord_.off() >= off &&
refcoord_.off() + refExtent() <= off + extent &&
refcoord_.fw() == fw)
{
return true;
}
return false;
}
/**
* Set alignment score for this alignment.
*/
void setScore(AlnScore score) {
score_ = score;
}
/**
* Set the upstream-most and downstream-most nucleotides.
*/
void setNucs(bool fw, int nup, int ndn) {
nuc5p_ = fw ? nup : ndn;
nuc3p_ = fw ? ndn : nup;
}
/**
* Return the 0-based offset of the leftmost reference position involved in
* the alignment.
*/
const Coord& refcoord() const {
return refcoord_;
}
/**
* Return the 0-based offset of the leftmost reference position involved in
* the alignment.
*/
const Interval& refival() const {
return refival_;
}
/**
* Return the 0-based offset of the leftmost reference position involved in
* the alignment.
*/
Coord& refcoord() {
return refcoord_;
}
/**
* Return true if this alignment is to the Watson strand.
*/
inline bool fw() const {
return refcoord_.fw();
}
AlnScore score() const { return score_; }
AlnScore oscore() const { return oscore_; }
EList<Edit>& ned() { return ned_; }
EList<Edit>& aed() { return aed_; }
const EList<Edit>& ned() const { return ned_; }
const EList<Edit>& aed() const { return aed_; }
size_t readExtent() const { return rdextent_; }
size_t readExtentRows() const { return rdexrows_; }
size_t readLength() const { return rdlen_; }
/**
* Return the number of reference nucleotides involved in the alignment
* (i.e. the number of characters in the inclusive range from the first
* matched-up ref char to the last).
*/
size_t refExtent() const {
return rfextent_;
}
/**
* Return length of reference sequence aligned to.
*/
TRefOff reflen() const {
return reflen_;
}
/**
* Return the number of reference nucleotides in the alignment (i.e. the
* number of characters in the inclusive range from the first matched-up
* ref char to the last).
*/
size_t refNucExtent() const {
return rfextent_;
}
/**
* Print the sequence for the read that aligned using A, C, G and
* T. This will simply print the read sequence (or its reverse
* complement).
*/
void printSeq(
const Read& rd,
const BTDnaString* dns,
BTString& o) const;
/**
* Print the quality string for the read that aligned. This will
* simply print the read qualities (or their reverse).
*/
void printQuals(
const Read& rd,
const BTString* dqs,
BTString& o) const;
/**
* Print a stacked alignment with the reference on top, query on bottom,
* and lines connecting matched-up positions.
*/
void printStacked(
const Read& rd,
std::ostream& o) const
{
printStacked(refcoord_.fw() ? rd.patFw : rd.patRc, o);
}
/**
* Print a stacked alignment with the reference on bottom, query on top,
* and lines connecting matched-up positions.
*/
void printStacked(
const BTDnaString& seq,
std::ostream& o) const
{
Edit::printQAlign(o, seq, ned_);
// Print reference offset below reference string
o << "^" << std::endl;
o << "(" << refcoord_.ref() << "," << refcoord_.off() << ")" << std::endl;
}
#ifndef NDEBUG
/**
* Check that alignment score is internally consistent.
*/
bool repOk() const {
assert(refcoord_.repOk());
if(shapeSet_) {
assert_lt(refoff(), reflen_);
}
assert(refival_.repOk());
assert(VALID_AL_SCORE(score_) || ned_.empty());
assert(VALID_AL_SCORE(score_) || aed_.empty());
assert(empty() || refcoord_.inited());
assert(empty() || refival_.inited());
assert_geq(rdexrows_, rdextent_);
assert(empty() || rdextent_ > 0);
assert(empty() || rfextent_ > 0);
return true;
}
/**
* Check that alignment score is internally consistent.
*/
bool repOk(const Read& rd) const {
assert(Edit::repOk(ned_, refcoord_.fw() ? rd.patFw : rd.patRc,
refcoord_.fw(), trimmed5p(true), trimmed3p(true)));
return repOk();
}
#endif
#ifndef NDEBUG
/**
* Assuming this AlnRes is an alignment for 'rd', check that the
* alignment and 'rd' are compatible with the corresponding
* reference sequence.
*/
bool matchesRef(
const Read& rd,
const BitPairReference& ref,
BTDnaString& rf,
BTDnaString& rdseq,
BTString& qseq,
SStringExpandable<char>& raw_refbuf,
SStringExpandable<uint32_t>& destU32,
EList<bool>& matches);
#endif
/**
* Set information about the alignment parameters that led to this
* alignment.
*/
void setParams(
int seedmms,
int seedlen,
int seedival,
int64_t minsc)
{
seedmms_ = seedmms;
seedlen_ = seedlen;
seedival_ = seedival;
minsc_ = minsc;
}
// Accessors for alignment parameters
int seedmms() const { return seedmms_; }
int seedlen() const { return seedlen_; }
int seedival() const { return seedival_; }
int64_t minScore() const { return minsc_; }
/**
* Is the ith row from the 5' end of the DP table one of the ones
* soft-trimmed away by local alignment?
*/
inline bool trimmedRow5p(size_t i) const {
return i < trim5p_ || rdrows_ - i - 1 < trim3p_;
}
/**
* Is the ith character from the 5' end of read sequence one of the ones
* soft-trimmed away by local alignment?
*/
inline bool trimmedPos5p(size_t i) const {
return i < trim5p_ || rdlen_ - i - 1 < trim3p_;
}
/**
* Is the ith row from the 5' end of the DP table one of the ones that
* survived local-alignment soft trimming?
*/
inline bool alignedRow5p(size_t i) const {
return !trimmedRow5p(i);
}
/**
* Is the ith character from the 5' end of the read sequence one of the
* ones that survived local-alignment soft trimming?
*/
inline bool alignedPos5p(size_t i) const {
return !trimmedPos5p(i);
}
/**
* Return true iff this AlnRes and the given AlnRes overlap. Two AlnRess
* overlap if they share a cell in the overall dynamic programming table:
* i.e. if there exists a read position s.t. that position in both reads
* matches up with the same reference character. E.g., the following
* alignments (drawn schematically as paths through a dynamic programming
* table) are redundant:
*
* a b a b
* \ \ \ \
* \ \ \ \
* \ \ \ \
* ---\ \ \
* \ ---\---
* ---\ \ \
* \ \ \ \
* \ \ \ \
* \ \ \ \
* a b b a
*
* We iterate over each read position that hasn't been hard-trimmed, but
* only overlaps at positions that have also not been soft-trimmed are
* considered.
*/
bool overlap(AlnRes& res);
/**
* Return true iff this read was unpaired to begin with.
*/
inline bool readUnpaired() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_UNPAIRED;
}
/**
* Return true iff this alignment aligned in an unpaired fashion; not part
* of a concordant or discordant pair.
*/
inline bool alignedUnpaired() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_UNPAIRED ||
type_ == ALN_RES_TYPE_UNPAIRED_MATE1 ||
type_ == ALN_RES_TYPE_UNPAIRED_MATE2;
}
/**
* Return true iff this alignment aligned as mate #1 or mate #2 in a pair,
* either concordant or discordant.
*/
inline bool alignedPaired() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_MATE1 ||
type_ == ALN_RES_TYPE_MATE2;
}
/**
* Return true iff this read started as mate #1 in a pair.
*/
inline bool readMate1() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_MATE1 ||
type_ == ALN_RES_TYPE_UNPAIRED_MATE1;
}
/**
* Return true iff this read aligned as mate #1 in a concordant or
* discordant pair.
*/
inline bool alignedMate1() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_MATE1;
}
/**
* Return true iff this alignment aligned as mate #2 in a pair, either
* concordant or discordant.
*/
inline bool readMate2() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_MATE2 ||
type_ == ALN_RES_TYPE_UNPAIRED_MATE2;
}
/**
* Return true iff this read aligned as mate #2 in a concordant or
* discordant pair.
*/
inline bool alignedMate2() const {
assert_gt(type_, 0);
return type_ == ALN_RES_TYPE_MATE2;
}
/**
* Return true iff fragment length is set.
*/
bool isFraglenSet() const {
return fraglenSet_;
}
/**
* Set whether this alignment is unpaired, or is mate #1 or mate #2 in a
* paired-end alignment.
*/
void setMateParams(
int type,
const AlnRes* omate, // alignment result for the opposite mate
const AlnFlags& flags) // flags for this mate
{
assert_gt(type, 0);
type_ = type;
fraglen_ = 0;
if(omate != NULL) {
oscore_ = omate->score_;
// When should we calculate a fragment length here? There are a
// couple reasonable ideas:
// 1. When mates align concordantly
// 2. When both mates align to the same reference string
// BWA seems to do 2., so that's what we'll do here.
bool sameChr = true;
if((sameChr && refcoord_.ref() == omate->refcoord_.ref()) ||
flags.alignedConcordant())
{
setFragmentLength(*omate, flags);
} else {
assert(!isFraglenSet());
}
}
}
/**
* Assuming this alignment and the given alignment are at the extreme ends
* of a fragment, return the length of the fragment. We take all clipping,
* both hard and soft, into account here. Any clipping that occurred
* earlier and isn't accounted for within Bowtie2 should be accounted for
* by the user in how they set the maximum and minimum fragment length
* settings.
*/
int64_t setFragmentLength(const AlnRes& omate, const AlnFlags& flags) {
Coord st, en;
Coord ost, oen;
assert_eq(refid(), omate.refid());
getExtendedCoords(st, en, flags);
omate.getExtendedCoords(ost, oen, flags);
bool imUpstream;
if (st.off() == ost.off()) {
// --ff case
if (st.fw() && ost.fw() && readMate1()) {
imUpstream = true;
} else if (st.fw() && !ost.fw()) {
imUpstream = true;
} else {
imUpstream = false;
}
} else if (st.off() < ost.off()) {
imUpstream = true;
} else {
imUpstream = false;
}
TRefOff up = std::min(st.off(), ost.off());
TRefOff dn = std::max(en.off(), oen.off());
assert_geq(dn, up);
fraglen_ = 1 + dn - up;
if(!imUpstream) {
fraglen_ = -fraglen_;
}
fraglenSet_ = true;
return fraglen_;
}
/**
* Return fragment length inferred by a paired-end alignment, or -1 if the
* alignment is not part of a pair.
*/
int64_t fragmentLength() const {
assert_gt(type_, 0);
assert(fraglenSet_);
return fraglen_;
}
/**
* Initialize new AlnRes.
*/
void init(
size_t rdlen, // # chars after hard trimming
AlnScore score, // alignment score
const EList<Edit>* ned, // nucleotide edits
size_t ned_i, // first position to copy
size_t ned_n, // # positions to copy
const EList<Edit>* aed, // ambiguous base resolutions
size_t aed_i, // first position to copy
size_t aed_n, // # positions to copy
Coord refcoord, // leftmost ref pos of 1st al char
TRefOff reflen, // length of the reference
int seedmms = -1,// # seed mms allowed
int seedlen = -1,// seed length
int seedival = -1,// space between seeds
int64_t minsc = -1,// minimum score for valid aln
int nuc5p = -1,//
int nuc3p = -1,
bool pretrimSoft = false,
size_t pretrim5p = 0, // trimming prior to alignment
size_t pretrim3p = 0, // trimming prior to alignment
bool trimSoft = true,
size_t trim5p = 0, // trimming from alignment
size_t trim3p = 0);// trimming from alignment
/**
* Return number of bases trimmed from the 5' end. Argument determines
* whether we're counting hard- or soft-trimmed bases.
*/
size_t trimmed5p(bool soft) const {
size_t trim = 0;
if(pretrimSoft_ == soft) trim += pretrim5p_;
if(trimSoft_ == soft) trim += trim5p_;
return trim;
}
/**
* Return number of bases trimmed from the 3' end. Argument determines
* whether we're counting hard- or soft-trimmed bases.
*/
size_t trimmed3p(bool soft) const {
size_t trim = 0;
if(pretrimSoft_ == soft) trim += pretrim3p_;
if(trimSoft_ == soft) trim += trim3p_;
return trim;
}
/**
* Return number of bases trimmed from the left end. Argument determines
* whether we're counting hard- or soft-trimmed bases.
*/
size_t trimmedLeft(bool soft) const {
return fw() ? trimmed5p(soft) : trimmed3p(soft);
}
/**
* Return number of bases trimmed from the right end. Argument determines
* whether we're counting hard- or soft-trimmed bases.
*/
size_t trimmedRight(bool soft) const {
return fw() ? trimmed3p(soft) : trimmed5p(soft);
}
/**
* Set the number of reference Ns covered by the alignment.
*/
void setRefNs(size_t refns) {
refns_ = refns;
}
/**
* Return the number of reference Ns covered by the alignment.
*/
size_t refNs() const { return refns_; }
/**
* Clip away portions of the alignment that are outside the given bounds.
* Clipping is soft if soft == true, hard otherwise.
*/
void clipOutside(bool soft, TRefOff refi, TRefOff reff);
/**
* Soft trim bases from the LHS of the alignment.
*/
void clipLeft(size_t rd_amt, size_t rf_amt);
/**
* Soft trim bases from the RHS of the alignment.
*/
void clipRight(size_t rd_amt, size_t rf_amt);
/**
* In debug mode, we put a copy of the decoded nucleotide sequence here.
*/
ASSERT_ONLY(BTDnaString drd);
/**
* Return true iff this AlnRes should come before the given AlnRes in a
* prioritized list of results.
*/
bool operator<(const AlnRes& o) const {
return score_ > o.score_;
}
bool operator==(const AlnRes& o) const {
return
shapeSet_ == o.shapeSet_ &&
rdlen_ == o.rdlen_ &&
rdrows_ == o.rdrows_ &&
score_ == o.score_ &&
//oscore_ == o.oscore_ &&
ned_ == o.ned_ &&
aed_ == o.aed_ &&
refcoord_ == o.refcoord_ &&
reflen_ == o.reflen_ &&
refival_ == o.refival_ &&
rdextent_ == o.rdextent_ &&
rdexrows_ == o.rdexrows_ &&
rfextent_ == o.rfextent_ &&
seedmms_ == o.seedmms_ &&
seedlen_ == o.seedlen_ &&
seedival_ == o.seedival_ &&
minsc_ == o.minsc_ &&
nuc5p_ == o.nuc5p_ &&
nuc3p_ == o.nuc3p_ &&
refns_ == o.refns_ &&
type_ == o.type_ &&
fraglen_ == o.fraglen_ &&
pretrimSoft_ == o.pretrimSoft_ &&
pretrim5p_ == o.pretrim5p_ &&
pretrim3p_ == o.pretrim3p_ &&
trimSoft_ == o.trimSoft_ &&
trim5p_ == o.trim5p_ &&
trim3p_ == o.trim3p_;
}
/**
* Initialize a StackedAln (stacked alignment) object w/r/t this alignment.
*/
void initStacked(const Read& rd, StackedAln& st) const {
size_t trimLS = trimmed5p(true);
size_t trimLH = trimmed5p(false);
size_t trimRS = trimmed3p(true);
size_t trimRH = trimmed3p(false);
size_t len_trimmed = rd.length() - trimLS - trimRS;
if(!fw()) {
Edit::invertPoss(const_cast<EList<Edit>&>(ned_), len_trimmed, false);
swap(trimLS, trimRS);
swap(trimLH, trimRH);
}
st.init(
fw() ? rd.patFw : rd.patRc,
ned_, trimLS, trimLH, trimRS, trimRH);
if(!fw()) {
Edit::invertPoss(const_cast<EList<Edit>&>(ned_), len_trimmed, false);
}
}
protected:
/**
* Given that rdextent_ and ned_ are already set, calculate rfextent_.
*/
void calcRefExtent() {
assert_gt(rdextent_, 0);
rfextent_ = rdextent_;
for(size_t i = 0; i < ned_.size(); i++) {
if(ned_[i].isRefGap()) rfextent_--;
if(ned_[i].isReadGap()) rfextent_++;
}
}
bool shapeSet_; // true iff setShape() has been called
size_t rdlen_; // length of the original read
size_t rdrows_; // # rows in alignment problem
AlnScore score_; // best SW score found
AlnScore oscore_; // score of opposite mate
EList<Edit> ned_; // base edits
EList<Edit> aed_; // ambiguous base resolutions
Coord refcoord_; // ref coordinates (seq idx, offset, orient)
TRefOff reflen_; // reference length
Interval refival_; // ref interval (coord + length)
size_t rdextent_; // number of read chars involved in alignment
size_t rdexrows_; // number of read rows involved in alignment
size_t rfextent_; // number of ref chars involved in alignment
int seedmms_; // number of mismatches allowed in seed
int seedlen_; // length of seed
int seedival_; // interval between seeds
int64_t minsc_; // minimum score
int nuc5p_; // 5'-most decoded base; clipped if excluding end
int nuc3p_; // 3'-most decoded base; clipped if excluding end
size_t refns_; // # of reference Ns overlapped
int type_; // unpaired or mate #1 or mate #2?
bool fraglenSet_; // true iff a fragment length has been inferred
int64_t fraglen_; // inferred fragment length
// A tricky aspect of trimming is that we have to decide what the units are:
// read positions, reference positions??? We choose read positions here.
// In other words, if an alignment overhangs the end of the reference and
// part of the overhanging portion is a reference gap, we have to make sure
// the trim amount reflects the number of *read characters* to trim
// including the character opposite the reference gap.
// Nucleotide-sequence trimming
bool pretrimSoft_; // trimming prior to alignment is soft?
size_t pretrim5p_; // # bases trimmed from 5p end prior to alignment
size_t pretrim3p_; // # bases trimmed from 3p end prior to alignment
bool trimSoft_; // trimming by local alignment is soft?
size_t trim5p_; // # bases trimmed from 5p end by local alignment
size_t trim3p_; // # bases trimmed from 3p end by local alignment
};
/**
* Unique ID for a cell in the overall DP table. This is a helpful concept
* because of our definition of "redundnant". Two alignments are redundant iff
* they have at least one cell in common in the overall DP table.
*/
struct RedundantCell {
RedundantCell() {
rfid = 0;
fw = true;
rfoff = 0;
rdoff = 0;
}
RedundantCell(
TRefId rfid_,
bool fw_,
TRefOff rfoff_,
size_t rdoff_)
{
init(rfid_, fw_, rfoff_, rdoff_);
}
void init(
TRefId rfid_,
bool fw_,
TRefOff rfoff_,
size_t rdoff_)
{
rfid = rfid_;
fw = fw_;
rfoff = rfoff_;
rdoff = rdoff_;
}
/**
* Return true iff this RedundantCell is less than the given RedundantCell.
*/
inline bool operator<(const RedundantCell& c) const {
if(rfid < c.rfid) return true;
if(rfid > c.rfid) return false;
if(!fw && c.fw) return true;
if( fw && !c.fw) return false;
if(rfoff < c.rfoff) return true;
if(rfoff > c.rfoff) return false;
return rdoff < c.rdoff;
}
/**
* Return true iff this RedundantCell is greater than the given
* RedundantCell.
*/
inline bool operator>(const RedundantCell& c) const {
if(rfid > c.rfid) return true;
if(rfid < c.rfid) return false;
if( fw && !c.fw) return true;
if(!fw && c.fw) return false;
if(rfoff > c.rfoff) return true;
if(rfoff < c.rfoff) return false;
return rdoff > c.rdoff;
}
/**
* Return true iff this RedundantCell is equal to the given RedundantCell.
*/
inline bool operator==(const RedundantCell& c) const {
return
rfid == c.rfid &&
fw == c.fw &&
rfoff == c.rfoff &&
rdoff == c.rdoff;
}
TRefId rfid; // reference id
bool fw; // orientation
TRefOff rfoff; // column
size_t rdoff; // row
};
/**
* Encapsulates data structures and routines allowing client to determine
* whether one alignment is redundant (has a DP cell in common with) with a set
* of others.
*
* Adding cells to and checking cell against this data structure can get rather
* slow when there are many alignments in play. Dividing the burden over
* read-position bins helps some.
*/
class RedundantAlns {
public:
RedundantAlns(int cat = DP_CAT) : cells_(cat) { }
/**
* Empty the cell database.
*/
void reset() { cells_.clear(); }
/**
* Initialize and set the list of sets to equal the read length.
*/
void init(size_t npos) {
cells_.resize(npos);
for(size_t i = 0; i < npos; i++) {
cells_[i].clear();
}
}
/**
* Add all of the cells involved in the given alignment to the database.
*/
void add(const AlnRes& res);
/**
* Return true iff the given alignment has at least one cell that overlaps
* one of the cells in the database.
*/
bool overlap(const AlnRes& res);
protected:
EList<ESet<RedundantCell> > cells_;
};
typedef uint64_t TNumAlns;
/**
* Encapsulates a concise summary of a set of alignment results for a
* given pair or mate. Referring to the fields of this object should
* provide enough information to print output records for the read.
*/
class AlnSetSumm {
public:
AlnSetSumm() { reset(); }
/**
* Given an unpaired read (in either rd1 or rd2) or a read pair
* (mate 1 in rd1, mate 2 in rd2).
*/
explicit AlnSetSumm(
const Read* rd1,
const Read* rd2,
const EList<AlnRes>* rs1,
const EList<AlnRes>* rs2,
const EList<AlnRes>* rs1u,
const EList<AlnRes>* rs2u,
bool exhausted1,
bool exhausted2,
TRefId orefid,
TRefOff orefoff)
{
init(rd1, rd2, rs1, rs2, rs1u, rs2u, exhausted1, exhausted2,
orefid, orefoff);
}
explicit AlnSetSumm(
TNumAlns other1,
TNumAlns other2,
bool paired,
bool exhausted1,
bool exhausted2,
TRefId orefid,
TRefOff orefoff)
{
init(
other1,
other2,
paired,
exhausted1,
exhausted2,
orefid,
orefoff);
}
/**
* Set to uninitialized state.
*/
void reset() {
bestUScore_.invalidate();
bestP1Score_.invalidate();
bestP2Score_.invalidate();
bestCScore_.invalidate();
bestUDist_.invalidate();
bestP1Dist_.invalidate();
bestP2Dist_.invalidate();
bestCDist_.invalidate();
bestUnchosenUScore_.invalidate();
bestUnchosenP1Score_.invalidate();
bestUnchosenP2Score_.invalidate();
bestUnchosenCScore_.invalidate();
bestUnchosenUDist_.invalidate();
bestUnchosenP1Dist_.invalidate();
bestUnchosenP2Dist_.invalidate();
bestUnchosenCDist_.invalidate();
other1_ = other2_ = 0;
paired_ = false;
exhausted1_ = exhausted2_ = false;
orefid_ = -1;
orefoff_ = -1;
}
void init(
const Read* rd1,
const Read* rd2,
const EList<AlnRes>* rs1,
const EList<AlnRes>* rs2,
const EList<AlnRes>* rs1u,
const EList<AlnRes>* rs2u,
bool exhausted1,
bool exhausted2,
TRefId orefid,
TRefOff orefoff);
/**
* Initialize given fields. See constructor for how fields are set.
*/
void init(
TNumAlns other1,
TNumAlns other2,
bool paired,
bool exhausted1,
bool exhausted2,
TRefId orefid,
TRefOff orefoff)
{
other1_ = other1;
other2_ = other2;
paired_ = paired;
exhausted1_ = exhausted1;
exhausted2_ = exhausted2;
orefid_ = orefid;
orefoff_ = orefoff;
assert(repOk());
}
/**
* Return true iff there is at least a best alignment
*/
bool empty() const {
assert(repOk());
return !VALID_AL_SCORE(bestScore(true));
}
#ifndef NDEBUG
/**
* Check that the summary is internally consistent.
*/
bool repOk() const {
return true;
}
#endif
TNumAlns other1() const { return other1_; }
TNumAlns other2() const { return other2_; }
bool paired() const { return paired_; }
bool exhausted1() const { return exhausted1_; }
bool exhausted2() const { return exhausted2_; }
TRefId orefid() const { return orefid_; }
TRefOff orefoff() const { return orefoff_; }
AlnScore bestUScore() const { return bestUScore_; }
AlnScore bestP1Score() const { return bestP1Score_; }
AlnScore bestP2Score() const { return bestP2Score_; }
AlnScore bestCScore() const { return bestCScore_; }
AlnScore bestUDist() const { return bestUDist_; }
AlnScore bestP1Dist() const { return bestP1Dist_; }
AlnScore bestP2Dist() const { return bestP2Dist_; }
AlnScore bestCDist() const { return bestCDist_; }
AlnScore bestUnchosenUScore() const { return bestUnchosenUScore_; }
AlnScore bestUnchosenP1Score() const { return bestUnchosenP1Score_; }
AlnScore bestUnchosenP2Score() const { return bestUnchosenP2Score_; }
AlnScore bestUnchosenCScore() const { return bestUnchosenCScore_; }
AlnScore bestUnchosenUDist() const { return bestUnchosenUDist_; }
AlnScore bestUnchosenP1Dist() const { return bestUnchosenP1Dist_; }
AlnScore bestUnchosenP2Dist() const { return bestUnchosenP2Dist_; }
AlnScore bestUnchosenCDist() const { return bestUnchosenCDist_; }
/**
* Return best unchosen alignment score for end 1 or 2 of a pair.
*/
AlnScore bestUnchosenPScore(bool mate1) const {
return mate1 ? bestUnchosenP1Score_ : bestUnchosenP2Score_;
}
/**
* Return best unchosen edit distance for end 1 or 2 of a pair.
*/
AlnScore bestUnchosenPDist(bool mate1) const {
return mate1 ? bestUnchosenP1Dist_ : bestUnchosenP2Dist_;
}
/**
* Return best unchosen alignment score for end 1 or 2 whether
* the read is a pair or not.
*/
AlnScore bestUnchosenScore(bool mate1) const {
return paired_ ? (mate1 ? bestUnchosenP1Score_ : bestUnchosenP2Score_) : bestUnchosenUScore();
}
/**
* Return best unchosen edit distance for end 1 or 2 whether
* the read is a pair or not.
*/
AlnScore bestUnchosenDist(bool mate1) const {
return paired_ ? (mate1 ? bestUnchosenP1Dist_ : bestUnchosenP2Dist_) : bestUnchosenUDist();
}
bool exhausted(bool mate1) const {
return mate1 ? exhausted1_ : exhausted2_;
}
/**
* Return best alignment score for end 1 or 2 whether the read is
* a pair or not.
*/
AlnScore bestScore(bool mate1) const {
return paired_ ? (mate1 ? bestP1Score_ : bestP2Score_) : bestUScore_;
}
/**
* Return best edit distance for end 1 or 2 whether the read is
* a pair or not.
*/
AlnScore bestDist(bool mate1) const {
return paired_ ? (mate1 ? bestP1Dist_ : bestP2Dist_) : bestUDist_;
}
/**
* Add information about unchosen alignments to the summary. This is
* in its own "setter" function because it's not known until we've
* picked which alignment to report, which is after we've initially
* constructed the summary.
*
* Info about unchosen alignments is used for predicting mapping
* quality.
*/
void setBest(
AlnScore bestUScore,
AlnScore bestUDist,
AlnScore bestP1Score,
AlnScore bestP1Dist,
AlnScore bestP2Score,
AlnScore bestP2Dist,
AlnScore bestCScore,
AlnScore bestCDist,
AlnScore bestUnchosenUScore,
AlnScore bestUnchosenUDist,
AlnScore bestUnchosenP1Score,
AlnScore bestUnchosenP1Dist,
AlnScore bestUnchosenP2Score,
AlnScore bestUnchosenP2Dist,
AlnScore bestUnchosenCScore,
AlnScore bestUnchosenCDist)
{
assert(bestUScore.valid() == bestUDist.valid());
assert(bestP1Score.valid() == bestP1Dist.valid());
assert(bestP2Score.valid() == bestP2Dist.valid());
assert(bestCScore.valid() == bestCDist.valid());
assert(bestUnchosenUScore.valid() == bestUnchosenUDist.valid());
assert(bestUnchosenP1Score.valid() == bestUnchosenP1Dist.valid());
assert(bestUnchosenP2Score.valid() == bestUnchosenP2Dist.valid());
assert(bestUnchosenCScore.valid() == bestUnchosenCDist.valid());
bestUScore_ = bestUScore;
bestUDist_ = bestUDist;
bestP1Score_ = bestP1Score;
bestP1Dist_ = bestP1Dist;
bestP2Score_ = bestP2Score;
bestP2Dist_ = bestP2Dist;
bestCScore_ = bestCScore;
bestCDist_ = bestCDist;
bestUnchosenUScore_ = bestUnchosenUScore;
bestUnchosenUDist_ = bestUnchosenUDist;
bestUnchosenP1Score_ = bestUnchosenP1Score;
bestUnchosenP1Dist_ = bestUnchosenP1Dist;
bestUnchosenP2Score_ = bestUnchosenP2Score;
bestUnchosenP2Dist_ = bestUnchosenP2Dist;
bestUnchosenCScore_ = bestUnchosenCScore;
bestUnchosenCDist_ = bestUnchosenCDist;
}
protected:
TNumAlns other1_; // # more alignments within N points of second-best
TNumAlns other2_; // # more alignments within N points of second-best
bool paired_; // results are paired
bool exhausted1_; // searched exhaustively for mate 1 alignments?
bool exhausted2_; // searched exhaustively for mate 2 alignments?
TRefId orefid_;
TRefOff orefoff_;
AlnScore bestUScore_;
AlnScore bestUDist_;
AlnScore bestP1Score_;
AlnScore bestP1Dist_;
AlnScore bestP2Score_;
AlnScore bestP2Dist_;
AlnScore bestCScore_;
AlnScore bestCDist_;
AlnScore bestUnchosenUScore_;
AlnScore bestUnchosenUDist_;
AlnScore bestUnchosenP1Score_;
AlnScore bestUnchosenP1Dist_;
AlnScore bestUnchosenP2Score_;
AlnScore bestUnchosenP2Dist_;
AlnScore bestUnchosenCScore_;
AlnScore bestUnchosenCDist_;
};
#endif
|