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
|
// --------------------------------------------------------------------------
// OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// This software is released under a three-clause BSD license:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of any author or any participating institution
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Marc Sturm, Lars Nilse, Chris Bielow, Hendrik Brauer $
// --------------------------------------------------------------------------
#include <OpenMS/KERNEL/ConsensusMap.h>
#include <OpenMS/KERNEL/ChromatogramTools.h>
#include <OpenMS/KERNEL/RangeUtils.h>
#include <OpenMS/DATASTRUCTURES/StringList.h>
#include <OpenMS/FORMAT/IdXMLFile.h>
#include <OpenMS/FORMAT/FileHandler.h>
#include <OpenMS/FORMAT/FileTypes.h>
#include <OpenMS/FORMAT/MzMLFile.h>
#include <OpenMS/FORMAT/FeatureXMLFile.h>
#include <OpenMS/FORMAT/ConsensusXMLFile.h>
#include <OpenMS/FILTERING/NOISEESTIMATION/SignalToNoiseEstimatorMedian.h>
#include <OpenMS/APPLICATIONS/TOPPBase.h>
using namespace OpenMS;
using namespace std;
//-------------------------------------------------------------
//Doxygen docu
//-------------------------------------------------------------
/**
@page TOPP_FileFilter FileFilter
@brief Extracts portions of the data from an mzML, featureXML or consensusXML file.
<center>
<table>
<tr>
<td ALIGN = "center" BGCOLOR="#EBEBEB"> pot. predecessor tools </td>
<td VALIGN="middle" ROWSPAN=2> \f$ \longrightarrow \f$ FileFilter \f$ \longrightarrow \f$</td>
<td ALIGN = "center" BGCOLOR="#EBEBEB"> pot. successor tools </td>
</tr>
<tr>
<td VALIGN="middle" ALIGN = "center" ROWSPAN=1> any tool yielding output @n in mzML, featureXML @n or consensusXML format</td>
<td VALIGN="middle" ALIGN = "center" ROWSPAN=1> any tool that profits on reduced input </td>
</tr>
</table>
</center>
With this tool it is possible to extract m/z, retention time and intensity ranges from an input file
and to write all data that lies within the given ranges to an output file.
Depending on the input file type, additional specific operations are possible:
- mzML
- extract spectra of a certain MS level
- filter by signal-to-noise estimation
- filter by scan mode of the spectra
- remove MS2 scans whose precursor matches identifications (from an idXML file in 'id:blacklist')
- featureXML
- filter by feature charge
- filter by feature size (number of subordinate features)
- filter by overall feature quality
- consensusXML
- filter by size (number of elements in consensus features)
- filter by consensus feature charge
- filter by map (extracts specified maps and re-evaluates consensus centroid)@n e.g. FileFilter -map 2 3 5 -in file1.consensusXML -out file2.consensusXML@n If a single map is specified, the feature itself can be extracted.@n e.g. FileFilter -map 5 -in file1.consensusXML -out file2.featureXML
- featureXML / consensusXML:
- remove items with a certain meta value annotation. Allowing for >, < and = comparisons. List types are compared by length, not content. Integer, Double and String are compared using their build-in operators.
- filter sequences, e.g. "LYSNLVER" or the modification "(Phospho)"@n e.g. FileFilter -id:sequences_whitelist Phospho -in file1.consensusXML -out file2.consensusXML
- filter accessions, e.g. "sp|P02662|CASA1_BOVIN"
- remove features with annotations
- remove features without annotations
- remove unassigned peptide identifications
- filter id with best score of features with multiple peptide identifications@n e.g. FileFilter -id:remove_unannotated_features -id:remove_unassigned_ids -id:keep_best_score_id -in file1.featureXML -out file2.featureXML
- remove features with id clashes (different sequences mapped to one feature)
The priority of the id-flags is (decreasing order): remove_annotated_features / remove_unannotated_features -> remove_clashes -> keep_best_score_id -> sequences_whitelist / accessions_whitelist
MS2 and higher spectra can be filtered according to precursor m/z (see 'pc_mz'). This flag can be combined with 'rt' range to filter precursors by RT and m/z.
If you want to extract an MS1 region with untouched MS2 spectra included, you will need to split the dataset by MS level and use 'mz' option for MS1 and 'pc_mz' for MS2 data.
Then merge them again. RT can be filtered at any step.
<B>The command line parameters of this tool are:</B>
@verbinclude TOPP_FileFilter.cli
<B>INI file documentation of this tool:</B>
@htmlinclude TOPP_FileFilter.html
For the parameters of the S/N algorithm section see the class documentation there: @n
@ref OpenMS::SignalToNoiseEstimatorMedian "peak_options:sn"@n
@todo add tests for selecting modes (port remove modes) (Andreas)
*/
// We do not want this class to show up in the docu:
/// @cond TOPPCLASSES
class TOPPFileFilter :
public TOPPBase
{
public:
TOPPFileFilter() :
TOPPBase("FileFilter", "Extracts or manipulates portions of data from peak, feature or consensus-feature files.")
{
}
private:
static bool checkPeptideIdentification_(BaseFeature& feature, const bool remove_annotated_features, const bool remove_unannotated_features, const StringList& sequences, const StringList& accessions, const bool keep_best_score_id, const bool remove_clashes)
{
//flag: remove_annotated_features and non-empty peptideIdentifications
if (remove_annotated_features && !feature.getPeptideIdentifications().empty())
{
return false;
}
//flag: remove_unannotated_features and no peptideIdentifications
if (remove_unannotated_features && feature.getPeptideIdentifications().empty())
{
return false;
}
//flag: remove_clashes
if (remove_clashes && !feature.getPeptideIdentifications().empty())
{
String temp = feature.getPeptideIdentifications().begin()->getHits().begin()->getSequence().toString();
//loop over all peptideIdentifications
for (vector<PeptideIdentification>::const_iterator pep_id_it = feature.getPeptideIdentifications().begin(); pep_id_it != feature.getPeptideIdentifications().end(); ++pep_id_it)
{
//loop over all peptideHits
for (vector<PeptideHit>::const_iterator pep_hit_it = pep_id_it->getHits().begin(); pep_hit_it != pep_id_it->getHits().end(); ++pep_hit_it)
{
if (pep_hit_it->getSequence().toString() != temp)
{
return false;
}
}
}
}
//flag: keep_best_score_id
if (keep_best_score_id && !feature.getPeptideIdentifications().empty())
{
PeptideIdentification temp = feature.getPeptideIdentifications().front();
//loop over all peptideIdentifications
for (vector<PeptideIdentification>::const_iterator pep_id_it = feature.getPeptideIdentifications().begin(); pep_id_it != feature.getPeptideIdentifications().end(); ++pep_id_it)
{
//loop over all peptideHits
for (vector<PeptideHit>::const_iterator pep_hit_it = pep_id_it->getHits().begin(); pep_hit_it != pep_id_it->getHits().end(); ++pep_hit_it)
{
if ((pep_id_it->isHigherScoreBetter() && pep_hit_it->getScore() > temp.getHits().front().getScore()) ||
(!pep_id_it->isHigherScoreBetter() && pep_hit_it->getScore() < temp.getHits().front().getScore()))
{
temp = *pep_id_it;
}
}
}
feature.setPeptideIdentifications(vector<PeptideIdentification>(1, temp));
// not filtering sequences or accessions
if (sequences.empty() && accessions.empty())
{
return true;
}
}
//flag: sequences or accessions
if (sequences.size() > 0 || accessions.size() > 0)
{
bool sequen = false;
bool access = false;
//loop over all peptideIdentifications
for (vector<PeptideIdentification>::const_iterator pep_id_it = feature.getPeptideIdentifications().begin(); pep_id_it != feature.getPeptideIdentifications().end(); ++pep_id_it)
{
//loop over all peptideHits
for (vector<PeptideHit>::const_iterator pep_hit_it = pep_id_it->getHits().begin(); pep_hit_it != pep_id_it->getHits().end(); ++pep_hit_it)
{
//loop over all sequence entries of the StringList
for (StringList::ConstIterator seq_it = sequences.begin(); seq_it != sequences.end(); ++seq_it)
{
if (pep_hit_it->getSequence().toString().hasSubstring(*seq_it)
|| pep_hit_it->getSequence().toUnmodifiedString().hasSubstring(*seq_it))
{
sequen = true;
}
}
//loop over all accessions of the peptideHits
for (vector<String>::const_iterator p_acc_it = pep_hit_it->getProteinAccessions().begin(); p_acc_it != pep_hit_it->getProteinAccessions().end(); ++p_acc_it)
{
//loop over all accessions entries of the StringList
for (StringList::ConstIterator acc_it = accessions.begin(); acc_it != accessions.end(); ++acc_it)
{
if (p_acc_it->hasSubstring(*acc_it))
{
access = true;
}
}
}
}
}
if (sequences.size() > 0 && accessions.size() > 0)
{
return sequen && access;
}
if (sequences.size() > 0)
{
return sequen;
}
else
{
return access;
}
}
return true;
}
protected:
typedef MSExperiment<Peak1D> MapType;
void registerOptionsAndFlags_()
{
String formats("mzML,featureXML,consensusXML");
registerInputFile_("in", "<file>", "", "input file ");
setValidFormats_("in", StringList::create(formats));
registerStringOption_("in_type", "<type>", "", "input file type -- default: determined from file extension or content\n", false);
setValidStrings_("in_type", StringList::create(formats));
registerOutputFile_("out", "<file>", "", "output file");
setValidFormats_("out", StringList::create(formats));
registerStringOption_("out_type", "<type>", "", "output file type -- default: determined from file extension or content\n", false);
setValidStrings_("out_type", StringList::create(formats));
registerStringOption_("rt", "[min]:[max]", ":", "retention time range to extract", false);
registerStringOption_("mz", "[min]:[max]", ":", "m/z range to extract (applies to ALL ms levels!)", false);
registerStringOption_("pc_mz", "[min]:[max]", ":", "MSn (n>=2) precursor filtering according to their m/z value. Do not use this flag in conjunction with 'mz', unless you want to actually remove peaks in spectra (see 'mz'). RT filtering is covered by 'rt' and compatible with this flag.", false);
registerStringOption_("int", "[min]:[max]", ":", "intensity range to extract", false);
registerFlag_("sort", "sorts the output according to RT and m/z.");
registerTOPPSubsection_("peak_options", "Peak data options");
registerDoubleOption_("peak_options:sn", "<s/n ratio>", 0, "write peaks with S/N > 'sn' values only", false);
registerIntList_("peak_options:rm_pc_charge", "i j ...", IntList(), "Remove MS(2) spectra with these precursor charges. All spectra without precursor are kept!", false);
registerIntList_("peak_options:level", "i j ...", IntList::create("1,2,3"), "MS levels to extract", false);
registerFlag_("peak_options:sort_peaks", "sorts the peaks according to m/z.");
registerFlag_("peak_options:no_chromatograms", "No conversion to space-saving real chromatograms, e.g. from SRM scans.");
registerFlag_("peak_options:remove_chromatograms", "Removes chromatograms stored in a file.");
registerStringOption_("peak_options:mz_precision", "32 or 64", 64, "Store base64 encoded m/z data using 32 or 64 bit precision.", false);
setValidStrings_("peak_options:mz_precision", StringList::create("32,64"));
registerStringOption_("peak_options:int_precision", "32 or 64", 32, "Store base64 encoded intensity data using 32 or 64 bit precision.", false);
setValidStrings_("peak_options:int_precision", StringList::create("32,64"));
registerTOPPSubsection_("spectra", "Remove spectra or select spectra (removing all others) with certain properties.");
registerFlag_("spectra:remove_zoom", "Remove zoom (enhanced resolution) scans");
registerStringOption_("spectra:remove_mode", "<mode>", "", "Remove scans by scan mode\n", false);
StringList mode_list;
for (Size i = 0; i < InstrumentSettings::SIZE_OF_SCANMODE; ++i)
{
mode_list.push_back(InstrumentSettings::NamesOfScanMode[i]);
}
setValidStrings_("spectra:remove_mode", mode_list);
addEmptyLine_();
registerStringOption_("spectra:remove_activation", "<activation>", "", "Remove MSn scans where any of its precursors features a certain activation method\n", false);
StringList activation_list;
for (Size i = 0; i < Precursor::SIZE_OF_ACTIVATIONMETHOD; ++i)
{
activation_list.push_back(Precursor::NamesOfActivationMethod[i]);
}
setValidStrings_("spectra:remove_activation", activation_list);
registerStringOption_("spectra:remove_collision_energy", "[min]:[max]", ":", "Remove MSn scans with a collision energy in the given interval.", false);
registerStringOption_("spectra:remove_isolation_window_width", "[min]:[max]", ":", "Remove MSn scans whichs isolation window width is in the given interval.", false);
addEmptyLine_();
registerFlag_("spectra:select_zoom", "Select zoom (enhanced resolution) scans");
registerStringOption_("spectra:select_mode", "<mode>", "", "Selects scans by scan mode\n", false);
setValidStrings_("spectra:select_mode", mode_list);
registerStringOption_("spectra:select_activation", "<activation>", "", "Select MSn scans where any of its precursors features a certain activation method\n", false);
setValidStrings_("spectra:select_activation", activation_list);
registerStringOption_("spectra:select_collision_energy", "[min]:[max]", ":", "Select MSn scans with a collision energy in the given interval.", false);
registerStringOption_("spectra:select_isolation_window_width", "[min]:[max]", ":", "Select MSn scans whichs isolation window width is in the given interval.", false);
addEmptyLine_();
registerTOPPSubsection_("feature", "Feature data options");
registerStringOption_("feature:q", "[min]:[max]", ":", "Overall quality range to extract [0:1]", false);
addEmptyLine_();
registerTOPPSubsection_("consensus", "Consensus feature data options");
registerIntList_("consensus:map", "i j ...", IntList::create(""), "maps to be extracted from a consensus", false);
registerFlag_("consensus:map_and", "Consensus features are kept only if they contain exactly one feature from each map (as given above in 'map').");
// black and white listing
registerTOPPSubsection_("consensus:blackorwhitelist", "Black or white listing of of MS2 spectra by consensus features.");
StringList truefalse;
truefalse << "false" << "true";
registerStringOption_("consensus:blackorwhitelist:blacklist", "", "true", "True: remove matched MS2. False: retain matched MS2 spectra. Other levels are kept.", false, false);
setValidStrings_("consensus:blackorwhitelist:blacklist", truefalse);
registerInputFile_("consensus:blackorwhitelist:file", "<file>", "", "Input file containing consensus features whose corresponding MS2 spectra should be removed from the mzML file!\n"
"Matching tolerances are taken from 'consensus:blackorwhitelist:rt' and 'consensus:blackorwhitelist:mz' options.\n"
"If consensus:blackorwhitelist:maps is specified, only these will be used.\n", false);
setValidFormats_("consensus:blackorwhitelist:file", StringList::create("consensusXML"));
registerIntList_("consensus:blackorwhitelist:maps", "i j ...", IntList::create(""), "maps used for black/white list filtering.", false);
registerDoubleOption_("consensus:blackorwhitelist:rt", "tolerance", 60.0, "retention tolerance [s] for precursor to consensus feature position", false);
registerDoubleOption_("consensus:blackorwhitelist:mz", "tolerance", 0.01, "m/z tolerance [Th] for precursor to consensus feature position", false);
registerStringOption_("consensus:blackorwhitelist:use_ppm_tolerance", "", "false", "If ppm tolerance should be used. Otherwise Da are used.", false, false);
setValidStrings_("consensus:blackorwhitelist:use_ppm_tolerance", truefalse);
setMinFloat_("consensus:blackorwhitelist:rt", 0);
setMinFloat_("consensus:blackorwhitelist:mz", 0);
addEmptyLine_();
registerTOPPSubsection_("f_and_c", "Feature & Consensus data options");
registerStringOption_("f_and_c:charge", "[min]:[max]", ":", "charge range to extract", false);
registerStringOption_("f_and_c:size", "[min]:[max]", ":", "size range to extract", false);
registerStringList_("f_and_c:remove_meta", "<name> 'lt|eq|gt' <value>", StringList(), "Expects a 3-tuple (=3 entries in the list), i.e. <name> 'lt|eq|gt' <value>; the first is the name of meta value, followed by the comparison operator (equal, less or greater) and the value to compare to. All comparisons are done after converting the given value to the corresponding data value type of the meta value (for lists, this simply compares length, not content!)!", false);
addEmptyLine_();
registerTOPPSubsection_("id", "ID options. The Priority of the id-flags is: remove_annotated_features / remove_unannotated_features -> remove_clashes -> keep_best_score_id -> sequences_whitelist / accessions_whitelist.");
registerFlag_("id:remove_clashes", "remove features with id clashes (different sequences mapped to one feature)", true);
registerFlag_("id:keep_best_score_id", "in case of multiple peptide identifications, keep only the id with best score");
registerStringList_("id:sequences_whitelist", "<sequence>", StringList(), "keep only features with white listed sequences, e.g. LYSNLVER or the modification (Oxidation)", false);
registerStringList_("id:accessions_whitelist", "<accessions>", StringList(), "keep only features with white listed accessions, e.g. sp|P02662|CASA1_BOVIN", false);
registerFlag_("id:remove_annotated_features", "remove features with annotations");
registerFlag_("id:remove_unannotated_features", "remove features without annotations");
registerFlag_("id:remove_unassigned_ids", "remove unassigned peptide identifications");
registerInputFile_("id:blacklist", "<file>", "", "Input file containing MS2 identifications whose corresponding MS2 spectra should be removed from the mzML file!\n"
"Matching tolerances are taken from 'id:rt' and 'id:mz' options.\n"
"This tool will require all IDs to be matched to an MS2 spectrum, and quit with error otherwise. Use 'id:blacklist_imperfect' to allow for mismatches.", false);
setValidFormats_("id:blacklist", StringList::create("idXML"));
registerDoubleOption_("id:rt", "tolerance", 0.1, "retention tolerance [s] for precursor to id position", false);
registerDoubleOption_("id:mz", "tolerance", 0.001, "m/z tolerance [Th] for precursor to id position", false);
setMinFloat_("id:rt", 0);
setMinFloat_("id:mz", 0);
registerFlag_("id:blacklist_imperfect", "Allow for mismatching precursor positions (see 'id:blacklist')");
addEmptyLine_();
registerSubsection_("algorithm", "S/N algorithm section");
}
Param getSubsectionDefaults_(const String& /*section*/) const
{
SignalToNoiseEstimatorMedian<MapType::SpectrumType> sn;
Param tmp;
tmp.insert("SignalToNoise:", sn.getParameters());
return tmp;
}
bool checkMetaOk(const MetaInfoInterface& mi, const StringList& meta_info)
{
if (!mi.metaValueExists(meta_info[0])) return true; // not having the meta value means passing the test
DataValue v_data = mi.getMetaValue(meta_info[0]);
DataValue v_user;
if (v_data.valueType() == DataValue::STRING_VALUE) v_user = String(meta_info[2]);
else if (v_data.valueType() == DataValue::INT_VALUE) v_user = String(meta_info[2]).toInt();
else if (v_data.valueType() == DataValue::DOUBLE_VALUE) v_user = String(meta_info[2]).toDouble();
else if (v_data.valueType() == DataValue::STRING_LIST) v_user = StringList::create(meta_info[2]);
else if (v_data.valueType() == DataValue::INT_LIST) v_user = IntList::create(meta_info[2]);
else if (v_data.valueType() == DataValue::DOUBLE_LIST) v_user = DoubleList::create(meta_info[2]);
else if (v_data.valueType() == DataValue::EMPTY_VALUE) v_user = DataValue::EMPTY;
if (meta_info[1] == "lt")
{
return !(v_data < v_user);
}
else if (meta_info[1] == "eq")
{
return !(v_data == v_user);
}
else if (meta_info[1] == "gt")
{
return !(v_data > v_user);
}
else
{
writeLog_("Internal Error. Meta value filtering got invalid comparison operator ('" + meta_info[1] + "'), which should have been caught before! Aborting!");
throw Exception::IllegalArgument(__FILE__, __LINE__, __PRETTY_FUNCTION__, "Illegal meta value filtering operator!");
}
}
ExitCodes main_(int, const char**)
{
//-------------------------------------------------------------
// parameter handling
//-------------------------------------------------------------
//input file name and type
String in = getStringOption_("in");
FileHandler fh;
FileTypes::Type in_type = fh.getType(in);
//only use flag in_type, if the in_type cannot be determined by file
if (in_type == FileTypes::UNKNOWN)
{
in_type = FileTypes::nameToType(getStringOption_("in_type"));
writeDebug_(String("Input file type: ") + FileTypes::typeToName(in_type), 2);
}
//output file name and type
String out = getStringOption_("out");
FileTypes::Type out_type = fh.getTypeByFileName(out);
//only use flag out_type, if the out_type cannot be determined by file
if (out_type == FileTypes::UNKNOWN)
{
out_type = FileTypes::nameToType(getStringOption_("out_type"));
writeDebug_(String("Output file type: ") + FileTypes::typeToName(out_type), 2);
}
//use in_type as out_type, if out_type cannot be determined by file or out_type flag
if (out_type == FileTypes::UNKNOWN)
{
out_type = in_type;
writeDebug_(String("Output file type: ") + FileTypes::typeToName(out_type), 2);
}
bool no_chromatograms(getFlag_("peak_options:no_chromatograms"));
//ranges
double mz_l, mz_u, rt_l, rt_u, it_l, it_u, charge_l, charge_u, size_l, size_u, q_l, q_u, pc_left, pc_right, select_collision_l, remove_collision_l, select_collision_u, remove_collision_u, select_isolation_width_l, remove_isolation_width_l, select_isolation_width_u, remove_isolation_width_u;
//initialize ranges
mz_l = rt_l = it_l = charge_l = size_l = q_l = pc_left = select_collision_l = remove_collision_l = select_isolation_width_l = remove_isolation_width_l = -1 * numeric_limits<double>::max();
mz_u = rt_u = it_u = charge_u = size_u = q_u = pc_right = select_collision_u = remove_collision_u = select_isolation_width_u = remove_isolation_width_u = numeric_limits<double>::max();
String rt = getStringOption_("rt");
String mz = getStringOption_("mz");
String pc_mz = getStringOption_("pc_mz");
String it = getStringOption_("int");
IntList levels = getIntList_("peak_options:level");
IntList maps = getIntList_("consensus:map");
double sn = getDoubleOption_("peak_options:sn");
String charge = getStringOption_("f_and_c:charge");
String size = getStringOption_("f_and_c:size");
String q = getStringOption_("feature:q");
String remove_collision_energy = getStringOption_("spectra:remove_collision_energy");
String select_collision_energy = getStringOption_("spectra:select_collision_energy");
String remove_isolation_width = getStringOption_("spectra:remove_isolation_window_width");
String select_isolation_width = getStringOption_("spectra:select_isolation_window_width");
int mz32 = getStringOption_("peak_options:mz_precision").toInt();
int int32 = getStringOption_("peak_options:int_precision").toInt();
//id-filtering parameters
bool remove_annotated_features = getFlag_("id:remove_annotated_features");
bool remove_unannotated_features = getFlag_("id:remove_unannotated_features");
bool remove_unassigned_ids = getFlag_("id:remove_unassigned_ids");
StringList sequences = getStringList_("id:sequences_whitelist");
StringList accessions = getStringList_("id:accessions_whitelist");
bool keep_best_score_id = getFlag_("id:keep_best_score_id");
bool remove_clashes = getFlag_("id:remove_clashes");
//convert bounds to numbers
try
{
//rt
parseRange_(rt, rt_l, rt_u);
//mz
parseRange_(mz, mz_l, mz_u);
//mz precursor
parseRange_(pc_mz, pc_left, pc_right);
//int
parseRange_(it, it_l, it_u);
//charge (features only)
parseRange_(charge, charge_l, charge_u);
//size (features and consensus features only)
parseRange_(size, size_l, size_u);
//overall quality (features only)
parseRange_(q, q_l, q_u);
//remove collision energy
parseRange_(remove_collision_energy, remove_collision_l, remove_collision_u);
//select collision energy
parseRange_(select_collision_energy, select_collision_l, select_collision_u);
//remove isolation window width
parseRange_(remove_isolation_width, remove_isolation_width_l, remove_isolation_width_u);
//select isolation window width
parseRange_(select_isolation_width, select_isolation_width_l, select_isolation_width_u);
}
catch (Exception::ConversionError&)
{
String tmp;
for (IntList::iterator it = levels.begin(); it != levels.end(); ++it)
{
tmp += *it;
}
writeLog_("Invalid boundary '" + tmp + "' given. Aborting!");
printUsage_();
return ILLEGAL_PARAMETERS;
}
// sort by RT and m/z
bool sort = getFlag_("sort");
writeDebug_("Sorting output data: " + String(sort), 3);
// handle remove_meta
StringList meta_info = getStringList_("f_and_c:remove_meta");
bool remove_meta_enabled = (meta_info.size() > 0);
if (remove_meta_enabled && meta_info.size() != 3)
{
writeLog_("Param 'f_and_c:remove_meta' has invalid number of arguments. Expected 3, got " + String(meta_info.size()) + ". Aborting!");
printUsage_();
return ILLEGAL_PARAMETERS;
}
if (remove_meta_enabled && !(meta_info[1] == "lt" || meta_info[1] == "eq" || meta_info[1] == "gt"))
{
writeLog_("Param 'f_and_c:remove_meta' has invalid second argument. Expected one of 'lt', 'eq' or 'gt'. Got '" + meta_info[1] + "'. Aborting!");
printUsage_();
return ILLEGAL_PARAMETERS;
}
if (in_type == FileTypes::MZML)
{
//-------------------------------------------------------------
// loading input
//-------------------------------------------------------------
MzMLFile f;
f.setLogType(log_type_);
f.getOptions().setRTRange(DRange<1>(rt_l, rt_u));
f.getOptions().setMZRange(DRange<1>(mz_l, mz_u));
f.getOptions().setIntensityRange(DRange<1>(it_l, it_u));
f.getOptions().setMSLevels(levels);
// set precision options
if (mz32 == 32) { f.getOptions().setMz32Bit(true); }else if (mz32 == 64) { f.getOptions().setMz32Bit(false); }
if (int32 == 32) { f.getOptions().setIntensity32Bit(true); }else if (int32 == 64) { f.getOptions().setIntensity32Bit(false); }
MapType exp;
f.load(in, exp);
// remove spectra with meta values:
if (remove_meta_enabled)
{
MapType exp_tmp;
for (MapType::ConstIterator it = exp.begin(); it != exp.end(); ++it)
{
if (checkMetaOk(*it, meta_info)) exp_tmp.addSpectrum(*it);
}
exp.clear(false);
exp.getSpectra().insert(exp.begin(), exp_tmp.begin(), exp_tmp.end());
}
if (!no_chromatograms)
{
// convert the spectra chromatograms to real chromatograms
ChromatogramTools chrom_tools;
chrom_tools.convertSpectraToChromatograms(exp, true);
}
bool remove_chromatograms(getFlag_("peak_options:remove_chromatograms"));
if (remove_chromatograms)
{
exp.setChromatograms(vector<MSChromatogram<> >());
}
//-------------------------------------------------------------
// calculations
//-------------------------------------------------------------
// remove forbidden precursor charges
IntList rm_pc_charge = getIntList_("peak_options:rm_pc_charge");
if (rm_pc_charge.size() > 0) exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), HasPrecursorCharge<MapType::SpectrumType>(rm_pc_charge, false)), exp.end());
// remove precursors out of certain m/z range for all spectra with a precursor (MS2 and above)
if (!pc_mz.empty())
{
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), InPrecursorMZRange<MapType::SpectrumType>(pc_left, pc_right, true)), exp.end());
}
// remove by scan mode (might be a lot of spectra)
String remove_mode = getStringOption_("spectra:remove_mode");
if (!remove_mode.empty())
{
writeDebug_("Removing mode: " + remove_mode, 3);
for (Size i = 0; i < InstrumentSettings::SIZE_OF_SCANMODE; ++i)
{
if (InstrumentSettings::NamesOfScanMode[i] == remove_mode)
{
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), HasScanMode<MapType::SpectrumType>((InstrumentSettings::ScanMode)i)), exp.end());
}
}
}
//select by scan mode (might be a lot of spectra)
String select_mode = getStringOption_("spectra:select_mode");
if (!select_mode.empty())
{
writeDebug_("Selecting mode: " + select_mode, 3);
for (Size i = 0; i < InstrumentSettings::SIZE_OF_SCANMODE; ++i)
{
if (InstrumentSettings::NamesOfScanMode[i] == select_mode)
{
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), HasScanMode<MapType::SpectrumType>((InstrumentSettings::ScanMode)i, true)), exp.end());
}
}
}
//remove by activation mode (might be a lot of spectra)
String remove_activation = getStringOption_("spectra:remove_activation");
if (!remove_activation.empty())
{
writeDebug_("Removing scans with activation mode: " + remove_activation, 3);
for (Size i = 0; i < Precursor::SIZE_OF_ACTIVATIONMETHOD; ++i)
{
if (Precursor::NamesOfActivationMethod[i] == remove_activation)
{
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), HasActivationMethod<MapType::SpectrumType>(StringList::create(remove_activation))), exp.end());
}
}
}
//select by activation mode
String select_activation = getStringOption_("spectra:select_activation");
if (!select_activation.empty())
{
writeDebug_("Selecting scans with activation mode: " + select_activation, 3);
for (Size i = 0; i < Precursor::SIZE_OF_ACTIVATIONMETHOD; ++i)
{
if (Precursor::NamesOfActivationMethod[i] == select_activation)
{
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), HasActivationMethod<MapType::SpectrumType>(StringList::create(select_activation), true)), exp.end());
}
}
}
//remove zoom scans (might be a lot of spectra)
if (getFlag_("spectra:remove_zoom"))
{
writeDebug_("Removing zoom scans", 3);
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsZoomSpectrum<MapType::SpectrumType>()), exp.end());
}
if (getFlag_("spectra:select_zoom"))
{
writeDebug_("Selecting zoom scans", 3);
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsZoomSpectrum<MapType::SpectrumType>(true)), exp.end());
}
//remove based on collision energy
if (remove_collision_l != -1 * numeric_limits<double>::max() || remove_collision_u != numeric_limits<double>::max())
{
writeDebug_(String("Removing collision energy scans in the range: ") + remove_collision_l + ":" + remove_collision_u, 3);
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsInCollisionEnergyRange<MSExperiment<>::SpectrumType>(remove_collision_l, remove_collision_u)), exp.end());
}
if (select_collision_l != -1 * numeric_limits<double>::max() || select_collision_u != numeric_limits<double>::max())
{
writeDebug_(String("Selecting collision energy scans in the range: ") + select_collision_l + ":" + select_collision_u, 3);
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsInCollisionEnergyRange<MSExperiment<>::SpectrumType>(select_collision_l, select_collision_u, true)), exp.end());
}
//remove based on isolation window size
if (remove_isolation_width_l != -1 * numeric_limits<double>::max() || remove_isolation_width_u != numeric_limits<double>::max())
{
writeDebug_(String("Removing isolation windows with width in the range: ") + remove_isolation_width_l + ":" + remove_isolation_width_u, 3);
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsInIsolationWindowSizeRange<MSExperiment<>::SpectrumType>(remove_isolation_width_l, remove_isolation_width_u)), exp.end());
}
if (select_isolation_width_l != -1 * numeric_limits<double>::max() || select_isolation_width_u != numeric_limits<double>::max())
{
writeDebug_(String("Selecting isolation windows with width in the range: ") + select_isolation_width_l + ":" + select_isolation_width_u, 3);
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsInIsolationWindowSizeRange<MSExperiment<>::SpectrumType>(select_isolation_width_l, select_isolation_width_u, true)), exp.end());
}
//remove empty scans
exp.getSpectra().erase(remove_if(exp.begin(), exp.end(), IsEmptySpectrum<MapType::SpectrumType>()), exp.end());
//sort
if (sort)
{
exp.sortSpectra(true);
if (getFlag_("peak_options:sort_peaks"))
{
LOG_INFO << "Info: Using 'peak_options:sort_peaks' in combination with 'sort' is redundant, since 'sort' implies 'peak_options:sort_peaks'." << std::endl;
}
}
else if (getFlag_("peak_options:sort_peaks"))
{
for (Size i = 0; i < exp.size(); ++i)
{
exp[i].sortByPosition();
}
}
// calculate S/N values and delete data points below S/N threshold
if (sn > 0)
{
SignalToNoiseEstimatorMedian<MapType::SpectrumType> snm;
Param const& dc_param = getParam_().copy("algorithm:SignalToNoise:", true);
snm.setParameters(dc_param);
for (MapType::Iterator it = exp.begin(); it != exp.end(); ++it)
{
snm.init(it->begin(), it->end());
for (MapType::SpectrumType::Iterator spec = it->begin(); spec != it->end(); ++spec)
{
if (snm.getSignalToNoise(spec) < sn) spec->setIntensity(0);
}
it->erase(remove_if(it->begin(), it->end(), InIntensityRange<MapType::PeakType>(1, numeric_limits<MapType::PeakType::IntensityType>::max(), true)), it->end());
}
}
//
String id_blacklist = getStringOption_("id:blacklist");
if (!id_blacklist.empty())
{
LOG_INFO << "Filtering out MS2 spectra from raw file using blacklist ..." << std::endl;
bool blacklist_imperfect = getFlag_("id:blacklist_imperfect");
int ret = filterByBlackList(exp, id_blacklist, blacklist_imperfect, getDoubleOption_("id:rt"), getDoubleOption_("id:mz"));
if (ret != EXECUTION_OK) return (ExitCodes)ret;
}
// check if filtering by consensus feature is enabled
String consensus_blackorwhitelist = getStringOption_("consensus:blackorwhitelist:file");
if (!consensus_blackorwhitelist.empty())
{
LOG_INFO << "Filtering out MS2 spectra from raw file using consensus features ..." << std::endl;
IntList il = getIntList_("consensus:blackorwhitelist:maps");
set<UInt64> maps(il.begin(), il.end());
DoubleReal rt_tol = getDoubleOption_("consensus:blackorwhitelist:rt");
DoubleReal mz_tol = getDoubleOption_("consensus:blackorwhitelist:mz");
bool is_ppm = getStringOption_("consensus:blackorwhitelist:use_ppm_tolerance") == "false" ? false : true;
bool is_blacklist = getStringOption_("consensus:blackorwhitelist:blacklist") == "true" ? true : false;
int ret = filterByBlackOrWhiteList(is_blacklist, exp, consensus_blackorwhitelist, rt_tol, mz_tol, is_ppm, maps);
if (ret != EXECUTION_OK)
{
return (ExitCodes)ret;
}
}
//-------------------------------------------------------------
// writing output
//-------------------------------------------------------------
//annotate output with data processing info
addDataProcessing_(exp, getProcessingInfo_(DataProcessing::FILTERING));
f.store(out, exp);
}
else if (in_type == FileTypes::FEATUREXML || in_type == FileTypes::CONSENSUSXML)
{
bool meta_ok = true; // assume true by default (as meta might not be checked below)
if (in_type == FileTypes::FEATUREXML)
{
//-------------------------------------------------------------
// loading input
//-------------------------------------------------------------
FeatureMap<> feature_map;
FeatureXMLFile f;
//f.setLogType(log_type_);
// this does not work yet implicitly - not supported by FeatureXMLFile
f.getOptions().setRTRange(DRange<1>(rt_l, rt_u));
f.getOptions().setMZRange(DRange<1>(mz_l, mz_u));
f.getOptions().setIntensityRange(DRange<1>(it_l, it_u));
f.load(in, feature_map);
//-------------------------------------------------------------
// calculations
//-------------------------------------------------------------
//copy all properties
FeatureMap<> map_sm = feature_map;
//.. but delete feature information
map_sm.clear(false);
// only keep charge ch_l:ch_u (WARNING: feature files without charge information have charge=0, see Ctor of KERNEL/Feature.h)
for (FeatureMap<>::Iterator fm_it = feature_map.begin(); fm_it != feature_map.end(); ++fm_it)
{
bool const rt_ok = f.getOptions().getRTRange().encloses(DPosition<1>(fm_it->getRT()));
bool const mz_ok = f.getOptions().getMZRange().encloses(DPosition<1>(fm_it->getMZ()));
bool const int_ok = f.getOptions().getIntensityRange().encloses(DPosition<1>(fm_it->getIntensity()));
bool const charge_ok = ((charge_l <= fm_it->getCharge()) && (fm_it->getCharge() <= charge_u));
bool const size_ok = ((size_l <= fm_it->getSubordinates().size()) && (fm_it->getSubordinates().size() <= size_u));
bool const q_ok = ((q_l <= fm_it->getOverallQuality()) && (fm_it->getOverallQuality() <= q_u));
if (rt_ok && mz_ok && int_ok && charge_ok && size_ok && q_ok)
{
if (remove_meta_enabled)
{
meta_ok = checkMetaOk(*fm_it, meta_info);
}
bool const annotation_ok = checkPeptideIdentification_(*fm_it, remove_annotated_features, remove_unannotated_features, sequences, accessions, keep_best_score_id, remove_clashes);
if (annotation_ok && meta_ok) map_sm.push_back(*fm_it);
}
}
//delete unassignedPeptideIdentifications
if (remove_unassigned_ids)
{
map_sm.getUnassignedPeptideIdentifications().clear();
}
//update minimum and maximum position/intensity
map_sm.updateRanges();
// sort if desired
if (sort)
{
map_sm.sortByPosition();
}
//-------------------------------------------------------------
// writing output
//-------------------------------------------------------------
//annotate output with data processing info
addDataProcessing_(map_sm, getProcessingInfo_(DataProcessing::FILTERING));
f.store(out, map_sm);
}
else if (in_type == FileTypes::CONSENSUSXML)
{
//-------------------------------------------------------------
// loading input
//-------------------------------------------------------------
ConsensusMap consensus_map;
ConsensusXMLFile f;
//f.setLogType(log_type_);
f.getOptions().setRTRange(DRange<1>(rt_l, rt_u));
f.getOptions().setMZRange(DRange<1>(mz_l, mz_u));
f.getOptions().setIntensityRange(DRange<1>(it_l, it_u));
f.load(in, consensus_map);
//-------------------------------------------------------------
// calculations
//-------------------------------------------------------------
// copy all properties
ConsensusMap consensus_map_filtered = consensus_map;
//.. but delete feature information
consensus_map_filtered.resize(0);
for (ConsensusMap::Iterator cm_it = consensus_map.begin(); cm_it != consensus_map.end(); ++cm_it)
{
const bool charge_ok = ((charge_l <= cm_it->getCharge()) && (cm_it->getCharge() <= charge_u));
const bool size_ok = ((cm_it->size() >= size_l) && (cm_it->size() <= size_u));
if (charge_ok && size_ok)
{
// this is expensive, so evaluate after everything else passes the test
if (remove_meta_enabled)
{
meta_ok = checkMetaOk(*cm_it, meta_info);
}
const bool annotation_ok = checkPeptideIdentification_(*cm_it, remove_annotated_features, remove_unannotated_features, sequences, accessions, keep_best_score_id, remove_clashes);
if (annotation_ok && meta_ok) consensus_map_filtered.push_back(*cm_it);
}
}
//delete unassignedPeptideIdentifications
if (remove_unassigned_ids)
{
consensus_map_filtered.getUnassignedPeptideIdentifications().clear();
}
//update minimum and maximum position/intensity
consensus_map_filtered.updateRanges();
// sort if desired
if (sort)
{
consensus_map_filtered.sortByPosition();
}
if (out_type == FileTypes::FEATUREXML)
{
if (maps.size() == 1) // When extracting a feature map from a consensus map, only one map ID should be specified. Hence 'maps' should contain only one integer.
{
FeatureMap<> feature_map_filtered;
FeatureXMLFile ff;
for (ConsensusMap::Iterator cm_it = consensus_map_filtered.begin(); cm_it != consensus_map_filtered.end(); ++cm_it)
{
for (ConsensusFeature::HandleSetType::const_iterator fh_iter = cm_it->getFeatures().begin(); fh_iter != cm_it->getFeatures().end(); ++fh_iter)
{
if ((int)fh_iter->getMapIndex() == maps[0])
{
Feature feature;
feature.setRT(fh_iter->getRT());
feature.setMZ(fh_iter->getMZ());
feature.setIntensity(fh_iter->getIntensity());
feature.setCharge(fh_iter->getCharge());
feature_map_filtered.push_back(feature);
}
}
}
//-------------------------------------------------------------
// writing output
//-------------------------------------------------------------
//annotate output with data processing info
addDataProcessing_(feature_map_filtered, getProcessingInfo_(DataProcessing::FILTERING));
feature_map_filtered.applyMemberFunction(&UniqueIdInterface::setUniqueId);
ff.store(out, feature_map_filtered);
}
else
{
writeLog_("When extracting a feature map from a consensus map, only one map ID should be specified. The 'map' parameter contains more than one. Aborting!");
printUsage_();
return ILLEGAL_PARAMETERS;
}
}
else if (out_type == FileTypes::CONSENSUSXML)
{
// generate new consensuses with features that appear in the 'maps' list
ConsensusMap cm_new; // new consensus map
for (IntList::iterator map_it = maps.begin(); map_it != maps.end(); ++map_it)
{
cm_new.getFileDescriptions()[*map_it].filename = consensus_map_filtered.getFileDescriptions()[*map_it].filename;
cm_new.getFileDescriptions()[*map_it].size = consensus_map_filtered.getFileDescriptions()[*map_it].size;
cm_new.getFileDescriptions()[*map_it].unique_id = consensus_map_filtered.getFileDescriptions()[*map_it].unique_id;
}
cm_new.setProteinIdentifications(consensus_map_filtered.getProteinIdentifications());
const bool and_connective = getFlag_("consensus:map_and");
for (ConsensusMap::Iterator cm_it = consensus_map_filtered.begin(); cm_it != consensus_map_filtered.end(); ++cm_it) // iterate over consensuses in the original consensus map
{
ConsensusFeature consensus_feature_new(*cm_it); // new consensus feature
consensus_feature_new.clear();
ConsensusFeature::HandleSetType::const_iterator fh_it = cm_it->getFeatures().begin();
ConsensusFeature::HandleSetType::const_iterator fh_it_end = cm_it->getFeatures().end();
for (; fh_it != fh_it_end; ++fh_it) // iterate over features in consensus
{
if (maps.contains(fh_it->getMapIndex()))
{
consensus_feature_new.insert(*fh_it);
}
}
if ((!consensus_feature_new.empty() && !and_connective) || (consensus_feature_new.size() == maps.size() && and_connective)) // add the consensus to the consensus map only if it is non-empty
{
consensus_feature_new.computeConsensus(); // evaluate position of the consensus
cm_new.push_back(consensus_feature_new);
}
}
// assign unique ids
cm_new.applyMemberFunction(&UniqueIdInterface::setUniqueId);
//-------------------------------------------------------------
// writing output
//-------------------------------------------------------------
if (maps.empty())
{
//annotate output with data processing info
addDataProcessing_(consensus_map_filtered, getProcessingInfo_(DataProcessing::FILTERING));
f.store(out, consensus_map_filtered);
}
else
{
//annotate output with data processing info
addDataProcessing_(cm_new, getProcessingInfo_(DataProcessing::FILTERING));
f.store(out, cm_new);
}
}
}
else
{
writeLog_("Error: Unknown output file type given. Aborting!");
printUsage_();
return ILLEGAL_PARAMETERS;
}
}
else
{
writeLog_("Error: Unknown input file type given. Aborting!");
printUsage_();
return INCOMPATIBLE_INPUT_DATA;
}
return EXECUTION_OK;
}
ExitCodes filterByBlackList(MapType& exp, const String& id_blacklist, bool blacklist_imperfect, DoubleReal rt_tol, DoubleReal mz_tol)
{
vector<ProteinIdentification> protein_ids;
vector<PeptideIdentification> peptide_ids;
IdXMLFile().load(id_blacklist, protein_ids, peptide_ids);
// translate idXML entries into something more handy
typedef std::vector<Peak2D> IdType;
IdType ids; // use Peak2D since it has sorting operators already
for (Size i = 0; i < peptide_ids.size(); ++i)
{
if (!peptide_ids[i].metaValueExists("RT") && !peptide_ids[i].metaValueExists("MZ"))
{
LOG_ERROR << "Identifications given in 'id:blacklist' are missing RT and/or MZ coordinates. Cannot do blacklisting without. Quitting." << std::endl;
return INCOMPATIBLE_INPUT_DATA;
}
Peak2D p;
p.setRT(peptide_ids[i].getMetaValue("RT"));
p.setMZ(peptide_ids[i].getMetaValue("MZ"));
ids.push_back(p);
}
std::sort(ids.begin(), ids.end(), Peak2D::RTLess());
set<Size> blacklist_idx;
set<Size> ids_covered;
for (Size i = 0; i != exp.size(); ++i)
{
if (exp[i].getMSLevel() == 2)
{
if (!exp[i].getPrecursors().empty())
{
DoubleReal pc_rt = exp[i].getRT();
DoubleReal pc_mz = exp[i].getPrecursors()[0].getMZ();
IdType::iterator p_low = std::lower_bound(ids.begin(), ids.end(), pc_rt - rt_tol, Peak2D::RTLess());
IdType::iterator p_high = std::lower_bound(ids.begin(), ids.end(), pc_rt + rt_tol, Peak2D::RTLess());
// if precursor is out of the whole range, then p_low==p_high == (begin()||end())
// , thus the following loop will not run
for (IdType::iterator id_it = p_low; id_it != p_high; ++id_it) // RT already checked.. now check m/z
{
if (pc_mz - mz_tol < id_it->getMZ() && id_it->getMZ() < pc_mz + mz_tol)
{
blacklist_idx.insert(i);
ids_covered.insert(std::distance(ids.begin(), id_it));
// no break, since we might cover more IDs here
}
}
}
}
}
LOG_INFO << "Removing " << blacklist_idx.size() << " MS2 spectra." << endl;
if (ids_covered.size() != ids.size())
{
if (!blacklist_imperfect)
{
LOG_ERROR << "Covered only " << ids_covered.size() << "/" << ids.size() << " IDs. Check if your input files (raw + ids) match and if your tolerances ('rt' and 'mz') are set properly.\n"
<< "If you are sure unmatched ids are ok, set the 'id:blacklist_imperfect' flag!" << std::endl;
return UNEXPECTED_RESULT;
}
else
{
LOG_WARN << "Covered only " << ids_covered.size() << "/" << ids.size() << " IDs. Check if your input files (raw + ids) match and if your tolerances ('rt' and 'mz') are set properly.\n"
<< "Remove the 'id:blacklist_imperfect' flag of you want this to be an error!" << std::endl;
}
}
MSExperiment<> exp2 = exp;
exp2.clear(false);
for (Size i = 0; i != exp.size(); ++i)
{
if (find(blacklist_idx.begin(), blacklist_idx.end(), i) ==
blacklist_idx.end())
{
exp2.addSpectrum(exp[i]);
}
}
exp = exp2;
return EXECUTION_OK;
}
ExitCodes filterByBlackOrWhiteList(bool is_blacklist, MapType& exp, const String& consensus_blacklist, DoubleReal rt_tol, DoubleReal mz_tol, bool unit_ppm, std::set<UInt64> map_ids)
{
ConsensusMap consensus_map;
ConsensusXMLFile cxml_file;
cxml_file.load(consensus_blacklist, consensus_map);
consensus_map.sortByMZ();
std::vector<Peak2D> feature_pos;
// if map_id are specified, only use these for blacklisting
for (ConsensusMap::const_iterator c_it = consensus_map.begin(); c_it != consensus_map.end(); ++c_it)
{
for (ConsensusFeature::const_iterator f_it = c_it->begin(); f_it != c_it->end(); ++f_it)
{
UInt64 map_index = f_it->getMapIndex();
if (map_ids.empty() || map_ids.find(map_index) != map_ids.end())
{
Peak2D p;
p.setMZ(f_it->getMZ());
p.setRT(f_it->getRT());
feature_pos.push_back(p);
}
}
}
// sort by rt to use binary search
std::sort(feature_pos.begin(), feature_pos.end(), Peak2D::RTLess());
set<Size> list_idx;
for ( Size i = 0; i != exp.size(); ++i )
{
if ( exp[i].getMSLevel() == 2 )
{
if ( !exp[i].getPrecursors().empty() )
{
DoubleReal pc_mz = exp[i].getPrecursors()[0].getMZ();
DoubleReal pc_rt = exp[i].getRT(); // use rt of MS2
std::vector<Peak2D>::iterator p_low = std::lower_bound(feature_pos.begin(), feature_pos.end(), pc_rt - rt_tol, Peak2D::RTLess());
std::vector<Peak2D>::iterator p_high = std::lower_bound(feature_pos.begin(), feature_pos.end(), pc_rt + rt_tol, Peak2D::RTLess());
DoubleReal mz_tol_da = unit_ppm ? pc_mz * 1e-6 * mz_tol : mz_tol;
// if precursor is out of the whole range, then p_low==p_high == (begin()||end())
// , thus the following loop will not run
for (std::vector<Peak2D>::iterator f_it = p_low; f_it != p_high; ++f_it) // RT already checked.. now check m/z
{
if (pc_mz - mz_tol_da < f_it->getMZ() && f_it->getMZ() < pc_mz + mz_tol_da)
{
list_idx.insert(i);
// no break, since we might cover more features here
}
}
}
}
}
// create new experiment
MSExperiment<> exp2 = exp; // copy meta data
exp2.clear(false); // clear spectra
for (Size i = 0; i != exp.size(); ++i)
{
// don't need to sort list as it is increasing
if (is_blacklist)
{
// blacklist: add all spectra not contained in list
if (find(list_idx.begin(), list_idx.end(), i) == list_idx.end())
{
exp2.addSpectrum(exp[i]);
}
} else // whitelist: add all non MS2 spectra, and MS2 only if in list
{
if (exp[i].getMSLevel() != 2 || find(list_idx.begin(), list_idx.end(), i) != list_idx.end())
{
exp2.addSpectrum(exp[i]);
}
}
}
exp = exp2;
return EXECUTION_OK;
}
};
int main(int argc, const char** argv)
{
TOPPFileFilter tool;
return tool.main(argc, argv);
}
/// @endcond
|