Package de.gsi.math.functions

Class TruncatedGaussianFunction

java.lang.Object

de.gsi.math.functions.AbstractFunction

de.gsi.math.functions.AbstractFunction1D

de.gsi.math.functions.TruncatedGaussianFunction

All Implemented Interfaces:

Function, Function1D

public class TruncatedGaussianFunction
extends AbstractFunction1D
implements Function1D

class implementing the Gaussian function (/normal distribution)

Author:

rstein

Field Summary

Fields inherited from class de.gsi.math.functions.AbstractFunction

fitterMode, fparameter, fparameterCopy, fparameterFixed, fparameterMax, fparameterMin, fparameterName

Constructor Summary

Constructors

Constructor	Description
TruncatedGaussianFunction(java.lang.String name)	initialise Gaussian function (/normal distribution) y = scale/(sigma*sqrt(2.pi)) * exp( -0.5 [(x - mean)/sigma]^2 ) parameter order: parameter[0] = mean (default: 0.0) parameter[1] = sigma (default: 1.0) parameter[2] = scale (default: 1.0) parameter[3] = truncation (default: 3.0 sigma)
TruncatedGaussianFunction(java.lang.String name, double[] parameter)	initialise Gaussian function (/normal distribution) y = scale/(sigma*sqrt(2.pi)) * exp( -0.5 [(x - mean)/sigma]^2 ) parameter order: parameter[0] = mean (default: 0.0) parameter[1] = sigma (default: 1.0) parameter[2] = scale (default: 1.0) parameter[3] = truncation (default: 2.0 sigma)

Method Summary

Modifier and Type	Method	Description
double	getValue(double x)

Methods inherited from class de.gsi.math.functions.AbstractFunction1D

getInputDimension, getOutputDimension, isErrorEstimateComputed, setErrorEstimateComputation

Methods inherited from class de.gsi.math.functions.AbstractFunction

addFunction, addListener, clearParameterValues, fixParameter, getFreeParameterCount, getFunctions, getID, getName, getParameterCount, getParameterName, getParameterRangeMaximum, getParameterRangeMinimum, getParameterValue, getParameterValues, invokeListener, isFitterMode, isParameterFixed, printParameters, printParameters, removeFunction, removeListener, setFitterMode, setParameterCount, setParameterName, setParameterRange, setParameterValue, setParameterValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gsi.math.functions.Function

clearParameterValues, fixParameter, getFreeParameterCount, getID, getInputDimension, getName, getOutputDimension, getParameterCount, getParameterName, getParameterRangeMaximum, getParameterRangeMinimum, getParameterValue, isFitterMode, isParameterFixed, setFitterMode, setParameterCount, setParameterName, setParameterRange, setParameterValue, setParameterValues

Methods inherited from interface de.gsi.math.functions.Function1D

getDataSetEstimate, getDataSetEstimate, getValues

Constructor Detail

TruncatedGaussianFunction

public TruncatedGaussianFunction(java.lang.String name)

initialise Gaussian function (/normal distribution) y = scale/(sigma*sqrt(2.pi)) * exp( -0.5 [(x - mean)/sigma]^2 ) parameter order: parameter[0] = mean (default: 0.0) parameter[1] = sigma (default: 1.0) parameter[2] = scale (default: 1.0) parameter[3] = truncation (default: 3.0 sigma)

Parameters:

name - function name

TruncatedGaussianFunction

public TruncatedGaussianFunction(java.lang.String name,
                                 double[] parameter)

initialise Gaussian function (/normal distribution) y = scale/(sigma*sqrt(2.pi)) * exp( -0.5 [(x - mean)/sigma]^2 ) parameter order: parameter[0] = mean (default: 0.0) parameter[1] = sigma (default: 1.0) parameter[2] = scale (default: 1.0) parameter[3] = truncation (default: 2.0 sigma)

Parameters:

name - function name

parameter - function parameter

Method Detail

getValue

public double getValue(double x)

Specified by:

getValue in interface Function1D