de.gsi.math

Class DataSetMath

java.lang.Object

de.gsi.math.DataSetMath

public final class DataSetMath
extends Object

Some math operation on DataSet and DataSetError

Author:

rstein

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSetMath.ErrType
static class	DataSetMath.Filter
static class	DataSetMath.MathOp

Method Summary

Modifier and Type	Method and Description
static DataSetError	addFunction(DataSet function1, DataSet function2)
static DataSetError	addFunction(DataSet function, double value)
static DataSet	addGaussianNoise(DataSet function, double sigma)
static DataSetError	averageDataSetsFIR(List<DataSet> dataSets, int nUpdates)
static DataSetError	averageDataSetsIIR(DataSet prevAverage, DataSet prevAverage2, DataSet newDataSet, int nUpdates)
protected static double[]	cropToLength(double[] in, int length)
static DataSetError	dbFunction(DataSet function)
static DataSetError	dbFunction(DataSet function1, DataSet function2)
static DataSetError	derivativeFunction(DataSet function)
static DataSetError	derivativeFunction(DataSet function, double sign)
static DataSetError	divideFunction(DataSet function1, DataSet function2)
static DataSetError	divideFunction(DataSet function, double value)
static double	error(DataSet dataSet, DataSetMath.ErrType eType, double x) convenience short-hand notation for getting error variables (if defined for dataset)
static double	error(DataSet dataSet, DataSetMath.ErrType eType, int index) convenience short-hand notation for getting error variables (if defined for dataset)
protected static double	error(DataSet dataSet, DataSetMath.ErrType eType, int index, double x, boolean interpolate)
static double[]	errors(DataSet dataSet, DataSetMath.ErrType eType) convenience short-hand notation for getting error variables (if defined for dataset)
static DataSetError	filterFunction(DataSet function, double width, DataSetMath.Filter filterType)
static DataSetError	geometricMeanFilteredFunction(DataSet function, double width)
static DataSet	getSubRange(DataSet function, double xMin, double xMax)
static DataSetError	iirLowPassFilterFunction(DataSet function, double width)
static DoublePointError	integral(DataSet function)
static DoublePointError	integral(DataSet function, double xMin, double xMax)
static double	integralSimple(DataSet function)
static DataSetError	integrateFunction(DataSet function)
static DataSetError	integrateFunction(DataSet function, double xMin, double xMax)
static DataSetError	log10Function(DataSet function)
static DataSetError	log10Function(DataSet function1, DataSet function2)
static DataSetError	lowPassFilterFunction(DataSet function, double width)
static DataSetError	magnitudeSpectrum(DataSet function)
static DataSetError	magnitudeSpectrum(DataSet function, Apodization apodization, boolean dbScale, boolean normalisedFrequency)
static DataSetError	magnitudeSpectrumDecibel(DataSet function)
static DataSetError	mathFunction(DataSet function1, DataSet function2, DataSetMath.MathOp op)
static DataSetError	mathFunction(DataSet function, double value, DataSetMath.MathOp op)
static DataSetError	maxFilteredFunction(DataSet function, double width)
static DataSetError	medianFilteredFunction(DataSet function, double width)
static DataSetError	minFilteredFunction(DataSet function, double width)
static DataSetError	multiplyFunction(DataSet function1, DataSet function2)
static DataSetError	multiplyFunction(DataSet function, double value)
static DataSetError	normalisedFunction(DataSet function)
static DataSetError	normalisedFunction(DataSet function, double requiredIntegral)
static DataSetError	normalisedMagnitudeSpectrumDecibel(DataSet function)
static DataSetError	peakToPeakFilteredFunction(DataSet function, double width)
static DataSetError	rmsFilteredFunction(DataSet function, double width)
static EditableDataSet	setFunction(EditableDataSet function, double value, double xMin, double xMax)
static DataSetError	sqrFunction(DataSet function)
static DataSetError	sqrFunction(DataSet function1, DataSet function2)
static DataSetError	sqrtFunction(DataSet function)
static DataSetError	sqrtFunction(DataSet function1, DataSet function2)
static DataSetError	subtractFunction(DataSet function1, DataSet function2)
static DataSetError	subtractFunction(DataSet function, double value)

Methods inherited from class java.lang.Object

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

Method Detail

error

public static double error(DataSet dataSet,
                           DataSetMath.ErrType eType,
                           int index)

convenience short-hand notation for getting error variables (if defined for dataset)

Parameters:

dataSet - the source data set

eType - the error type

index - the data set index

Returns:

the given error

error

public static double error(DataSet dataSet,
                           DataSetMath.ErrType eType,
                           double x)

convenience short-hand notation for getting error variables (if defined for dataset)

Parameters:

dataSet - the source data set

eType - the error type

x - the data set x-value for which the error should be interpolated

Returns:

the given interpolated error

error

protected static double error(DataSet dataSet,
                              DataSetMath.ErrType eType,
                              int index,
                              double x,
                              boolean interpolate)

cropToLength

