Enum DftFlagsEnum

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DftFlagsEnum>

    public enum DftFlagsEnum
    extends java.lang.Enum<DftFlagsEnum>
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DCT_INVERSE
      performs an inverse 1D or 2D transform instead of the default forward transform.
      DCT_ROWS
      performs a forward or inverse transform of every individual row of the input matrix.
      DFT_COMPLEX_OUTPUT
      performs a forward transformation of 1D or 2D real array; the result, though being a complex array, has complex-conjugate symmetry (*CCS*, see the function description below for details), and such an array can be packed into a real array of the same size as input, which is the fastest option and which is what the function does by default; however, you may wish to get a full complex array (for simpler spectrum analysis, and so on) - pass the flag to enable the function to produce a full-size complex output array.
      DFT_INVERSE
      performs an inverse 1D or 2D transform instead of the default forward transform.
      DFT_REAL_OUTPUT
      performs an inverse transformation of a 1D or 2D complex array; the result is normally a complex array of the same size, however, if the input array has conjugate-complex symmetry (for example, it is a result of forward transformation with DFT_COMPLEX_OUTPUT flag), the output is a real array; while the function itself does not check whether the input is symmetrical or not, you can pass the flag and then the function will assume the symmetry and produce the real output array (note that when the input is packed into a real array and inverse transformation is executed, the function treats the input as a packed complex-conjugate symmetrical array, and the output will also be a real array).
      DFT_ROWS
      performs a forward or inverse transform of every individual row of the input matrix; this flag enables you to transform multiple vectors simultaneously and can be used to decrease the overhead (which is sometimes several times larger than the processing itself) to perform 3D and higher-dimensional transformations and so forth.
      DFT_SCALE
      scales the result: divide it by the number of array elements.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      int value  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DftFlagsEnum valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DftFlagsEnum[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • DFT_INVERSE

        public static final DftFlagsEnum DFT_INVERSE
        performs an inverse 1D or 2D transform instead of the default forward transform.
      • DFT_SCALE

        public static final DftFlagsEnum DFT_SCALE
        scales the result: divide it by the number of array elements. Normally, it is combined with DFT_INVERSE.
      • DFT_ROWS

        public static final DftFlagsEnum DFT_ROWS
        performs a forward or inverse transform of every individual row of the input matrix; this flag enables you to transform multiple vectors simultaneously and can be used to decrease the overhead (which is sometimes several times larger than the processing itself) to perform 3D and higher-dimensional transformations and so forth.
      • DFT_COMPLEX_OUTPUT

        public static final DftFlagsEnum DFT_COMPLEX_OUTPUT
        performs a forward transformation of 1D or 2D real array; the result, though being a complex array, has complex-conjugate symmetry (*CCS*, see the function description below for details), and such an array can be packed into a real array of the same size as input, which is the fastest option and which is what the function does by default; however, you may wish to get a full complex array (for simpler spectrum analysis, and so on) - pass the flag to enable the function to produce a full-size complex output array.
      • DFT_REAL_OUTPUT

        public static final DftFlagsEnum DFT_REAL_OUTPUT
        performs an inverse transformation of a 1D or 2D complex array; the result is normally a complex array of the same size, however, if the input array has conjugate-complex symmetry (for example, it is a result of forward transformation with DFT_COMPLEX_OUTPUT flag), the output is a real array; while the function itself does not check whether the input is symmetrical or not, you can pass the flag and then the function will assume the symmetry and produce the real output array (note that when the input is packed into a real array and inverse transformation is executed, the function treats the input as a packed complex-conjugate symmetrical array, and the output will also be a real array).
      • DCT_INVERSE

        public static final DftFlagsEnum DCT_INVERSE
        performs an inverse 1D or 2D transform instead of the default forward transform.
      • DCT_ROWS

        public static final DftFlagsEnum DCT_ROWS
        performs a forward or inverse transform of every individual row of the input matrix. This flag enables you to transform multiple vectors simultaneously and can be used to decrease the overhead (which is sometimes several times larger than the processing itself) to perform 3D and higher-dimensional transforms and so forth.
    • Field Detail

      • value

        public final int value
    • Method Detail

      • values

        public static DftFlagsEnum[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (DftFlagsEnum c : DftFlagsEnum.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DftFlagsEnum valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null