xal.extension.fit.lsm

Class Gaussian

java.lang.Object

xal.extension.fit.lsm.Gaussian

public class Gaussian
extends java.lang.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.)).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AMP The "amplitude" parameter
static java.lang.String	CENTER The "center" parameter
static java.lang.String	PEDESTAL The "pedestal" parameter
static java.lang.String	SIGMA The "sigma" parameter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addData(double x, double y) Adds a data point to the internal data
void	addData(double x, double y, double y_err) 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(java.lang.String key) Returns the boolean vaiable about including variable into the fitting
void	fitParameter(java.lang.String key, boolean incl) Includes or excludes the parameter into fitting
double	getParameter(java.lang.String key) Returns the parameter value
double	getParameterError(java.lang.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(java.lang.String[] args) MAIN for debugging
void	setData(double[] x_arr, double[] y_arr) Sets the data attribute of the Gaussian object
void	setData(double[] x_arr, double[] y_arr, double[] y_err_arr) Sets the data attribute of the Gaussian object
void	setParameter(java.lang.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 Detail

SIGMA

public static java.lang.String SIGMA

The "sigma" parameter

AMP

public static java.lang.String AMP

The "amplitude" parameter

CENTER

public static java.lang.String CENTER

The "center" parameter

PEDESTAL

public static java.lang.String PEDESTAL

The "pedestal" parameter

Constructor Detail

Gaussian

public Gaussian()

Creates a new instance of Gaussian

Method Detail

getParameter

public double getParameter(java.lang.String key)

Returns the parameter value

Parameters:

key - The parameter name

Returns:

The parameter value

getParameterError

public double getParameterError(java.lang.String key)

Returns the parameter value error

Parameters:

key - The parameter name

Returns:

The parameter value error

fitParameter

public void fitParameter(java.lang.String key,
                         boolean incl)

Includes or excludes the parameter into fitting

Parameters:

key - The parameter name

incl - The boolean vaiable about including variable into the fitting

fitParameter

public boolean fitParameter(java.lang.String key)

Returns the boolean vaiable about including variable into the fitting

Parameters:

key - The parameter name

setParameter

public void setParameter(java.lang.String key,
                         double val)

Sets the parameter value

Parameters:

key - The parameter name

val - The new parameter value

setData

public void setData(double[] x_arr,
                    double[] y_arr,
                    double[] y_err_arr)

Sets the data attribute of the Gaussian object

Parameters:

y_arr - Y data array

y_err_arr - Y values error array

x_arr - The new data value

setData

public void setData(double[] x_arr,
                    double[] y_arr)

Sets the data attribute of the Gaussian object

Parameters:

y_arr - Y data array

x_arr - 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 y_err)

Adds a data point to the internal data

Parameters:

x - The x value

y - The y valu

y_err - 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(java.lang.String[] args)

MAIN for debugging

Parameters:

args - The array of strings as parameters