de.gsi.math

Class SimpleDataSetEstimators

java.lang.Object

de.gsi.math.SimpleDataSetEstimators

public final class SimpleDataSetEstimators
extends Object

computation of statistical estimates

Author:

rstein

Method Summary

Modifier and Type	Method and Description
static double	computeCentreOfMass(DataSet dataSet) Compute centre of mass over full DataSet
static double	computeCentreOfMass(DataSet dataSet, double min, double max) Computes the centre of mass in a given x range.
static double	computeCentreOfMass(DataSet dataSet, int minIndex, int maxIndex) Computes the centre of mass in a given index range.
static double	computeFWHM(double[] data, int length, int index) compute simple Full-Width-Half-Maximum (no inter-bin interpolation)
static double	computeInterpolatedFWHM(double[] data, int length, int index) compute interpolated Full-Width-Half-Maximum
static double	getDistance(DataSet dataSet, int indexMin, int indexMax, boolean isHorizontal)
static double[]	getDoubleArray(DataSet dataSet, int indexMin, int indexMax)
static double	getDutyCycle(DataSet dataSet, int indexMin, int indexMax)
static double	getEdgeDetect(DataSet dataSet, int indexMin, int indexMax) Gets the time from indexMin until the signal reaches 50% of its range.
static double	getFrequencyEstimate(DataSet dataSet, int indexMin, int indexMax)
static double	getFullWidthHalfMaximum(DataSet dataSet, int indexMin, int indexMax, boolean interpolate)
static double	getIntegral(DataSet dataSet, int indexMin, int indexMax)
static int	getLocationMaximum(DataSet dataSet, int indexMin, int indexMax)
static double	getLocationMaximumGaussInterpolated(DataSet dataSet, int indexMin, int indexMax)
static double	getMaximum(DataSet dataSet, int indexMin, int indexMax)
static double	getMean(DataSet dataSet, int indexMin, int indexMax)
static double	getMedian(DataSet dataSet, int indexMin, int indexMax)
static double	getMinimum(DataSet dataSet, int indexMin, int indexMax)
static double	getRange(DataSet dataSet, int indexMin, int indexMax) Returns the range of the y Data of the dataSet between the given indices.
static double	getRms(DataSet dataSet, int indexMin, int indexMax)
static double	getSimpleRiseTime(DataSet dataSet, int indexMin, int indexMax)
static double	getSimpleRiseTime(DataSet dataSet, int indexMin, int indexMax, double min, double max)
static double	getSimpleRiseTime1090(DataSet dataSet, int indexMin, int indexMax)
static double	getSimpleRiseTime2080(DataSet dataSet, int indexMin, int indexMax)
static double	getTransmission(DataSet dataSet, int indexMin, int indexMax, boolean isAbsoluteTransmission) Returns transmission as the absolute or relative ratio between the signal at the indexMin'th sample and the indexMax'th sample.
static double	getZeroCrossing(DataSet dataSet, double threshold)
static double	interpolateGaussian(double[] data, int length, int index) interpolation using a Gaussian interpolation
static double	linearInterpolate(double x0, double x1, double y0, double y1, double y)
protected static double	rootMeanSquare(double[] data, int length)
protected static double[]	sort(double[] a, int length, boolean down) Sorts the input a array

Methods inherited from class java.lang.Object

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

Method Detail

computeCentreOfMass

public static double computeCentreOfMass(DataSet dataSet)

Compute centre of mass over full DataSet

Parameters:

dataSet -

Returns:

centre of mass

computeCentreOfMass

public static double computeCentreOfMass(DataSet dataSet,
                                         double min,
                                         double max)

Computes the centre of mass in a given x range.

Parameters:

dataSet -

min -

max -

Returns:

centre of mass

computeCentreOfMass

public static double computeCentreOfMass(DataSet dataSet,
                                         int minIndex,
                                         int maxIndex)

Computes the centre of mass in a given index range.

Parameters:

dataSet -

minIndex -

maxIndex -

Returns:

centre of mass

computeFWHM

public static double computeFWHM(double[] data,
                                 int length,
                                 int index)

compute simple Full-Width-Half-Maximum (no inter-bin interpolation)

Parameters:

data - data array

length - of data array

index - 0< index < data.length

Returns:

FWHM estimate [bins]

computeInterpolatedFWHM

public static double computeInterpolatedFWHM(double[] data,
                                             int length,
                                             int index)

compute interpolated Full-Width-Half-Maximum

Parameters:

data - data array

length - of data array

index - 0< index < data.length

Returns:

FWHM estimate [bins]

getDistance

public static double getDistance(DataSet dataSet,
                                 int indexMin,
                                 int indexMax,
                                 boolean isHorizontal)

