org.hermit.dsp
Enum Window.Function

java.lang.Object
  extended by java.lang.Enum<Window.Function>
      extended by org.hermit.dsp.Window.Function
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Window.Function>
Enclosing class:
Window

public static enum Window.Function
extends java.lang.Enum<Window.Function>

Definitions of the available window functions.


Enum Constant Summary
BLACKMAN_HARRIS
          The Blackman-Harris window function.
GAUSS
          The Gauss window function.
RECTANGULAR
          A simple rectangular window function.
WEEDON_GAUSS
          The Weedon-Gauss window function.
 
Method Summary
static Window.Function valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Window.Function[] 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

RECTANGULAR

public static final Window.Function RECTANGULAR
A simple rectangular window function. This is equivalent to doing no windowing.


BLACKMAN_HARRIS

public static final Window.Function BLACKMAN_HARRIS
The Blackman-Harris window function.


GAUSS

public static final Window.Function GAUSS
The Gauss window function.


WEEDON_GAUSS

public static final Window.Function WEEDON_GAUSS
The Weedon-Gauss window function.

Method Detail

values

public static Window.Function[] 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 (Window.Function c : Window.Function.values())
    System.out.println(c);

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

valueOf

public static Window.Function valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null