TransformationDescription.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-2021.
//
// 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: Clemens Groepl, Hendrik Weisser $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
#include <OpenMS/ANALYSIS/MAPMATCHING/TransformationModel.h>
#include <iosfwd>
#include <map>
 
namespace OpenMS
{
  class OPENMS_DLLAPI TransformationDescription
  {
    // friend class MapAlignmentAlgorithm;
 
public:
 
    struct TransformationStatistics
    {
      // default constructor
      TransformationStatistics() = default;
 
      // copy constructor
      TransformationStatistics(const TransformationStatistics& rhs) = default;
 
      // copy assignment
      TransformationStatistics& operator=(const TransformationStatistics& rhs) = default;
 
      std::vector<Size> percents = {100, 99, 95, 90, 75, 50, 25};  // TODO: use constexpr array
      double xmin = 0; 
      double xmax = 0; 
      double ymin = 0; 
      double ymax = 0; 
      
      std::map<Size, double> percentiles_before; 
      std::map<Size, double> percentiles_after; 
    };
    
 
    typedef TransformationModel::DataPoint DataPoint;
    typedef TransformationModel::DataPoints DataPoints;
 
    TransformationDescription();
    
    explicit TransformationDescription(const DataPoints& data);
    
    ~TransformationDescription();
 
    TransformationDescription(const TransformationDescription& rhs);
    TransformationDescription& operator=(const TransformationDescription& rhs);
 
    void fitModel(const String& model_type, const Param& params = Param());
 
    double apply(double value) const;
 
    const String& getModelType() const;
 
    static void getModelTypes(StringList& result);
 
    void setDataPoints(const DataPoints& data);
 
    void setDataPoints(const std::vector<std::pair<double, double> >& data);
 
    const DataPoints& getDataPoints() const;
 
    const Param& getModelParameters() const;
 
    void invert();
 
    void getDeviations(std::vector<double>& diffs, bool do_apply = false,
                       bool do_sort = true) const;
 
    TransformationStatistics getStatistics() const;
 
    void printSummary(std::ostream& os) const;
 
protected:
    DataPoints data_;
    String model_type_;
    TransformationModel* model_;
  };
 
} // end of namespace OpenMS