Package ffx.numerics.fft

Enum Class DataLayout3D

java.lang.Object
java.lang.Enum<DataLayout3D>
ffx.numerics.fft.DataLayout3D
All Implemented Interfaces:
Serializable, Comparable<DataLayout3D>, Constable
public enum DataLayout3D extends Enum<DataLayout3D>
The Complex FFT supports interleaved or blocked data.

For interleaved data, the complex data is stored in the following way: 

 Re(d[i]) = data[offset + stride*i]
 Im(d[i]) = data[offset + stride*i + 1]

For blocked data, the complex data is stored in the following way: 

 Re(d[i]) = data[offset + stride*i]
 Im(d[i]) = data[offset + stride*i + im]
 where the offset to the imaginary part is specified by the im parameter.
 For BLOCKED_X, im = nX.
 For BLOCKED_XY, im = nX*nY.
 For BLOCKED_XYZ, im = nX*nY*nZ.

  • Enum Constant Details

    • INTERLEAVED

      public static final DataLayout3D INTERLEAVED
      Interleaved data layout.

    • BLOCKED_X

      public static final DataLayout3D BLOCKED_X
      Blocked data layout with im = nX.

    • BLOCKED_XY

      public static final DataLayout3D BLOCKED_XY
      Blocked data layout with im = nX*nY.

    • BLOCKED_XYZ

      public static final DataLayout3D BLOCKED_XYZ
      Blocked data layout with im = nX*nY*nZ.

  • Method Details

    • values

      public static DataLayout3D[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DataLayout3D valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null