| 
    libpappsomspp
    
   Library for mass spectrometry 
   | 
 
#include <tandemwrapperrun.h>
 Signals | |
| void | tandemProgressMessage (QString message) | 
Public Member Functions | |
| TandemWrapperRun (const QString &tandem_binary, const QString &tmp_dir) | |
| prepare a tandem run   | |
| void | run (UiMonitorInterface &monitor, const QString &tandem_input_file) | 
| run a tandem job   | |
| void | readTandemPresetFile (const QString &tandem_preset_file) | 
| QString | getMs2FilterSuiteString () const | 
| gets the list of filters used on MS2 spectrum   | |
| ~TandemWrapperRun () | |
Private Slots | |
| void | readyReadStandardOutput () | 
| void | readyReadStandardError () | 
Private Member Functions | |
| void | setTandemBinaryPath (const QString &tandem_binary_path) | 
| const QString | checkXtandemVersion (const QString &tandem_bin_path) | 
| void | wrapTandemInputFile (const QString &tandem_input_file) | 
| bool | convertOrginalMsData2mzXmlData (const QString &origin, const QString &target) | 
| void | runTandem (const QString &tandem_input_file) | 
| run a tandem job   | |
| void | writeFinalTandemOutput (const QString &tmp_tandem_output, const QString &final_tandem_output, const QString &original_msdata_file_name) | 
| tandem output modification tandem output is modified to contain the Bruker's file as input and centroidization parameters   | |
Private Attributes | |
| UiMonitorInterface * | mp_monitor | 
| QString | m_tandemBinary | 
| QString | m_tandemVersion | 
| QString | m_tmpDir | 
| int | m_maxTandemRunTimeMs | 
| QProcess * | m_xtProcess = nullptr | 
| std::shared_ptr< FilterSuiteString > | msp_ms2FilterSuiteString = nullptr | 
| QTemporaryDir * | mpa_temporaryDirectory = nullptr | 
| bool | m_convertMzDataUsingSpectrumIndex = false | 
| Enums::MsDataFormat | m_mzFormat = Enums::MsDataFormat::unknown | 
| qint64 | m_conversionTime = 0 | 
Definition at line 61 of file tandemwrapperrun.h.
| pappso::TandemWrapperRun::TandemWrapperRun | ( | const QString & | tandem_binary, | 
| const QString & | tmp_dir ) | 
prepare a tandem run
| tandem_binary | file path to tandem.exe if not set, a default value is given in QSettings | 
| tmp_dir | temporary directory, where to write mzXML file conversion if not set, a default value is given in QSettings | 
Definition at line 49 of file tandemwrapperrun.cpp.
References mpa_temporaryDirectory, and setTandemBinaryPath().
| pappso::TandemWrapperRun::~TandemWrapperRun | ( | ) | 
Destructor
Definition at line 73 of file tandemwrapperrun.cpp.
References m_xtProcess, and mpa_temporaryDirectory.
      
  | 
  private | 
Definition at line 107 of file tandemwrapperrun.cpp.
References m_tandemVersion.
Referenced by setTandemBinaryPath(), and tandemProgressMessage().
      
  | 
  private | 
Definition at line 439 of file tandemwrapperrun.cpp.
References pappso::Enums::brukerTims, pappso::MzxmlOutput::close(), pappso::MsFileAccessor::getFileFormat(), pappso::MsFileAccessor::getMsRunIds(), m_conversionTime, m_convertMzDataUsingSpectrumIndex, m_mzFormat, pappso::MzxmlOutput::maskMs1(), mp_monitor, msp_ms2FilterSuiteString, pappso::MsFileAccessor::msRunReaderSPtr(), pappso::Enums::mzML, pappso::TimsMsRunReaderMs2::setMs2BuiltinCentroid(), pappso::TimsMsRunReaderMs2::setMs2FilterCstSPtr(), pappso::MsFileAccessor::setPreferredFileReaderType(), pappso::MzxmlOutput::setReadAhead(), pappso::Enums::tims_ms2, pappso::Enums::unknown, and pappso::MzxmlOutput::write().
Referenced by tandemProgressMessage(), and wrapTandemInputFile().
| QString pappso::TandemWrapperRun::getMs2FilterSuiteString | ( | ) | const | 
gets the list of filters used on MS2 spectrum
Definition at line 605 of file tandemwrapperrun.cpp.
References msp_ms2FilterSuiteString.
Referenced by writeFinalTandemOutput().
| void pappso::TandemWrapperRun::readTandemPresetFile | ( | const QString & | tandem_preset_file | ) | 
Definition at line 285 of file tandemwrapperrun.cpp.
References pappso::XmlStreamReaderInterface::errorString(), pappso::XtandemPresetReader::getMs2FiltersOptions(), pappso::XtandemPresetReader::getNumberOfThreads(), msp_ms2FilterSuiteString, and pappso::XmlStreamReaderInterface::readFile().
Referenced by wrapTandemInputFile().
      
  | 
  privateslot | 
