org.nd4j.linalg.fft

Class BaseFFTInstance

java.lang.Object

org.nd4j.linalg.fft.BaseFFTInstance

All Implemented Interfaces:

FFTInstance

Direct Known Subclasses:

DefaultFFTInstance

public abstract class BaseFFTInstance
extends Object
implements FFTInstance

Abstract FFT Instance mostly handling basic things that shouldn't change such as method overloading.

Author:

Adam Gibson

Constructor Summary

Constructors

Constructor and Description
BaseFFTInstance()

Method Summary

Modifier and Type	Method and Description
IComplexNDArray	fft(IComplexNDArray inputC) 1d discrete fourier transform, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	fft(IComplexNDArray inputC, int numElements) 1d discrete fourier transform, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	fft(INDArray input) 1d discrete fourier transform, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	fft(INDArray transform, int numElements) FFT along a particular dimension
IComplexNDArray	fftn(IComplexNDArray transform) FFT on the whole array (n is equal the first dimension shape)
IComplexNDArray	fftn(IComplexNDArray transform, int dimension, int numElements) Performs FFT along the first non singleton dimension of transform.
IComplexNDArray	fftn(INDArray transform) FFT on the whole array (n is equal the first dimension shape)
IComplexNDArray	fftn(INDArray transform, int dimension, int numElements) Computes the fft along the first non singleton dimension of transform when it is a matrix
IComplexNDArray	ifftn(IComplexNDArray transform)
IComplexNDArray	ifftn(IComplexNDArray transform, int dimension)
IComplexNDArray	ifftn(IComplexNDArray transform, int dimension, int numElements) ND IFFT
IComplexNDArray	ifftn(INDArray transform)
IComplexNDArray	ifftn(INDArray transform, int dimension, int numElements) ND IFFT, computes along the first on singleton dimension of transform
IComplexNDArray	irfft(IComplexNDArray arr)
IComplexNDArray	irfft(IComplexNDArray arr, int dimension)
IComplexNDArray	irfftn(IComplexNDArray arr)
IComplexNDArray	rawfftn(IComplexNDArray transform, int[] shape, int[] axes)
IComplexNDArray	rawifft(IComplexNDArray transform, int dimension) Underlying ifft impl
IComplexNDArray	rawifftn(IComplexNDArray transform, int[] shape, int[] axes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nd4j.linalg.fft.FFTInstance

fft, fft, ifft, ifft, ifft, ifft, rawfft, rawifft

Constructor Detail

BaseFFTInstance

public BaseFFTInstance()

Method Detail

fft

public IComplexNDArray fft(INDArray transform,
                           int numElements)

FFT along a particular dimension

Specified by:

fft in interface FFTInstance

Parameters:

transform - the ndarray to transform

numElements - the desired number of elements in each fft

Returns:

the ffted output

fft

public IComplexNDArray fft(IComplexNDArray inputC)

1d discrete fourier transform, note that this will throw an exception if the passed in input isn't a vector. See matlab's fft2 for more information

Specified by:

fft in interface FFTInstance

Parameters:

inputC - the input to transform

Returns:

the the discrete fourier transform of the passed in input

fft

public IComplexNDArray fft(INDArray input)

1d discrete fourier transform, note that this will throw an exception if the passed in input isn't a vector. See matlab's fft2 for more information

Specified by:

fft in interface FFTInstance

Parameters:

input - the input to transform

Returns:

the the discrete fourier transform of the passed in input

fft

public IComplexNDArray fft(IComplexNDArray inputC,
                           int numElements)

1d discrete fourier transform, note that this will throw an exception if the passed in input isn't a vector. See matlab's fft2 for more information

Specified by:

fft in interface FFTInstance

Parameters:

inputC - the input to transform

Returns:

the the discrete fourier transform of the passed in input

ifftn

public IComplexNDArray ifftn(INDArray transform,
                             int dimension,
                             int numElements)

ND IFFT, computes along the first on singleton dimension of transform

Specified by:

ifftn in interface FFTInstance

Parameters:

transform - the ndarray to transform

dimension - the dimension to iterate along

numElements - the desired number of elements in each fft

Returns:

the reverse ifft of the passed in array

irfftn

public IComplexNDArray irfftn(IComplexNDArray arr)

Specified by:

irfftn in interface FFTInstance

irfft

public IComplexNDArray irfft(IComplexNDArray arr,
                             int dimension)

Specified by:

irfft in interface FFTInstance

irfft

public IComplexNDArray irfft(IComplexNDArray arr)

Specified by:

irfft in interface FFTInstance

ifftn

public IComplexNDArray ifftn(IComplexNDArray transform,
                             int dimension,
                             int numElements)

ND IFFT

Specified by:

ifftn in interface FFTInstance

Parameters:

transform - the ndarray to transform

dimension - the dimension to iterate along

numElements - the desired number of elements in each fft

Returns:

the transformed array

fftn

public IComplexNDArray fftn(IComplexNDArray transform,
                            int dimension,
                            int numElements)

Performs FFT along the first non singleton dimension of transform. This means

Specified by:

fftn in interface FFTInstance

Parameters:

transform - the ndarray to transform

dimension - the dimension to iterate along

numElements - the desired number of elements in each fft along each dimension from each slice (note: each slice)

Returns:

the transformed array

fftn

public IComplexNDArray fftn(INDArray transform,
                            int dimension,
                            int numElements)

Computes the fft along the first non singleton dimension of transform when it is a matrix

Specified by:

fftn in interface FFTInstance

Parameters:

transform - the ndarray to transform

dimension - the dimension to do fft along

numElements - the desired number of elements in each fft

Returns:

the fft of the specified ndarray

fftn

public IComplexNDArray fftn(INDArray transform)

FFT on the whole array (n is equal the first dimension shape)

Specified by:

fftn in interface FFTInstance

Parameters:

transform - the matrix to transform

Returns:

the ffted array

fftn

public IComplexNDArray fftn(IComplexNDArray transform)

FFT on the whole array (n is equal the first dimension shape)

Specified by:

fftn in interface FFTInstance

Parameters:

transform - the matrix to transform

Returns:

the ffted array

ifftn

public IComplexNDArray ifftn(IComplexNDArray transform,
                             int dimension)

Specified by:

ifftn in interface FFTInstance

ifftn

public IComplexNDArray ifftn(IComplexNDArray transform)

Specified by:

ifftn in interface FFTInstance

ifftn

public IComplexNDArray ifftn(INDArray transform)

Specified by:

ifftn in interface FFTInstance

rawifftn

public IComplexNDArray rawifftn(IComplexNDArray transform,
                                int[] shape,
                                int[] axes)

Specified by:

rawifftn in interface FFTInstance

rawfftn

public IComplexNDArray rawfftn(IComplexNDArray transform,
                               int[] shape,
                               int[] axes)

Specified by:

rawfftn in interface FFTInstance

rawifft

public IComplexNDArray rawifft(IComplexNDArray transform,
                               int dimension)

Description copied from interface: FFTInstance

Underlying ifft impl

Specified by:

rawifft in interface FFTInstance

Parameters:

transform - the ndarray to transform

dimension - the dimension to do fft along

Returns: