PeptideIdentification.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: $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/METADATA/PeptideHit.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/METADATA/ProteinHit.h>
 
 
#include <string>
#include <map>
 
namespace OpenMS
{
    class ConsensusMap;
    class PeptideIdentification;
 
    using SpectrumIdentification = PeptideIdentification; // better name that might become the default in future version
 
  class OPENMS_DLLAPI PeptideIdentification :
    public MetaInfoInterface
  {
public:
 
    typedef PeptideHit HitType;
 
 
    PeptideIdentification();
    virtual ~PeptideIdentification() noexcept;
    PeptideIdentification(const PeptideIdentification&) = default;
    PeptideIdentification(PeptideIdentification&&) noexcept = default;
 
    PeptideIdentification& operator=(const PeptideIdentification&) = default;
    PeptideIdentification& operator=(PeptideIdentification&&) = default; // TODO: add noexcept (gcc 4.8 bug)
    bool operator==(const PeptideIdentification& rhs) const;
    bool operator!=(const PeptideIdentification& rhs) const;
 
    double getRT() const;
    void setRT(double rt);
    bool hasRT() const;
 
    double getMZ() const;
    void setMZ(double mz);
    bool hasMZ() const;
 
    const std::vector<PeptideHit>& getHits() const;
    std::vector<PeptideHit>& getHits();
    void insertHit(const PeptideHit& hit);
    void insertHit(PeptideHit&& hit);
    void setHits(const std::vector<PeptideHit>& hits);
    void setHits(std::vector<PeptideHit>&& hits);
 
    double getSignificanceThreshold() const;
    void setSignificanceThreshold(double value);
 
    const String& getScoreType() const;
    void setScoreType(const String& type);
 
    bool isHigherScoreBetter() const;
    void setHigherScoreBetter(bool value);
 
    const String& getIdentifier() const;
    void setIdentifier(const String& id);
 
    String getBaseName() const;
    void setBaseName(const String& base_name);
 
    const String getExperimentLabel() const;
    void setExperimentLabel(const String& type);
 
    // TODO make a mandatory data member, add to idXML schema, think about storing the
    //  extracted spectrum "number" only!
    String getSpectrumReference() const;
    void setSpectrumReference(const String& ref);
 
    void assignRanks();
 
    // Returns a higher or lower comparator based on @p higher_score_better_
    static std::function<bool(const PeptideHit&, const PeptideHit&)> getScoreComparator(bool higher_score_better);
 
    void sort();
 
    void sortByRank();
 
    bool empty() const;
 
    static std::vector<PeptideHit> getReferencingHits(const std::vector<PeptideHit>&, const std::set<String>& accession);
 
    static std::multimap<String, std::pair<Size, Size>> buildUIDsFromAllPepIDs(const ConsensusMap &cmap);
 
    static String buildUIDFromPepID(const PeptideIdentification& pep_id,
                                    const std::map<String, StringList>& identifier_to_msrunpath);
 
protected:
    String id_; 
    std::vector<PeptideHit> hits_; 
    String score_type_; 
    bool higher_score_better_; 
    double mz_;
    double rt_;
  };
 
} //namespace OpenMS