PamUtils

Class FrequencyFormat

java.lang.Object

PamUtils.FrequencyFormat

public class FrequencyFormat
extends java.lang.Object

A set of static functions for formatting frequency values in a common way, i.e. if it's relatively low, do it in Hz, it it's high, do it in kHz;

Author:

Doug Gillespie

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	formatFrequency(double frequency, boolean includeUnits) Format a frequency value.
static java.lang.String	formatFrequencyRange(double[] frequency, boolean includeUnits) Format a frequency range.
static FrequencyFormat	getFrequencyFormat(double frequency) Get everything you need to format a frequency string in a standard way.
java.lang.String	getNumberFormat()
double	getScale()
java.lang.String	getUnitText()

Methods inherited from class java.lang.Object

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

Method Detail

formatFrequency

public static java.lang.String formatFrequency(double frequency,
                               boolean includeUnits)

Format a frequency value.

Parameters:

frequency - frequency in Hz

includeUnits - flag to include units (Hz or kHz)

Returns:

formatted string

formatFrequencyRange

public static java.lang.String formatFrequencyRange(double[] frequency,
                                    boolean includeUnits)

Format a frequency range.

Parameters:

frequency - array of frequency values in Hz.

includeUnits - flag to include units (Hz or kHz)

Returns:

formatted string

getFrequencyFormat

public static FrequencyFormat getFrequencyFormat(double frequency)

Get everything you need to format a frequency string in a standard way.

Parameters:

frequency -

Returns:

Frequency format object containing a format string for the number, a unit (Hz or kHz) and a scale factor to divide the raw Hz value down by (1 or 1000).

getNumberFormat

public java.lang.String getNumberFormat()

Returns:

the numberFormat

getUnitText

public java.lang.String getUnitText()

Returns:

the unitText

getScale

public double getScale()

Returns:

the scale