RANSACModel.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-2017.
//
// 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: George Rosenberger $
// $Authors: George Rosenberger, Hannes Roest, Chris Bielow $
// --------------------------------------------------------------------------

#ifndef OPENMS_MATH_MISC_RANSACMODEL_H
#define OPENMS_MATH_MISC_RANSACMODEL_H

#include <OpenMS/config.h>

#include <cstddef> // for size_t & ptrdiff_t
#include <vector>
#include <string>

namespace OpenMS
{

  namespace Math
  {

    template<class ModelT = int> // dummy default to allow easy access to public typedefs
    class RansacModel
    {
  public:
      typedef std::pair<double, double> DPair;
      typedef std::vector<DPair> DVec;
      typedef DVec::const_iterator DVecIt;
      typedef std::vector<double> ModelParameters;


      ModelParameters rm_fit(const DVecIt& begin, const DVecIt& end) const
      {
        return static_cast<const ModelT*>(this)->rm_fit_impl(begin, end);
      }
      
      double rm_rsq(const DVecIt& begin, const DVecIt& end) const
      {
        return static_cast<const ModelT*>(this)->rm_rsq_impl(begin, end);
      }

      double rm_rss(const DVecIt& begin, const DVecIt& end, const ModelParameters& coefficients) const
      {
        return static_cast<const ModelT*>(this)->rm_rss_impl(begin, end, coefficients);
      }

      DVec rm_inliers(const DVecIt& begin, const DVecIt& end, const ModelParameters& coefficients, double max_threshold) const
      {
        return static_cast<const ModelT*>(this)->rm_inliers_impl(begin, end, coefficients, max_threshold);
      }
    };

  }


}
#endif // OPENMS_MATH_MISC_RANSACMODEL_H