org.openimaj.audio.filters

Enum EQFilter.EQType

java.lang.Object

java.lang.Enum<EQFilter.EQType>

org.openimaj.audio.filters.EQFilter.EQType

All Implemented Interfaces:

Serializable, Comparable<EQFilter.EQType>

Enclosing class:

EQFilter

public static enum EQFilter.EQType
extends Enum<EQFilter.EQType>

An enumerator for various audio filters.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

19 Jul 2012

Enum Constant Summary

Enum Constants

Enum Constant and Description
HPF High pass filter
LPF Low pass filter

Method Summary

Modifier and Type	Method and Description
abstract EQFilter.EQVars	getCoefficients(double frequency, double sampleRate) Initialise the filter
static EQFilter.EQType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EQFilter.EQType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LPF

public static final EQFilter.EQType LPF

Low pass filter

HPF

public static final EQFilter.EQType HPF

High pass filter

Method Detail

values

public static EQFilter.EQType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EQFilter.EQType c : EQFilter.EQType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EQFilter.EQType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCoefficients

public abstract EQFilter.EQVars getCoefficients(double frequency,
                                                double sampleRate)

Initialise the filter

Parameters:

frequency - The frequency of the filter

sampleRate - The sample rate of the samples

Returns:

The biquad coefficients for this filter