Package org.apache.commons.math3.fitting

Class HarmonicFitter

java.lang.Object
org.apache.commons.math3.fitting.CurveFitter<HarmonicOscillator.Parametric>
org.apache.commons.math3.fitting.HarmonicFitter
@Deprecated public class HarmonicFitter extends CurveFitter<HarmonicOscillator.Parametric>
Deprecated.
As of 3.3. Please use HarmonicCurveFitter and WeightedObservedPoints instead.
Class that implements a curve fitting specialized for sinusoids. Harmonic fitting is a very simple case of curve fitting. The estimated coefficients are the amplitude a, the pulsation ω and the phase φ: f (t) = a cos (ω t + φ). They are searched by a least square estimator initialized with a rough guess based on integrals.
Since:
2.0

  • Constructor Details

    • HarmonicFitter

      public HarmonicFitter(MultivariateVectorOptimizer optimizer)
      Deprecated.
      Simple constructor.
      Parameters:
      optimizer - Optimizer to use for the fitting.

  • Method Details

    • fit

      public double[] fit(double[] initialGuess)
      Deprecated.
      Fit an harmonic function to the observed points.
      Parameters:
      initialGuess - First guess values in the following order:
      • Amplitude
      • Angular frequency
      • Phase
      Returns:
      the parameters of the harmonic function that best fits the observed points (in the same order as above).

    • fit

      public double[] fit()
      Deprecated.
      Fit an harmonic function to the observed points. An initial guess will be automatically computed.
      Returns:
      the parameters of the harmonic function that best fits the observed points (see the other fit method.
      Throws:
      NumberIsTooSmallException - if the sample is too short for the the first guess to be computed.
      ZeroException - if the first guess cannot be computed because the abscissa range is zero.