Definition at line 229 of file tandemwrapperrun.cpp.
References m_xtProcess, and mp_monitor.
Referenced by runTandem(), and tandemProgressMessage().
      
  | 
  privateslot | 
Definition at line 208 of file tandemwrapperrun.cpp.
References m_xtProcess, and mp_monitor.
Referenced by runTandem(), and tandemProgressMessage().
| void pappso::TandemWrapperRun::run | ( | UiMonitorInterface & | monitor, | 
| const QString & | tandem_input_file ) | 
run a tandem job
The tandem input file should contain an additional input parameter called "spectrum, timstof MS2 filters". The value of this parameters must contain a string describing the FilterSuiteString to apply on TimsTOF MS2. A default value of "chargeDeconvolution|0.02dalton" is recommended for this additional tandem input parameter
| monitor | user interface monitor | 
| tandem_input_file | tandem xml input file | 
Definition at line 527 of file tandemwrapperrun.cpp.
References mp_monitor, and wrapTandemInputFile().
      
  | 
  private | 
run a tandem job
| tandem_input_file | tandem xml input file | 
Definition at line 536 of file tandemwrapperrun.cpp.
References m_maxTandemRunTimeMs, m_tandemBinary, m_xtProcess, mp_monitor, readyReadStandardError(), and readyReadStandardOutput().
Referenced by tandemProgressMessage(), and wrapTandemInputFile().
      
  | 
  private | 
Definition at line 87 of file tandemwrapperrun.cpp.
References checkXtandemVersion(), m_tandemBinary, and m_tandemVersion.
Referenced by TandemWrapperRun(), and tandemProgressMessage().
      
  | 
  signal | 
      
  | 
  private | 
Definition at line 338 of file tandemwrapperrun.cpp.
References convertOrginalMsData2mzXmlData(), pappso::XmlStreamReaderInterface::errorString(), pappso::WrapTandemInput::getOriginalMsDataFileName(), pappso::WrapTandemInput::getOriginalTandemOutputFileName(), pappso::WrapTandemInput::getOriginalTandemPresetFileName(), m_tandemBinary, mpa_temporaryDirectory, pappso::XmlStreamReaderInterface::readFile(), readTandemPresetFile(), runTandem(), and writeFinalTandemOutput().
Referenced by run(), and tandemProgressMessage().
      
  | 
  private | 
tandem output modification tandem output is modified to contain the Bruker's file as input and centroidization parameters
| tmp_tandem_output | raw tandem output filename | 
| final_tandem_output | final destination file for modified tandem output | 
Definition at line 243 of file tandemwrapperrun.cpp.
References pappso::XmlStreamReaderInterface::errorString(), getMs2FilterSuiteString(), m_conversionTime, m_convertMzDataUsingSpectrumIndex, m_mzFormat, mp_monitor, pappso::XmlStreamReaderInterface::readFile(), and pappso::WrapTandemResults::setInputParameters().
Referenced by tandemProgressMessage(), and wrapTandemInputFile().
      
  | 
  private | 
Definition at line 150 of file tandemwrapperrun.h.
Referenced by convertOrginalMsData2mzXmlData(), and writeFinalTandemOutput().
      
  | 
  private | 
Definition at line 146 of file tandemwrapperrun.h.
Referenced by convertOrginalMsData2mzXmlData(), and writeFinalTandemOutput().
      
  | 
  private | 
      
  | 
  private | 
Definition at line 148 of file tandemwrapperrun.h.
Referenced by convertOrginalMsData2mzXmlData(), and writeFinalTandemOutput().
      
  | 
  private | 
Definition at line 135 of file tandemwrapperrun.h.
Referenced by runTandem(), setTandemBinaryPath(), and wrapTandemInputFile().
      
  | 
  private | 
Definition at line 136 of file tandemwrapperrun.h.
Referenced by checkXtandemVersion(), and setTandemBinaryPath().
      
  | 
  private | 
Definition at line 137 of file tandemwrapperrun.h.
      
  | 
  private | 
Definition at line 140 of file tandemwrapperrun.h.
Referenced by ~TandemWrapperRun(), readyReadStandardError(), readyReadStandardOutput(), and runTandem().
      
  | 
  private | 
Definition at line 134 of file tandemwrapperrun.h.
Referenced by convertOrginalMsData2mzXmlData(), readyReadStandardError(), readyReadStandardOutput(), run(), runTandem(), and writeFinalTandemOutput().
      
  | 
  private | 
Definition at line 144 of file tandemwrapperrun.h.
Referenced by TandemWrapperRun(), ~TandemWrapperRun(), and wrapTandemInputFile().
      
  | 
  private | 
Definition at line 142 of file tandemwrapperrun.h.
Referenced by convertOrginalMsData2mzXmlData(), getMs2FilterSuiteString(), and readTandemPresetFile().