MzPeakFile.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Oliver Kohlbacher $
// $Authors: Oliver Kohlbacher $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/ProgressLogger.h>
#include <OpenMS/FORMAT/OPTIONS/PeakFileOptions.h>
#include <OpenMS/INTERFACES/IMSDataConsumer.h>
#include <OpenMS/KERNEL/StandardTypes.h>
 
#include <string>
 
namespace OpenMS
{
  class OPENMS_DLLAPI MzPeakFile :
    public ProgressLogger
  {
public:
    MzPeakFile();
    ~MzPeakFile() override;
 
    PeakFileOptions& getOptions();
    const PeakFileOptions& getOptions() const;
    void setOptions(const PeakFileOptions&);
 
    void load(const std::string& filename, PeakMap& exp);
 
    void transform(const std::string& filename, Interfaces::IMSDataConsumer* consumer);
 
    void store(const std::string& filename, const PeakMap& exp) const;
 
    static bool isMzPeak(const std::string& path);
 
    static bool isSupported();
 
private:
    PeakFileOptions options_;
  };
 
} // namespace OpenMS