MzMLFile.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: Timo Sachsenberg $
// $Authors: Marc Sturm, Chris Bielow, Hannes Roest $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/KERNEL/StandardTypes.h>
#include <OpenMS/FORMAT/XMLFile.h>
#include <OpenMS/FORMAT/OPTIONS/PeakFileOptions.h>
#include <OpenMS/CONCEPT/ProgressLogger.h>
#include <OpenMS/CONCEPT/Exception.h>
 
#include <OpenMS/DATASTRUCTURES/ListUtils.h> // StringList
#include <OpenMS/INTERFACES/IMSDataConsumer.h>
 
#include <map>
 
namespace OpenMS
{
  class OPENMS_DLLAPI MzMLFile :
    public Internal::XMLFile,
    public ProgressLogger
  {
public:
    MzMLFile();
    ~MzMLFile() override;
 
    PeakFileOptions& getOptions();
 
    const PeakFileOptions& getOptions() const;
 
    void setOptions(const PeakFileOptions&);
 
    void load(const std::string& filename, PeakMap& map);
 
    void loadBuffer(const std::string& buffer, PeakMap& map);
 
    void loadSize(const std::string & filename, Size& scount, Size& ccount);
 
    void store(const std::string& filename, const PeakMap& map) const;
 
    void storeBuffer(std::string & output, const PeakMap& map) const;
 
    void transform(const std::string& filename_in, Interfaces::IMSDataConsumer * consumer, bool skip_full_count = false, bool skip_first_pass = false);
 
    void transform(const std::string& filename_in, Interfaces::IMSDataConsumer * consumer, PeakMap& map, bool skip_full_count = false, bool skip_first_pass = false);
 
    bool isValid(const std::string& filename, std::ostream& os = std::cerr);
 
    bool isSemanticallyValid(const std::string& filename, StringList& errors, StringList& warnings);
 
    bool hasIndex(const std::string& filename);
 
    struct SpecInfo
    {
      Size count_centroided = 0;
      Size count_profile = 0;
      Size count_unknown = 0;
    };
      
    std::map<UInt, SpecInfo> getCentroidInfo(const std::string& filename, const Size first_n_spectra_only = 10);
 
protected:
 
    void transformFirstPass_(const std::string& filename_in, Interfaces::IMSDataConsumer * consumer, bool skip_full_count);
 
    void safeParse_(const std::string & filename, Internal::XMLHandler * handler);
 
private:
 
    PeakFileOptions options_;
 
    std::string indexed_schema_location_;
  };
 
} // namespace OpenMS