Package xal.extension.fit.lsm

Class Gaussian

java.lang.Object
xal.extension.fit.lsm.Gaussian
public class Gaussian extends Object
This class is for data fitting with Gaussian function. The Gaussian function form used in this class is y = pedestal+amp*exp(-(x-center)^2/(sigma^2/2.)).
Author:
shishlo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AMP_STR
    The "amplitude" parameter
    static final String
    CENTER_STR
    The "center" parameter
    static final String
    PEDESTAL_STR
    The "pedestal" parameter
    static final String
    SIGMA_STR
    The "sigma" parameter

  • Constructor Summary

    Constructors
    Constructor
    Description
    Gaussian()
    Creates a new instance of Gaussian

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addData(double x, double y)
    Adds a data point to the internal data
    void
    addData(double x, double y, double yErr)
    Adds a data point to the internal data
    void
    clear()
    Removes all internal data
    boolean
    fit()
    perform one step of the data fit
    boolean
    fit(int iteration)
    perform the data fit
    boolean
    fitParameter(String key)
    Returns the boolean variable about including variable into the fitting
    void
    fitParameter(String key, boolean incl)
    Includes or excludes the parameter into fitting
    double
    getParameter(String key)
    Returns the parameter value
    double
    getParameterError(String key)
    Returns the parameter value error
    double
    getValue(double x)
    Returns the value of Gaussian function
    boolean
    guessAndFit()
    Finds the parameters of Gaussian with initial values defined from raw data
    boolean
    guessAndFit(int iteration)
    Perform the several iterations of the data fit with guessing the initial values of parameters
    static void
    main(String[] args)
    MAIN for debugging
    void
    setData(double[] xArr, double[] yArr)
    Sets the data attribute of the Gaussian object
    void
    setData(double[] xArr, double[] yArr, double[] yErrArr)
    Sets the data attribute of the Gaussian object
    void
    setParameter(String key, double val)
    Sets the parameter value

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • Gaussian

      public Gaussian()
      Creates a new instance of Gaussian

  • Method Details

    • getParameter

      public double getParameter(String key)
      Returns the parameter value
      Parameters:
      key - The parameter name
      Returns:
      The parameter value

    • getParameterError

      public double getParameterError(String key)
      Returns the parameter value error
      Parameters:
      key - The parameter name
      Returns:
      The parameter value error

    • fitParameter

      public void fitParameter(String key, boolean incl)
      Includes or excludes the parameter into fitting
      Parameters:
      key - The parameter name
      incl - The boolean variable about including variable into the fitting

    • fitParameter

      public boolean fitParameter(String key)
      Returns the boolean variable about including variable into the fitting
      Parameters:
      key - The parameter name

    • setParameter

      public void setParameter(String key, double val)
      Sets the parameter value
      Parameters:
      key - The parameter name
      val - The new parameter value

    • setData

      public void setData(double[] xArr, double[] yArr, double[] yErrArr)
      Sets the data attribute of the Gaussian object
      Parameters:
      yArr - Y data array
      yErrArr - Y values error array
      xArr - The new data value

    • setData

      public void setData(double[] xArr, double[] yArr)
      Sets the data attribute of the Gaussian object
      Parameters:
      yArr - Y data array
      xArr - The new data value

    • clear

      public void clear()
      Removes all internal data

    • addData

      public void addData(double x, double y)
      Adds a data point to the internal data
      Parameters:
      x - The x value
      y - The y value

    • addData

      public void addData(double x, double y, double yErr)
      Adds a data point to the internal data
      Parameters:
      x - The x value
      y - The y valu
      yErr - The error of the y value

    • fit

      public boolean fit(int iteration)
      perform the data fit
      Parameters:
      iteration - The number of iterations
      Returns:
      Success or not

    • fit

      public boolean fit()
      perform one step of the data fit
      Returns:
      Success or not

    • guessAndFit

      public boolean guessAndFit(int iteration)
      Perform the several iterations of the data fit with guessing the initial values of parameters
      Parameters:
      iteration - The number of iterations
      Returns:
      Success or not

    • guessAndFit

      public boolean guessAndFit()
      Finds the parameters of Gaussian with initial values defined from raw data
      Returns:
      The true is the initial parameters have been defined successfully

    • getValue

      public double getValue(double x)
      Returns the value of Gaussian function
      Parameters:
      x - The x-value
      Returns:
      The Gauss function value

    • main

      public static void main(String[] args)
      MAIN for debugging
      Parameters:
      args - The array of strings as parameters