Feature.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/DATASTRUCTURES/ConvexHull2D.h>
#include <OpenMS/KERNEL/BaseFeature.h>
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <vector>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI Feature :
    public BaseFeature
  {
public:
    Feature();
 
    explicit Feature(const BaseFeature& base);
 
    Feature(const Feature& feature);
 
    Feature(Feature&&) noexcept;
 
    ~Feature() override;
 
 
    QualityType getOverallQuality() const;
 
    void setOverallQuality(QualityType q);
 
    QualityType getQuality(Size index) const;
    void setQuality(Size index, QualityType q);
 
    typedef QualityLess OverallQualityLess;
 
 
 
    const std::vector<ConvexHull2D>& getConvexHulls() const;
    std::vector<ConvexHull2D>& getConvexHulls();
    void setConvexHulls(const std::vector<ConvexHull2D>& hulls);
 
    ConvexHull2D& getConvexHull() const;
 
    bool encloses(double rt, double mz) const;
 
    Feature& operator=(const Feature& rhs);
 
    Feature& operator=(Feature&&) & noexcept;
 
    bool operator==(const Feature& rhs) const;
 
    const std::vector<Feature>& getSubordinates() const;
 
    std::vector<Feature>& getSubordinates();
 
    void setSubordinates(const std::vector<Feature>& rhs);
 
    template <typename Type>
    Size applyMemberFunction(Size (Type::* member_function)())
    {
      Size assignments = 0;
      assignments += ((*this).*member_function)();
      for (std::vector<Feature>::iterator iter = subordinates_.begin(); iter != subordinates_.end(); ++iter)
      {
        assignments += iter->applyMemberFunction(member_function);
      }
      return assignments;
    }
 
    template <typename Type>
    Size applyMemberFunction(Size (Type::* member_function)() const) const
    {
      Size assignments = 0;
      assignments += ((*this).*member_function)();
      for (std::vector<Feature>::const_iterator iter = subordinates_.begin(); iter != subordinates_.end(); ++iter)
      {
        assignments += iter->applyMemberFunction(member_function);
      }
      return assignments;
    }
 
    void updateAllIDReferences(const IdentificationData::RefTranslator& trans);
 
protected:
 
    QualityType qualities_[2];
 
    std::vector<ConvexHull2D> convex_hulls_;
 
    mutable bool convex_hulls_modified_{};
 
    mutable ConvexHull2D convex_hull_;
 
    std::vector<Feature> subordinates_;
 
  };
 
} // namespace OpenMS