SplineFitter.h

Go to the documentation of this file.

#ifndef SimTK_SIMMATH_SPLINE_FITTER_H_
#define SimTK_SIMMATH_SPLINE_FITTER_H_

/* -------------------------------------------------------------------------- *
 *                      SimTK Core: SimTK Simmath(tm)                         *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK Core biosimulation toolkit originating from      *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org.               *
 *                                                                            *
 * Portions copyright (c) 2008 Stanford University and the Authors.           *
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
 * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
 * -------------------------------------------------------------------------- */

#include "SimTKcommon.h"
#include "simmath/internal/common.h"
#include "simmath/internal/Spline.h"
#include "simmath/internal/GCVSPLUtil.h"

namespace SimTK {

template <class T>
class SplineFitter {
public:
    SplineFitter(const SplineFitter& copy) : impl(copy.impl) {
        impl->referenceCount++;
    }
    SplineFitter operator=(const SplineFitter& copy) {
        impl = copy.impl;
        impl->referenceCount++;
        return *this;
    }
    ~SplineFitter() {
        impl->referenceCount--;
        if (impl->referenceCount == 0)
            delete impl;
    }
    static SplineFitter fitFromGCV(int degree, const Vector& x, const Vector_<T>& y) {
        Vector_<T> coeff;
        Vector wk;
        int ier;
        GCVSPLUtil::gcvspl(x, y, Vector(x.size(), 1.0), static_cast<T>(1), degree, 2, 0, coeff, wk, ier);
        return SplineFitter<T>(new SplineFitterImpl(degree, Spline_<T>(degree, x, coeff), wk[3], wk[4], wk[2]));
    }
    static SplineFitter fitFromErrorVariance(int degree, const Vector& x, const Vector_<T>& y, Real error) {
        Vector_<T> coeff;
        Vector wk;
        int ier;
        GCVSPLUtil::gcvspl(x, y, Vector(x.size(), 1.0), 1, degree, 3, error, coeff, wk, ier);
        return SplineFitter<T>(new SplineFitterImpl(degree, Spline_<T>(degree, x, coeff), wk[3], wk[4], wk[2]));
    }
    static SplineFitter fitFromDOF(int degree, const Vector& x, const Vector_<T>& y, Real dof) {
        Vector_<T> coeff;
        Vector wk;
        int ier;
        GCVSPLUtil::gcvspl(x, y, Vector(x.size(), 1.0), static_cast<T>(1), degree, 4, dof, coeff, wk, ier);
        return SplineFitter<T>(new SplineFitterImpl(degree, Spline_<T>(degree, x, coeff), wk[3], wk[4], wk[2]));
    }
    static SplineFitter fitForSmoothingParameter(int degree, const Vector& x, const Vector_<T>& y, Real p) {
        Vector_<T> coeff;
        Vector wk;
        int ier;
        GCVSPLUtil::gcvspl(x, y, Vector(x.size(), 1.0), static_cast<T>(1), degree, 1, p, coeff, wk, ier);
        return SplineFitter<T>(new SplineFitterImpl(degree, Spline_<T>(degree, x, coeff), wk[3], wk[4], wk[2]));
    }
    const Spline_<T>& getSpline() {
        return impl->spline;
    }
    Real getSmoothingParameter() {
        return impl->p;
    }
    Real getMeanSquaredError() {
        return impl->error;
    }
    Real getDegreesOfFreedom() {
        return impl->dof;
    }
private:
    class SplineFitterImpl;
    SplineFitter(SplineFitterImpl *impl) : impl(impl) {
    }
    SplineFitterImpl* impl;
};

template <class T>
class SplineFitter<T>::SplineFitterImpl {
public:
    SplineFitterImpl(int degree, const Spline_<T>& spline, Real p, Real error, Real dof) : referenceCount(1), degree(degree), spline(spline), p(p), error(error), dof(dof) {
    }
    ~SplineFitterImpl() {
        assert(referenceCount == 0);
    }
    int referenceCount;
    int degree;
    Spline_<T> spline;
    Real p, error, dof;
};

} // namespace SimTK

#endif // SimTK_SIMMATH_SPLINE_FITTER_H_