Package org.apache.commons.math4.legacy.fitting

Class HarmonicCurveFitter

java.lang.Object

org.apache.commons.math4.legacy.fitting.AbstractCurveFitter

org.apache.commons.math4.legacy.fitting.SimpleCurveFitter

org.apache.commons.math4.legacy.fitting.HarmonicCurveFitter

public final class HarmonicCurveFitter
extends SimpleCurveFitter

Fits points to a harmonic oscillator function.
The initial guess values must be passed in the following order:

• Amplitude
• Angular frequency
• phase

The optimal values will be returned in the same order.

Since:

3.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HarmonicCurveFitter.ParameterGuesser	This class guesses harmonic coefficients from a sample.

Nested classes/interfaces inherited from class org.apache.commons.math4.legacy.fitting.AbstractCurveFitter

AbstractCurveFitter.TheoreticalValuesFunction

Method Summary

Modifier and Type	Method	Description
static HarmonicCurveFitter	create()	Creates a default curve fitter.

Methods inherited from class org.apache.commons.math4.legacy.fitting.SimpleCurveFitter

create, create, getProblem, withMaxIterations, withStartPoint

Methods inherited from class org.apache.commons.math4.legacy.fitting.AbstractCurveFitter

fit, getOptimizer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static HarmonicCurveFitter create()

Creates a default curve fitter. The initial guess for the parameters will be HarmonicCurveFitter.ParameterGuesser computed automatically, and the maximum number of iterations of the optimization algorithm is set to Integer.MAX_VALUE.

Returns:

a curve fitter.

See Also:

SimpleCurveFitter.withStartPoint(double[]), SimpleCurveFitter.withMaxIterations(int)