Mobilogram.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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/KERNEL/MobilityPeak1D.h>

#include <OpenMS/IONMOBILITY/IMTypes.h>
#include <OpenMS/KERNEL/RangeManager.h>

namespace OpenMS
{
  enum class DriftTimeUnit;
  class OPENMS_DLLAPI Mobilogram final : public RangeManagerContainer<RangeMobility, RangeIntensity>
  {
  public:
    struct OPENMS_DLLAPI RTLess {
      bool operator()(const Mobilogram& a, const Mobilogram& b) const;
    };



    using PeakType = MobilityPeak1D;
    using CoordinateType = PeakType::CoordinateType;
    using ContainerType = std::vector<PeakType>;
    using RangeManagerContainerType = RangeManagerContainer<RangeMobility, RangeIntensity>;
    using RangeManagerType = RangeManager<RangeMobility, RangeIntensity>;


    using Iterator = ContainerType::iterator;
    using iterator = Iterator;
    using ConstIterator = ContainerType::const_iterator;
    using const_iterator = ConstIterator;
    using ReverseIterator = ContainerType::reverse_iterator;
    using reverse_iterator = ReverseIterator;
    using ConstReverseIterator = ContainerType::const_reverse_iterator;
    using const_reverse_iterator = ConstReverseIterator;
    /*using typename ContainerType::const_reference;
    using typename ContainerType::difference_type;
    using typename ContainerType::pointer;
    using typename ContainerType::reference;
    using typename ContainerType::size_type;
    using typename ContainerType::value_type;*/

    // rule of 6

    Mobilogram() = default;

    Mobilogram(const Mobilogram& source) = default;

    Mobilogram(Mobilogram&&) noexcept = default;

    Mobilogram& operator=(const Mobilogram& source) = default;

    Mobilogram& operator=(Mobilogram&&) noexcept = default;

    ~Mobilogram() = default;


    bool operator==(const Mobilogram& rhs) const;

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


    MobilityPeak1D& operator[](Size i) noexcept
    {
      return data_[i];  
    }
    const MobilityPeak1D& operator[](Size i) const noexcept
    {
      return data_[i];
    }


    MobilityPeak1D& front() noexcept
    {
      return data_.front();
    }
    const MobilityPeak1D& front() const noexcept
    {
      return data_.front();
    }

    MobilityPeak1D& back() noexcept
    {
      return data_.back();
    }
    const MobilityPeak1D& back() const noexcept
    {
      return data_.back();
    }

    Iterator begin() noexcept
    {
      return data_.begin();
    }
    ConstIterator begin() const noexcept
    {
      return data_.begin();
    }
    ConstIterator cbegin() const noexcept
    {
      return data_.cbegin();
    }

    Iterator end() noexcept
    {
      return data_.end();
    }
    ConstIterator end() const noexcept
    {
      return data_.end();
    }
    ConstIterator cend() const noexcept
    {
      return data_.cend();
    }

    ReverseIterator rbegin() noexcept
    {
      return data_.rbegin();
    }
    ConstReverseIterator crbegin() const
    {
      return data_.crbegin();
    }
    ReverseIterator rend() noexcept
    {
      return data_.rend();
    }
    ConstReverseIterator crend() const
    {
      return data_.crend();
    }

    bool empty() const noexcept
    {
      return data_.empty();
    }
    ConstIterator erase(ConstIterator where) noexcept
    {
      return data_.erase(where);
    }

    void push_back(MobilityPeak1D mb)
    {
      data_.push_back(mb);
    }
    MobilityPeak1D& emplace_back(MobilityPeak1D mb)
    {
      return data_.emplace_back(mb);
    }
    template<class... Args>
    void emplace_back(Args&&... args)
    {
      data_.emplace_back(args...);
    }

    void pop_back()
    {
      data_.pop_back();
    }

    Iterator insert(ConstIterator where, ConstIterator first, ConstIterator last)
    {
      return data_.insert(where, first, last);
    }

    void resize(size_t new_size)
    {
      return data_.resize(new_size);
    }
    void reserve(size_t new_size)
    {
      return data_.reserve(new_size);
    }

    size_t size() const noexcept
    {
      return data_.size();
    }

    void swap(Mobilogram& mb) noexcept
    {
      data_.swap(mb.data_);
      std::swap(retention_time_, mb.retention_time_);
      std::swap(drift_time_unit_, mb.drift_time_unit_);
    }

    // Docu in base class (RangeManager)
    void updateRanges() override;

    double getRT() const noexcept
    {
      return retention_time_;
    }

    void setRT(double rt) noexcept
    {
      retention_time_ = rt; 
    }

    DriftTimeUnit getDriftTimeUnit() const noexcept
    {
      return drift_time_unit_;
    }

    String getDriftTimeUnitAsString() const;

    void setDriftTimeUnit(DriftTimeUnit dt) noexcept;





    void sortByIntensity(bool reverse = false);

    void sortByPosition();

    bool isSorted() const;

    template<class Predicate>
    bool isSorted(const Predicate& lambda) const
    {
      auto value_2_index_wrapper = [this, &lambda](const PeakType& value1, const PeakType& value2) {
        // translate values into indices (this relies on no copies being made!)
        const Size index1 = (&value1) - (&this->front());
        const Size index2 = (&value2) - (&this->front());
        // just make sure the pointers above are actually pointing to a Peak inside our container
        assert(index1 < this->size());
        assert(index2 < this->size());
        return lambda(index1, index2);
      };
      return std::is_sorted(this->begin(), this->end(), value_2_index_wrapper);
    }



    Size findNearest(CoordinateType mb) const;

    Int findNearest(CoordinateType mb, CoordinateType tolerance) const;

    Int findNearest(CoordinateType mb, CoordinateType tolerance_left, CoordinateType tolerance_right) const;

    Int findHighestInWindow(CoordinateType mb, CoordinateType tolerance_left, CoordinateType tolerance_right) const;

    Iterator MBBegin(CoordinateType mb);

    Iterator MBBegin(Iterator begin, CoordinateType mb, Iterator end);

    Iterator MBEnd(CoordinateType mb);

    Iterator MBEnd(Iterator begin, CoordinateType mb, Iterator end);

    ConstIterator MBBegin(CoordinateType mb) const;

    ConstIterator MBBegin(ConstIterator begin, CoordinateType mb, ConstIterator end) const;

    ConstIterator MBEnd(CoordinateType mb) const;

    ConstIterator MBEnd(ConstIterator begin, CoordinateType mb, ConstIterator end) const;

    Iterator PosBegin(CoordinateType mb);

    Iterator PosBegin(Iterator begin, CoordinateType mb, Iterator end);

    ConstIterator PosBegin(CoordinateType mb) const;

    ConstIterator PosBegin(ConstIterator begin, CoordinateType mb, ConstIterator end) const;

    Iterator PosEnd(CoordinateType mb);

    Iterator PosEnd(Iterator begin, CoordinateType mb, Iterator end);

    ConstIterator PosEnd(CoordinateType mb) const;

    ConstIterator PosEnd(ConstIterator begin, CoordinateType mb, ConstIterator end) const;



    void clear() noexcept;

    ConstIterator getBasePeak() const;

    Iterator getBasePeak();

    PeakType::IntensityType calculateTIC() const;

  protected:
    std::vector<MobilityPeak1D> data_;

    double retention_time_ = -1;

    DriftTimeUnit drift_time_unit_ = DriftTimeUnit::NONE;
  };

  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Mobilogram& mb);
} // namespace OpenMS