Package de.gsi.math.functions

Class SigmoidFunction

java.lang.Object

de.gsi.math.functions.AbstractFunction

de.gsi.math.functions.AbstractFunction1D

de.gsi.math.functions.SigmoidFunction

All Implemented Interfaces:

Function, Function1D

public class SigmoidFunction
extends AbstractFunction1D
implements Function1D

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
SigmoidFunction(java.lang.String name)	initialise the sigmoid function y = 1.0/(1.0*exp(-slope*(x-location)))) parameter order: parameter[0] = location (default: 0.0) parameter[1] = slope (default: 1.0) parameter[2] = scaling (default: 1.0 (fixed))
SigmoidFunction(java.lang.String name, double[] parameter)	initialise the sigmoid function y = 1.0/(1.0*exp(-slope*(x-location)))) parameter order: parameter[0] = location (default: 0.0) parameter[1] = slope (default: 1.0) parameter[2] = scaling (default: 1.0 (fixed))

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

SigmoidFunction

public SigmoidFunction(java.lang.String name)

initialise the sigmoid function y = 1.0/(1.0*exp(-slope*(x-location)))) parameter order: parameter[0] = location (default: 0.0) parameter[1] = slope (default: 1.0) parameter[2] = scaling (default: 1.0 (fixed))

Parameters:

name - function name

SigmoidFunction

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

initialise the sigmoid function y = 1.0/(1.0*exp(-slope*(x-location)))) parameter order: parameter[0] = location (default: 0.0) parameter[1] = slope (default: 1.0) parameter[2] = scaling (default: 1.0 (fixed))

Parameters:

name - function name

parameter - function parameter

Method Detail

getValue

public double getValue(double x)

Specified by:

getValue in interface Function1D