FIAMSDataProcessor.h

Go to the documentation of this file.

//---------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// 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: Svetlana Kutuzova, Douglas McCloskey $
// $Authors: Svetlana Kutuzova, Douglas McCloskey $
// --------------------------------------------------------------------------
 
#pragma once
#include <OpenMS/FILTERING/SMOOTHING/SavitzkyGolayFilter.h>
#include <OpenMS/TRANSFORMATIONS/RAW2PEAK/PeakPickerHiRes.h>
#include <OpenMS/FORMAT/MzTab.h>
#include <OpenMS/FORMAT/MzTabM.h>
#include <OpenMS/FORMAT/MzTabFile.h>
#include <OpenMS/FORMAT/MzMLFile.h>

namespace OpenMS
{
  class OPENMS_DLLAPI FIAMSDataProcessor  :
    public DefaultParamHandler
  {
public:
    FIAMSDataProcessor();

    ~FIAMSDataProcessor() override = default;

    FIAMSDataProcessor(const FIAMSDataProcessor& cp) = default;

    FIAMSDataProcessor& operator=(const FIAMSDataProcessor& fdp) = default;

    bool run(const MSExperiment& experiment, const float n_seconds, OpenMS::MzTab& output, const bool load_cached_spectrum = true);

    void cutForTime(const MSExperiment& experiment, const float n_seconds, std::vector<MSSpectrum>& output);

    MSSpectrum mergeAlongTime(const std::vector<OpenMS::MSSpectrum>& input);

    MSSpectrum extractPeaks(const MSSpectrum& input);

    FeatureMap convertToFeatureMap(const MSSpectrum& input);

    MSSpectrum trackNoise(const MSSpectrum& input);

    void runAccurateMassSearch(FeatureMap& input, OpenMS::MzTab& output);

    const std::vector<float>& getMZs();

    const std::vector<float>& getBinSizes();

protected:
    void updateMembers_() override;

private:
    void storeSpectrum_(const MSSpectrum& input, const String& filename);

    std::vector<float> mzs_; 
    std::vector<float> bin_sizes_;
    SavitzkyGolayFilter sgfilter_;
    PeakPickerHiRes picker_;
  };
} // namespace OpenMS