jfftw
Class FFTWRealToComplexEngine

java.lang.Object
  jfftw.FFTW
      jfftw.FFTWEngine
          jfftw.FFTWRealToComplexEngine

public class FFTWRealToComplexEngine
extends FFTWEngine

Class to for a (forward), Real to hermition complex FFT engine with a real input buffer and hermition complex output buffer. Note since there are in gerenal of diffent size, then they callon be the same array.

Field Summary

protected FFTWReal

fft

Fields inherited from class jfftw.FFTWEngine

depth, height, inputBuffer, inputWidth, outputBuffer, outputWidth, plan

Fields inherited from class jfftw.FFTW

BACKWARD, errorStream, ESTIMATE, EXHAUSTIVE, FORWARD, FOURIER, loaded, PATIENT, planFlag, REAL, throwLoadException, version

Constructor Summary

FFTWRealToComplexEngine(int w)
Form a one-dimensional RealToComplex Engine whithe input and and output baffer are aoutomatically created.

FFTWRealToComplexEngine(int w, double[] in, double[] out)
Form a one-dimensional RealToComplex Engine specified input and output buffers.

FFTWRealToComplexEngine(int w, int h)
Form a two-dimensional RealToComplex Engine whithe input and and output baffer are aoutomatically created.

FFTWRealToComplexEngine(int w, int h, double[] in, double[] out)
Form a two-dimensional RealToComplex Engine specified input and output buffers.

FFTWRealToComplexEngine(int w, int h, int d)
Form a three-dimensional RealToComplex Engine whithe input and and output baffer are aoutomatically created.

FFTWRealToComplexEngine(int w, int h, int d, double[] in, double[] out)
Form a three-dimensional RealToComplex Engine specified input and output buffers.

Method Summary

Complex	getInputComplex(int i) Method to get an element of the Real input buffer as a Complex
double	getInputReal(int i) Method to get an input element as a real
Complex	getOutputComplex(int i) Method to get an element of the Complex output buffer as a Complex
void	makePlan() Method to make the current plan using the current defaults
void	setInputComplex(int i, double a, double b) Method to set an input element with a Complex, but since the input is real only a warning message is generated
void	setInputReal(int i, double a) Method to set the an input buffer element with a double
void	setOutputComplex(int i, double a, double b) Methed to set the an element in the outpout Complex array with two doubles.

Methods inherited from class jfftw.FFTWEngine

deletePlan, getDepth, getHeight, getInputBuffer, getInputComplex, getInputComplex, getInputReal, getInputReal, getInputWidth, getOutputBuffer, getOutputComplex, getOutputComplex, getOutputWidth, setDimensions, setInputBuffer, setInputBuffer, setInputComplex, setInputComplex, setInputComplex, setInputReal, setInputReal, setOutputBuffer, setOutputBuffer, setOutputComplex, setOutputComplex, setOutputComplex, toString, update

Methods inherited from class jfftw.FFTW

addPlanFlag, clearWisdom, exportWisdom, getPlanFlag, getVersion, getWisdom, loadWisdom, loadWisdom, loadWisdomFromString, readWisdom, readWisdom, setErrorStream, setPlanFlag, setSystemWisdom, writeWisdom

Methods inherited from class java.lang.Object

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

Field Detail

fft

protected FFTWReal fft

Constructor Detail

FFTWRealToComplexEngine

public FFTWRealToComplexEngine(int w,
                               int h,
                               int d,
                               double[] in,
                               double[] out)

Form a three-dimensional RealToComplex Engine specified input and output buffers.

Parameters:

w - the width

h - the height

d - the depth

in - the input buffer

out - the output buffer

Throws:

NullPointerException - if array null

IllegalArgumentException - if array lengths do not match size.

FFTWRealToComplexEngine

public FFTWRealToComplexEngine(int w,
                               int h,
                               double[] in,
                               double[] out)

Form a two-dimensional RealToComplex Engine specified input and output buffers.

Parameters:

w - the width

h - the height

in - the input buffer

out - the output buffer

Throws:

NullPointerException - if array null

IllegalArgumentException - if array lengths do not match size.

FFTWRealToComplexEngine

public FFTWRealToComplexEngine(int w,
                               double[] in,
                               double[] out)

Form a one-dimensional RealToComplex Engine specified input and output buffers.

Parameters:

w - the width

in - the input buffer

out - the output buffer

Throws:

NullPointerException - if array null

IllegalArgumentException - if array lengths do not match size.

FFTWRealToComplexEngine

public FFTWRealToComplexEngine(int w,
                               int h,
                               int d)

Form a three-dimensional RealToComplex Engine whithe input and and output baffer are aoutomatically created. Not they will always be different arrays since in general they will NOT be the same size.

Parameters:

w - the width

h - the height

d - the depth

FFTWRealToComplexEngine

public FFTWRealToComplexEngine(int w,
                               int h)

Form a two-dimensional RealToComplex Engine whithe input and and output baffer are aoutomatically created. Not they will always be different arrays since in general they will NOT be the same size.

Parameters:

w - the width

h - the height

FFTWRealToComplexEngine

public FFTWRealToComplexEngine(int w)

Form a one-dimensional RealToComplex Engine whithe input and and output baffer are aoutomatically created. Not they will always be different arrays since in general they will NOT be the same size.

Parameters:

w - the width

Method Detail

setInputReal

public void setInputReal(int i,
                         double a)

Method to set the an input buffer element with a double

Specified by:

setInputReal in class FFTWEngine

Parameters:

i - the element index

a - the value

setInputComplex

public void setInputComplex(int i,
                            double a,
                            double b)

Method to set an input element with a Complex, but since the input is real only a warning message is generated

Specified by:

setInputComplex in class FFTWEngine

Parameters:

i - the element index

a - the real value

b - the imaginary value

getInputReal

public double getInputReal(int i)

Method to get an input element as a real

Specified by:

getInputReal in class FFTWEngine

Parameters:

i - the element index

Returns:

double the element value

getInputComplex

public Complex getInputComplex(int i)

Method to get an element of the Real input buffer as a Complex

Specified by:

getInputComplex in class FFTWEngine

Parameters:

i - the element index

Returns:

Complex specifed input element.

setOutputComplex

public void setOutputComplex(int i,
                             double a,
                             double b)

Methed to set the an element in the outpout Complex array with two doubles.

Specified by:

setOutputComplex in class FFTWEngine

Parameters:

i - the element index

a - the real value

b - the imaginary value

getOutputComplex

public Complex getOutputComplex(int i)

Method to get an element of the Complex output buffer as a Complex

Specified by:

getOutputComplex in class FFTWEngine

Parameters:

i - the element index

Returns:

Complexl the elemtn value

makePlan

public void makePlan()

Description copied from class: FFTWEngine

Method to make the current plan using the current defaults

Specified by:

makePlan in class FFTWEngine