protected static double[] cropToLength(double[] in,
                                       int length)

errors

public static double[] errors(DataSet dataSet,
                              DataSetMath.ErrType eType)

convenience short-hand notation for getting error variables (if defined for dataset)

Parameters:

dataSet - the source data set

eType - the error type

Returns:

the given error array (cropped to data set length if necessary)

averageDataSetsIIR

public static DataSetError averageDataSetsIIR(DataSet prevAverage,
                                              DataSet prevAverage2,
                                              DataSet newDataSet,
                                              int nUpdates)

averageDataSetsFIR

public static DataSetError averageDataSetsFIR(List<DataSet> dataSets,
                                              int nUpdates)

integrateFunction

public static DataSetError integrateFunction(DataSet function)

integrateFunction

public static DataSetError integrateFunction(DataSet function,
                                             double xMin,
                                             double xMax)

integral

public static DoublePointError integral(DataSet function)

integral

public static DoublePointError integral(DataSet function,
                                        double xMin,
                                        double xMax)

integralSimple

public static double integralSimple(DataSet function)

derivativeFunction

public static DataSetError derivativeFunction(DataSet function)

derivativeFunction

public static DataSetError derivativeFunction(DataSet function,
                                              double sign)

normalisedFunction

public static DataSetError normalisedFunction(DataSet function)

normalisedFunction

public static DataSetError normalisedFunction(DataSet function,
                                              double requiredIntegral)

lowPassFilterFunction

public static DataSetError lowPassFilterFunction(DataSet function,
                                                 double width)

medianFilteredFunction

public static DataSetError medianFilteredFunction(DataSet function,
                                                  double width)

minFilteredFunction

public static DataSetError minFilteredFunction(DataSet function,
                                               double width)

maxFilteredFunction

public static DataSetError maxFilteredFunction(DataSet function,
                                               double width)

peakToPeakFilteredFunction

public static DataSetError peakToPeakFilteredFunction(DataSet function,
                                                      double width)

rmsFilteredFunction

public static DataSetError rmsFilteredFunction(DataSet function,
                                               double width)

geometricMeanFilteredFunction

public static DataSetError geometricMeanFilteredFunction(DataSet function,
                                                         double width)

filterFunction

public static DataSetError filterFunction(DataSet function,
                                          double width,
                                          DataSetMath.Filter filterType)

iirLowPassFilterFunction

public static DataSetError iirLowPassFilterFunction(DataSet function,
                                                    double width)

addFunction

public static DataSetError addFunction(DataSet function,
                                       double value)

addFunction

public static DataSetError addFunction(DataSet function1,
                                       DataSet function2)

subtractFunction

public static DataSetError subtractFunction(DataSet function,
                                            double value)

subtractFunction

public static DataSetError subtractFunction(DataSet function1,
                                            DataSet function2)

multiplyFunction

public static DataSetError multiplyFunction(DataSet function,
                                            double value)

multiplyFunction

public static DataSetError multiplyFunction(DataSet function1,
                                            DataSet function2)

divideFunction

public static DataSetError divideFunction(DataSet function,
                                          double value)

divideFunction

public static DataSetError divideFunction(DataSet function1,
                                          DataSet function2)

sqrFunction

public static DataSetError sqrFunction(DataSet function)

sqrFunction

public static DataSetError sqrFunction(DataSet function1,
                                       DataSet function2)

sqrtFunction

public static DataSetError sqrtFunction(DataSet function)

sqrtFunction

public static DataSetError sqrtFunction(DataSet function1,
                                        DataSet function2)

log10Function

public static DataSetError log10Function(DataSet function)

log10Function

public static DataSetError log10Function(DataSet function1,
                                         DataSet function2)

dbFunction

public static DataSetError dbFunction(DataSet function)

dbFunction

public static DataSetError dbFunction(DataSet function1,
                                      DataSet function2)

mathFunction

public static DataSetError mathFunction(DataSet function,
                                        double value,
                                        DataSetMath.MathOp op)

mathFunction

public static DataSetError mathFunction(DataSet function1,
                                        DataSet function2,
                                        DataSetMath.MathOp op)

magnitudeSpectrum

public static DataSetError magnitudeSpectrum(DataSet function)

normalisedMagnitudeSpectrumDecibel

public static DataSetError normalisedMagnitudeSpectrumDecibel(DataSet function)

magnitudeSpectrumDecibel

public static DataSetError magnitudeSpectrumDecibel(DataSet function)

magnitudeSpectrum

public static DataSetError magnitudeSpectrum(DataSet function,
                                             Apodization apodization,
                                             boolean dbScale,
                                             boolean normalisedFrequency)

setFunction

public static EditableDataSet setFunction(EditableDataSet function,
                                          double value,
                                          double xMin,
                                          double xMax)

addGaussianNoise

public static DataSet addGaussianNoise(DataSet function,
                                       double sigma)

getSubRange

public static DataSet getSubRange(DataSet function,
                                  double xMin,
                                  double xMax)