ConsensusMapArrowIO.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: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/KERNEL/ConsensusMap.h>
#include <OpenMS/FORMAT/MSExperimentArrowExport.h>
 
#include <memory>
 
// Forward declarations
namespace arrow
{
  class Table;
}
 
namespace OpenMS
{
 
class OPENMS_DLLAPI ConsensusMapArrowIO
{
public:
  // ==================== Export methods ====================
 
  static std::shared_ptr<arrow::Table> exportFeaturesToArrow(
    const ConsensusMap& cmap);
 
  static std::shared_ptr<arrow::Table> exportPSMsToArrow(
    const ConsensusMap& cmap);
 
  static bool exportToParquet(
    const ConsensusMap& cmap,
    const String& directory,
    const ParquetWriteConfig& config = ParquetWriteConfig{});
 
  // ==================== Import methods ====================
 
  static bool importFeaturesFromArrow(
    const std::shared_ptr<arrow::Table>& table,
    ConsensusMap& cmap);
 
  static bool importPSMsFromArrow(
    const std::shared_ptr<arrow::Table>& table,
    ConsensusMap& cmap);
 
  static bool importFromParquet(
    const String& directory,
    ConsensusMap& cmap);
};
 
} // namespace OpenMS