getDoubleArray

public static double[] getDoubleArray(DataSet dataSet,
                                      int indexMin,
                                      int indexMax)

getDutyCycle

public static double getDutyCycle(DataSet dataSet,
                                  int indexMin,
                                  int indexMax)

getEdgeDetect

public static double getEdgeDetect(DataSet dataSet,
                                   int indexMin,
                                   int indexMax)

Gets the time from indexMin until the signal reaches 50% of its range. If y(indexMax) > y(indexMin) rising edge is detected, otherwise falling edge. If the range is not finite or zero, returns NaN.

Parameters:

dataSet - DataSet

indexMin - first index to look at (inclusive)

indexMax - last index to look at (exclusive)

Returns:

time from indexMin to 50% of data range reached

getFrequencyEstimate

public static double getFrequencyEstimate(DataSet dataSet,
                                          int indexMin,
                                          int indexMax)

getFullWidthHalfMaximum

public static double getFullWidthHalfMaximum(DataSet dataSet,
                                             int indexMin,
                                             int indexMax,
                                             boolean interpolate)

getIntegral

public static double getIntegral(DataSet dataSet,
                                 int indexMin,
                                 int indexMax)

Parameters:

dataSet -

indexMin - the starting index

indexMax - the end index (switching indices reverses sign of result)

Returns:

the Integral of the DataSet according to the trapezoidal rule

getLocationMaximum

public static int getLocationMaximum(DataSet dataSet,
                                     int indexMin,
                                     int indexMax)

getLocationMaximumGaussInterpolated

public static double getLocationMaximumGaussInterpolated(DataSet dataSet,
                                                         int indexMin,
                                                         int indexMax)

getMaximum

public static double getMaximum(DataSet dataSet,
                                int indexMin,
                                int indexMax)

getMean

public static double getMean(DataSet dataSet,
                             int indexMin,
                             int indexMax)

getMedian

public static double getMedian(DataSet dataSet,
                               int indexMin,
                               int indexMax)

getMinimum

public static double getMinimum(DataSet dataSet,
                                int indexMin,
                                int indexMax)

getRange

public static double getRange(DataSet dataSet,
                              int indexMin,
                              int indexMax)

Returns the range of the y Data of the dataSet between the given indices. This equals the maximum value in the range minus the minimum value.

Parameters:

dataSet -

indexMin -

indexMax -

Returns:

the range of yData between the given indices

getRms

public static double getRms(DataSet dataSet,
                            int indexMin,
                            int indexMax)

getSimpleRiseTime

public static double getSimpleRiseTime(DataSet dataSet,
                                       int indexMin,
                                       int indexMax)

Parameters:

dataSet -

indexMin -

indexMax -

Returns:

the 20% to 80% rise time of the signal

getSimpleRiseTime

public static double getSimpleRiseTime(DataSet dataSet,
                                       int indexMin,
                                       int indexMax,
                                       double min,
                                       double max)

getSimpleRiseTime1090

public static double getSimpleRiseTime1090(DataSet dataSet,
                                           int indexMin,
                                           int indexMax)

getSimpleRiseTime2080

public static double getSimpleRiseTime2080(DataSet dataSet,
                                           int indexMin,
                                           int indexMax)

getTransmission

public static double getTransmission(DataSet dataSet,
                                     int indexMin,
                                     int indexMax,
                                     boolean isAbsoluteTransmission)

Returns transmission as the absolute or relative ratio between the signal at the indexMin'th sample and the indexMax'th sample. The result is returned in percent.

Parameters:

dataSet - A dataSet

indexMin - The index to look at for the initial quantitiy

indexMax - The index to look at for the final quantitiy

isAbsoluteTransmission - true for absolute transmission, false for relative transmission

Returns:

The transmission in percent

getZeroCrossing

public static double getZeroCrossing(DataSet dataSet,
                                     double threshold)

interpolateGaussian

public static double interpolateGaussian(double[] data,
                                         int length,
                                         int index)

interpolation using a Gaussian interpolation

Parameters:

data - data array

length - length of data arrays

index - 0< index < data.length

Returns:

location of the to be interpolated peak [bins]

linearInterpolate

public static double linearInterpolate(double x0,
                                       double x1,
                                       double y0,
                                       double y1,
                                       double y)

rootMeanSquare

protected static double rootMeanSquare(double[] data,
                                       int length)

Parameters:

data - the input vector

length - number of elements (less than data.length) to be used

Returns:

un-biased r.m.s. of vector elements

sort

protected static double[] sort(double[] a,
                               int length,
                               boolean down)

Sorts the input a array

Parameters:

a - the input array

length - number of elements (less than data.length) to be used

down - true: ascending , false: descending order

Returns:

the sorted array