org.nd4j.linalg.fft

Interface FFTInstance

All Known Implementing Classes:

BaseFFTInstance, DefaultFFTInstance

public interface FFTInstance

Base line fft methods

Author:

Adam Gibson

Method Summary

Modifier and Type	Method and Description
IComplexNDArray	fft(IComplexNDArray inputC) 1d discrete fourier op, 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 op, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	fft(IComplexNDArray inputC, int numElements, int dimension) 1d discrete fourier op, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	fft(INDArray input) 1d discrete fourier op, 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	fft(INDArray transform, int numElements, int dimension) 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 op.
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 op when it is a matrix
IComplexNDArray	ifft(IComplexNDArray inputC) 1d discrete fourier op, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	ifft(IComplexNDArray inputC, int numElements, int dimension) 1d discrete fourier op, note that this will throw an exception if the passed in input isn't a vector.
IComplexNDArray	ifft(INDArray transform, int numElements) FFT along a particular dimension
IComplexNDArray	ifft(INDArray transform, int numElements, int dimension) IFFT along a particular dimension
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 op
IComplexNDArray	irfft(IComplexNDArray arr)
IComplexNDArray	irfft(IComplexNDArray arr, int dimension)
IComplexNDArray	irfftn(IComplexNDArray arr)
IComplexNDArray	rawfft(IComplexNDArray transform, int n, int dimension) Underlying fft algorithm
IComplexNDArray	rawfftn(IComplexNDArray transform, int[] shape, int[] axes)
IComplexNDArray	rawifft(IComplexNDArray transform, int dimension) Underlying ifft impl
IComplexNDArray	rawifft(IComplexNDArray transform, int n, int dimension) Underlying ifft impl
IComplexNDArray	rawifftn(IComplexNDArray transform, int[] shape, int[] axes)

Method Detail

fft

IComplexNDArray fft(INDArray transform,
                    int numElements)

FFT along a particular dimension

Parameters:

transform - the ndarray to op

numElements - the desired number of elements in each fft

Returns:

the ffted output

fft

IComplexNDArray fft(IComplexNDArray inputC)

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

Parameters:

inputC - the input to op

Returns:

the the discrete fourier op of the passed in input

fft

IComplexNDArray fft(INDArray input)

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

Parameters:

input - the input to op

Returns:

the the discrete fourier op of the passed in input

fft

IComplexNDArray fft(INDArray transform,
                    int numElements,
                    int dimension)

FFT along a particular dimension

Parameters:

transform - the ndarray to op

numElements - the desired number of elements in each fft

Returns:

the ffted output

fft

IComplexNDArray fft(IComplexNDArray inputC,
                    int numElements)

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

Parameters:

inputC - the input to op

Returns:

the the discrete fourier op of the passed in input

fft

IComplexNDArray fft(IComplexNDArray inputC,
                    int numElements,
                    int dimension)

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

Parameters:

inputC - the input to op

Returns:

the the discrete fourier op of the passed in input

ifft

IComplexNDArray ifft(INDArray transform,
                     int numElements,
                     int dimension)

IFFT along a particular dimension

Parameters:

transform - the ndarray to op

numElements - the desired number of elements in each fft

dimension - the dimension to do fft along

Returns:

the iffted output

ifft

IComplexNDArray ifft(IComplexNDArray inputC)

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

Parameters:

inputC - the input to op

Returns:

the the discrete fourier op of the passed in input

ifft

IComplexNDArray ifft(INDArray transform,
                     int numElements)

FFT along a particular dimension

Parameters:

transform - the ndarray to op

numElements - the desired number of elements in each fft

Returns:

the ffted output

ifft

IComplexNDArray ifft(IComplexNDArray inputC,
                     int numElements,
                     int dimension)

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

Parameters:

inputC - the input to op

Returns:

the the discrete fourier op of the passed in input

ifftn

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

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

Parameters:

transform - the ndarray to op

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

IComplexNDArray irfftn(IComplexNDArray arr)

irfft

IComplexNDArray irfft(IComplexNDArray arr,
                      int dimension)

irfft

IComplexNDArray irfft(IComplexNDArray arr)

ifftn

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

ND IFFT

Parameters:

transform - the ndarray to op

dimension - the dimension to iterate along

numElements - the desired number of elements in each fft

Returns:

the transformed array

fftn

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

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

Parameters:

transform - the ndarray to op

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

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

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

Parameters:

transform - the ndarray to op

dimension - the dimension to do fft along

numElements - the desired number of elements in each fft

Returns:

the fft of the specified ndarray

fftn

IComplexNDArray fftn(INDArray transform)

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

Parameters:

transform - the matrix to op

Returns:

the ffted array

fftn

IComplexNDArray fftn(IComplexNDArray transform)

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

Parameters:

transform - the matrix to op

Returns:

the ffted array

ifftn

IComplexNDArray ifftn(IComplexNDArray transform,
                      int dimension)

ifftn

IComplexNDArray ifftn(IComplexNDArray transform)

ifftn

IComplexNDArray ifftn(INDArray transform)

rawifftn

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

rawfftn

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

rawfft

IComplexNDArray rawfft(IComplexNDArray transform,
                       int n,
                       int dimension)

Underlying fft algorithm

Parameters:

transform - the ndarray to op

n - the desired number of elements

dimension - the dimension to do fft along

Returns:

the transformed ndarray

rawifft

IComplexNDArray rawifft(IComplexNDArray transform,
                        int n,
                        int dimension)

Underlying ifft impl

Parameters:

transform - the ndarray to op

n - the desired number of elements

dimension - the dimension to do fft along

Returns:

rawifft

IComplexNDArray rawifft(IComplexNDArray transform,
                        int dimension)

Underlying ifft impl

Parameters:

transform - the ndarray to op

n - the desired number of elements

dimension - the dimension to do fft along

Returns: