Peak2D.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/DPosition.h>

#include <iosfwd>
#include <functional>

namespace OpenMS
{

  class OPENMS_DLLAPI Peak2D
  {
public:


    typedef float IntensityType;
    typedef double CoordinateType;
    typedef DPosition<2> PositionType;


    enum DimensionDescription
    {
      RT = 0,       
      MZ = 1,       
      DIMENSION = 2 
    };

    static char const * shortDimensionName(UInt const dim);
    static char const * shortDimensionNameRT();
    static char const * shortDimensionNameMZ();

    static char const * fullDimensionName(UInt const dim);
    static char const * fullDimensionNameRT();
    static char const * fullDimensionNameMZ();

    static char const * shortDimensionUnit(UInt const dim);
    static char const * shortDimensionUnitRT();
    static char const * shortDimensionUnitMZ();

    static char const * fullDimensionUnit(UInt const dim);
    static char const * fullDimensionUnitRT();
    static char const * fullDimensionUnitMZ();


protected:


    static char const * const dimension_name_short_[DIMENSION];

    static char const * const dimension_name_full_[DIMENSION];

    static char const * const dimension_unit_short_[DIMENSION];

    static char const * const dimension_unit_full_[DIMENSION];


public:

    Peak2D() = default;

    explicit Peak2D(const PositionType& pos, const IntensityType in) :
      position_(pos),
      intensity_(in)
    {}

    Peak2D(const Peak2D & p) = default;

    Peak2D(Peak2D&&) noexcept = default;

    Peak2D& operator=(const Peak2D& rhs) = default;

    Peak2D& operator=(Peak2D&&) noexcept = default;
    ~Peak2D() noexcept = default;
    

    IntensityType getIntensity() const
    {
      return intensity_;
    }

    void setIntensity(IntensityType intensity)
    {
      intensity_ = intensity;
    }

    PositionType const & getPosition() const
    {
      return position_;
    }

    PositionType & getPosition()
    {
      return position_;
    }

    void setPosition(const PositionType & position)
    {
      position_ = position;
    }

    CoordinateType getMZ() const
    {
      return position_[MZ];
    }

    void setMZ(CoordinateType coordinate)
    {
      position_[MZ] = coordinate;
    }

    CoordinateType getRT() const
    {
      return position_[RT];
    }

    void setRT(CoordinateType coordinate)
    {
      position_[RT] = coordinate;
    }


    bool operator==(const Peak2D & rhs) const
    {
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wfloat-equal"
      return intensity_ == rhs.intensity_ && position_ == rhs.position_;
#pragma clang diagnostic pop
    }

    bool operator!=(const Peak2D & rhs) const
    {
      return !(operator==(rhs));
    }

    struct IntensityLess
    {
      bool operator()(const Peak2D & left, const Peak2D & right) const
      {
        return left.getIntensity() < right.getIntensity();
      }

      bool operator()(const Peak2D & left, IntensityType right) const
      {
        return left.getIntensity() < right;
      }

      bool operator()(IntensityType left, const Peak2D & right) const
      {
        return left < right.getIntensity();
      }

      bool operator()(IntensityType left, IntensityType right) const
      {
        return left < right;
      }

    };

    struct RTLess
    {
      bool operator()(const Peak2D & left, const Peak2D & right) const
      {
        return left.getRT() < right.getRT();
      }

      bool operator()(const Peak2D & left, CoordinateType right) const
      {
        return left.getRT() < right;
      }

      bool operator()(CoordinateType left, const Peak2D & right) const
      {
        return left < right.getRT();
      }

      bool operator()(CoordinateType left, CoordinateType right) const
      {
        return left < right;
      }

    };

    struct MZLess
    {
      bool operator()(const Peak2D & left, const Peak2D & right) const
      {
        return left.getMZ() < right.getMZ();
      }

      bool operator()(const Peak2D & left, CoordinateType right) const
      {
        return left.getMZ() < right;
      }

      bool operator()(CoordinateType left, const Peak2D & right) const
      {
        return left < right.getMZ();
      }

      bool operator()(CoordinateType left, CoordinateType right) const
      {
        return left < right;
      }

    };

    struct PositionLess
    {
      bool operator()(const Peak2D & left, const Peak2D & right) const
      {
        return left.getPosition() < right.getPosition();
      }

      bool operator()(const Peak2D & left, const PositionType & right) const
      {
        return left.getPosition() < right;
      }

      bool operator()(const PositionType & left, const Peak2D & right) const
      {
        return left < right.getPosition();
      }

      bool operator()(const PositionType & left, const PositionType & right) const
      {
        return left < right;
      }

    };

    friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const Peak2D & point);

protected:

    PositionType position_{};
    IntensityType intensity_{};
  };

  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const Peak2D & point);

} // namespace OpenMS