Package de.gsi.math.functions

Class TrigSineFunction

java.lang.Object

de.gsi.math.functions.AbstractFunction

de.gsi.math.functions.AbstractFunction1D

de.gsi.math.functions.TrigSineFunction

All Implemented Interfaces:

Function, Function1D

public class TrigSineFunction
extends AbstractFunction1D
implements Function1D

class implementing the trigonometric Sine function

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
TrigSineFunction(java.lang.String name)
TrigSineFunction(java.lang.String name, double[] parameter)	initialise Sine function y = [0]*sin(2*pi*[[1]*t+[2]]) parameter order: parameter[0] = amplitude (default: 1.0) parameter[1] = frequency (default: 1.0) parameter[2] = phase (default: 1.0)

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

TrigSineFunction

public TrigSineFunction(java.lang.String name)

TrigSineFunction

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

initialise Sine function y = [0]*sin(2*pi*[[1]*t+[2]]) parameter order: parameter[0] = amplitude (default: 1.0) parameter[1] = frequency (default: 1.0) parameter[2] = phase (default: 1.0)

Parameters:

name - function name

parameter - function parameter

Method Detail

getValue

public double getValue(double x)

Specified by:

getValue in interface Function1D