jfftw
Interface Plan

All Known Implementing Classes:
Plan, Plan, Plan, Plan

public interface Plan

Common interface for the Plan classes. See the documentation of the individual classes for documentation of their workings and arguments.

Note: The constructors of the implementing classes synchronize on this interface so that no two ..._create_plan functions are called at the same time.

See Also:
Plan, Plan, Plan, Plan

Field Summary
static int BACKWARD
          Prepare a plan for backward transforms.
static int COMPLEX_TO_REAL
          Prepare a plan for half-complex to real transforms.
static int ESTIMATE
          Flag requesting plan choice based on estimations.
static int FORWARD
          Prepare a plan for forward transforms.
static int IN_PLACE
          Flag requesting plan for in-place transforms.
static int MEASURE
          Flag requesting plan choice based on measurements.
static int READONLY
          Flag requesting a read-only plan.
static int REAL_TO_COMPLEX
          Prepare a plan for real to half-complex transforms.
static int USE_WISDOM
          Flag requesting storage of gathered data.
 
Method Summary
 double[] transform(double[] in)
          Simple transform routine.
 void transform(int howmany, double[] in, int istride, int idist, double[] out, int ostride, int odist)
          Multiple transform routine.
 

Field Detail

ESTIMATE

public static final int ESTIMATE
Flag requesting plan choice based on estimations. This is the quick way.

(The constant must have the same value as FFTW_ESTIMATE in fftw.h.)

See Also:
Constant Field Values

MEASURE

public static final int MEASURE
Flag requesting plan choice based on measurements. Using this option FFTW actually tries all possible algorithms and chooses the fastest. This way all speed factors are taken into account, but measurements take a long time.

(The constant must have the same value as FFTW_MEASURE in fftw.h.)

See Also:
Constant Field Values

IN_PLACE

public static final int IN_PLACE
Flag requesting plan for in-place transforms. transform(double[]) returns its argument when this flag is provided.

(The constant must have the same value as FFTW_IN_PLACE in fftw.h.)

See Also:
Constant Field Values

USE_WISDOM

public static final int USE_WISDOM
Flag requesting storage of gathered data.

(The constant must have the same value as FFTW_USE_WISDOM in fftw.h.)

See Also:
Wisdom, Constant Field Values

READONLY

public static final int READONLY
Flag requesting a read-only plan. If this flag is given the plan can be used to do multiple transforms at the same time. If it is not given and the function is called from two threads at the same time, one of them will be blocked until the other transform completes.

(The constant must have the same value as FFTW_THREADSAFE in fftw.h.)

See Also:
Constant Field Values

REAL_TO_COMPLEX

public static final int REAL_TO_COMPLEX
Prepare a plan for real to half-complex transforms.

(The constant must have the same value as FFTW_REAL_TO_COMPLEX in rfftw.h.)

See Also:
Constant Field Values

COMPLEX_TO_REAL

public static final int COMPLEX_TO_REAL
Prepare a plan for half-complex to real transforms.

(Input values for compex-to-real transforms are overwritten with scratch values. Not for real-to-complex transforms.)

(The constant must have the same value as FFTW_COMPLEX_TO_REAL in rfftw.h.)

See Also:
Constant Field Values

FORWARD

public static final int FORWARD
Prepare a plan for forward transforms. (See the FFTW documentation to learn what 'forward' means.)

(The constant must have the same value as FFTW_FORWARD in fftw.h.)

See Also:
Constant Field Values

BACKWARD

public static final int BACKWARD
Prepare a plan for backward transforms. (See the FFTW documentation to learn what 'backward' means.)

(The constant must have the same value as FFTW_BACKWARD in fftw.h.)

See Also:
Constant Field Values
Method Detail

transform

public double[] transform(double[] in)
Simple transform routine.


transform

public void transform(int howmany,
                      double[] in,
                      int istride,
                      int idist,
                      double[] out,
                      int ostride,
                      int odist)
Multiple transform routine.