WindowFunction (Jipes 0.9.17 API)

java.lang.Object
- com.tagtraum.jipes.math.WindowFunction

All Implemented Interfaces:

MapFunction<float[]>

Direct Known Subclasses:

WindowFunction.Hamming, WindowFunction.Hann, WindowFunction.InverseWindowFunction, WindowFunction.Triangle, WindowFunction.Welch
```
public abstract class WindowFunction
extends Object
implements MapFunction<float[]>
```
Classic window functions like triangle, Hamming and Hann.

Note that some implementations may re-use their output buffer!

Author:

Hendrik Schreiber

See Also:

Window functions on Wikipedia

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WindowFunction.Hamming` Hamming window function.
`static class`	`WindowFunction.Hann` Hann window function.
`static class`	`WindowFunction.InverseWindowFunction` Helper class to invert (1/x) window functions.
`static class`	`WindowFunction.Triangle` Triangle window function.
`static class`	`WindowFunction.Welch` Welch window function.

Field Summary

Fields
Modifier and Type	Field and Description
`static MapFunction<float[]>`	`HAMMING` Function that always uses a Hamming window that is as long as the provided data.
`static MapFunction<float[]>`	`HANN` Function that always uses a Hann window that is as long as the provided data.
`static MapFunction<float[]>`	`TRIANGLE` Triangle function that always uses a triangle that is as long as the provided data.
`static MapFunction<float[]>`	`WELCH` Function that always uses a Welch window that is as long as the provided data.

Constructor Summary

Constructors
Constructor and Description

WindowFunction(float[] coefficients)

Constructors
Constructor and Description
`WindowFunction(float[] coefficients)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`float[]`	`getCoefficients()`
`int`	`getLength()`
`int`	`hashCode()`
`WindowFunction`	`invert()` Inverts this window function.
`float[]`	`map(float[] data)` Maps an object (usually an array, an `RealAudioBuffer` or a `List`) to another one of the same size.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TRIANGLE
```
public static MapFunction<float[]> TRIANGLE
```
    Triangle function that always uses a triangle that is as long as the provided data.
  - HANN
```
public static MapFunction<float[]> HANN
```
    Function that always uses a Hann window that is as long as the provided data.
  - HAMMING
```
public static MapFunction<float[]> HAMMING
```
    Function that always uses a Hamming window that is as long as the provided data.
  - WELCH
```
public static MapFunction<float[]> WELCH
```
    Function that always uses a Welch window that is as long as the provided data.
- Constructor Detail
  - WindowFunction
```
public WindowFunction(float[] coefficients)
```
- Method Detail
  - getCoefficients
```
public float[] getCoefficients()
```
  - getLength
```
public int getLength()
```
  - map
```
public float[] map(float[] data)
```
    Description copied from interface: MapFunction
    
    Maps an object (usually an array, an RealAudioBuffer or a List) to another one of the same size.
    
    Specified by:
    
    map in interface MapFunction<float[]>
    
    Parameters:
    
    data - data
    
    Returns:
    
    mapped data
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - invert
```
public WindowFunction invert()
```
    Inverts this window function. I.e. each coefficient is replaced with 1/x.
    
    Returns:
    
    inverse window function

Class WindowFunction

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRIANGLE

HANN

HAMMING

WELCH

Constructor Detail

WindowFunction

Method Detail

getCoefficients

getLength

map

equals

hashCode

invert