metdetection.utils

Class MathUtils

java.lang.Object

metdetection.utils.MathUtils

public class MathUtils
extends java.lang.Object

A static class of some utility functions that may need to used from multiple places.

Author:

Andrew McLeod

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MathUtils() A private constructor since this class should never be instantiated.

Method Summary

Methods

Modifier and Type	Method and Description
static double	gaussianWindow(double mean1, double mean2, double std) Evaluate a Gaussian window function with the given mean range and standard deviation.
static int	getGCF(int a, int b) Get the greatest common factor of two integers.
static int	getMaxIndex(double[] array) Get the index of the first occurrence of the maximum value in the given array.

Methods inherited from class java.lang.Object

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

Constructor Detail

MathUtils

private MathUtils()

A private constructor since this class should never be instantiated.

Method Detail

gaussianWindow

public static double gaussianWindow(double mean1,
                    double mean2,
                    double std)

Evaluate a Gaussian window function with the given mean range and standard deviation. The formula is: G(m1, m2, s) = e ^ [(-1 / 2) * ([m2 - m1] / s) ^ 2]

Parameters:

mean1 - The low end of the mean range.

mean2 - The high end of the mean range.

std - The standard deviation.

Returns:

The value of the Gaussian window function.

getMaxIndex

public static int getMaxIndex(double[] array)

Get the index of the first occurrence of the maximum value in the given array.

Parameters:

array - The array whose max we will find.

Returns:

The index of the first occurrence of the maximum value of the given array. Or, -1 if the maximum vlaue is Double.NEGATIVE_INFINITY or the array has length 0.

getGCF

public static int getGCF(int a,
         int b)

Get the greatest common factor of two integers.

Parameters:

a - The first integer.

b - The second integer.

Returns:

Their greatest common factor.