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 DataSet	addFunction(DataSet function1, DataSet function2)
static DataSet	addFunction(DataSet function, double value)
static DataSet	addGaussianNoise(DataSet function, double sigma)
static DataSet	averageDataSetsFIR(List<DataSet> dataSets, int nUpdates)
static DataSet	averageDataSetsIIR(DataSet prevAverage, DataSet prevAverage2, DataSet newDataSet, int nUpdates)
static DataSet	dbFunction(DataSet function)
static DataSet	dbFunction(DataSet function1, DataSet function2)
static DataSet	derivativeFunction(DataSet function)
static DataSet	derivativeFunction(DataSet function, double sign)
static DataSet	divideFunction(DataSet function1, DataSet function2)
static DataSet	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 DataSet	filterFunction(DataSet function, double width, DataSetMath.Filter filterType)
static DataSet	geometricMeanFilteredFunction(DataSet function, double width)
static DataSet	getSubRange(DataSet function, double xMin, double xMax)
static DataSet	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 DataSet	integrateFunction(DataSet function)
static DataSet	integrateFunction(DataSet function, double xMin, double xMax)
static DataSet	inversedbFunction(DataSet function)
static DataSet	log10Function(DataSet function)
static DataSet	log10Function(DataSet function1, DataSet function2)
static DataSet	lowPassFilterFunction(DataSet function, double width)
static DataSet	magnitudeSpectrum(DataSet function)
static DataSet	magnitudeSpectrum(DataSet function, Apodization apodization, boolean dbScale, boolean normalisedFrequency)
static DataSet	magnitudeSpectrumDecibel(DataSet function)
static DataSet	mathFunction(DataSet function1, DataSet function2, DataSetMath.MathOp op)
static DataSet	mathFunction(DataSet function, double value, DataSetMath.MathOp op)
static DataSet	maxFilteredFunction(DataSet function, double width)
static DataSet	medianFilteredFunction(DataSet function, double width)
static DataSet	minFilteredFunction(DataSet function, double width)
static DataSet	multiplyFunction(DataSet function1, DataSet function2)
static DataSet	multiplyFunction(DataSet function, double value)
static DataSet	normalisedFunction(DataSet function)
static DataSet	normalisedFunction(DataSet function, double requiredIntegral)
static DataSet	normalisedMagnitudeSpectrumDecibel(DataSet function)
static DataSet	peakToPeakFilteredFunction(DataSet function, double width)
static DataSet	rmsFilteredFunction(DataSet function, double width)
static EditableDataSet	setFunction(EditableDataSet function, double value, double xMin, double xMax)
static DataSet	sqrFunction(DataSet function)
static DataSet	sqrFunction(DataSet function1, DataSet function2)
static DataSet	sqrtFunction(DataSet function)
static DataSet	sqrtFunction(DataSet function1, DataSet function2)
static DataSet	subtractFunction(DataSet function1, DataSet function2)
static DataSet	subtractFunction(DataSet function, double value)
static double[]	values(int dimIndex, DataSet dataSet) convenience short-hand notation for getting value array

Methods inherited from class java.lang.Object

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

Method Detail

addFunction

public static DataSet addFunction(DataSet function1,
                                  DataSet function2)

addFunction

public static DataSet addFunction(DataSet function,
                                  double value)

addGaussianNoise

public static DataSet addGaussianNoise(DataSet function,
                                       double sigma)

averageDataSetsFIR

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

averageDataSetsIIR

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

dbFunction

public static DataSet dbFunction(DataSet function)

inversedbFunction

public static DataSet inversedbFunction(DataSet function)

dbFunction

public static DataSet dbFunction(DataSet function1,
                                 DataSet function2)

derivativeFunction

public static DataSet derivativeFunction(DataSet function)

derivativeFunction

public static DataSet derivativeFunction(DataSet function,
                                         double sign)

divideFunction

public static DataSet divideFunction(DataSet function1,
                                     DataSet function2)

divideFunction

public static DataSet divideFunction(DataSet function,
                                     double value)

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

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

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

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)

filterFunction

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

geometricMeanFilteredFunction

public static DataSet geometricMeanFilteredFunction(DataSet function,
                                                    double width)

getSubRange

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

iirLowPassFilterFunction

public static DataSet iirLowPassFilterFunction(DataSet function,
                                               double width)

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)

integrateFunction

public static DataSet integrateFunction(DataSet function)

integrateFunction

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

log10Function

public static DataSet log10Function(DataSet function)

log10Function

public static DataSet log10Function(DataSet function1,
                                    DataSet function2)

lowPassFilterFunction

public static DataSet lowPassFilterFunction(DataSet function,
                                            double width)

magnitudeSpectrum

public static DataSet magnitudeSpectrum(DataSet function)

magnitudeSpectrum

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

magnitudeSpectrumDecibel

public static DataSet magnitudeSpectrumDecibel(DataSet function)

mathFunction

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

mathFunction

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

maxFilteredFunction

public static DataSet maxFilteredFunction(DataSet function,
                                          double width)

medianFilteredFunction

public static DataSet medianFilteredFunction(DataSet function,
                                             double width)

minFilteredFunction

public static DataSet minFilteredFunction(DataSet function,
                                          double width)

multiplyFunction

public static DataSet multiplyFunction(DataSet function1,
                                       DataSet function2)

multiplyFunction

public static DataSet multiplyFunction(DataSet function,
                                       double value)

normalisedFunction

public static DataSet normalisedFunction(DataSet function)

normalisedFunction

public static DataSet normalisedFunction(DataSet function,
                                         double requiredIntegral)

normalisedMagnitudeSpectrumDecibel

public static DataSet normalisedMagnitudeSpectrumDecibel(DataSet function)

peakToPeakFilteredFunction

public static DataSet peakToPeakFilteredFunction(DataSet function,
                                                 double width)

rmsFilteredFunction

public static DataSet rmsFilteredFunction(DataSet function,
                                          double width)

setFunction

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

sqrFunction

public static DataSet sqrFunction(DataSet function)

sqrFunction

public static DataSet sqrFunction(DataSet function1,
                                  DataSet function2)

sqrtFunction

public static DataSet sqrtFunction(DataSet function)

sqrtFunction

public static DataSet sqrtFunction(DataSet function1,
                                   DataSet function2)

subtractFunction

public static DataSet subtractFunction(DataSet function1,
                                       DataSet function2)

subtractFunction

public static DataSet subtractFunction(DataSet function,
                                       double value)

values

public static final double[] values(int dimIndex,
                                    DataSet dataSet)

convenience short-hand notation for getting value array

Parameters:

dimIndex - the dimension index

dataSet - the source data set

Returns:

the given value vector