Class ForwardWT

java.lang.Object
jj2000.j2k.image.ImgDataAdapter
jj2000.j2k.wavelet.analysis.ForwardWT
All Implemented Interfaces:
ImgData, CBlkWTDataSrc, ForwWT, ForwWTDataProps, WaveletTransform
Direct Known Subclasses:
ForwWTFull

public abstract class ForwardWT extends ImgDataAdapter implements ForwWT, CBlkWTDataSrc
This abstract class represents the forward wavelet transform functional block. The functional block may actually be comprised of several classes linked together, but a subclass of this abstract class is the one that is returned as the functional block that performs the forward wavelet transform.

This class assumes that data is transferred in code-blocks, as defined by the 'CBlkWTDataSrc' interface. The internal calculation of the wavelet transform may be done differently but a buffering class should convert to that type of transfer.

  • Field Details

    • WT_DECOMP_DYADIC

      public static final int WT_DECOMP_DYADIC
      ID for the dyadic wavelet tree decomposition (also called "Mallat" in JPEG 2000): 0x00.
      See Also:
    • OPT_PREFIX

      public static final char OPT_PREFIX
      The prefix for wavelet transform options: 'W'
      See Also:
  • Constructor Details

    • ForwardWT

      protected ForwardWT(ImgData src)
      Initializes this object for the specified number of tiles 'nt' and components 'nc'.
      Parameters:
      src - The source of ImgData
  • Method Details

    • getParameterInfo

      public static String[][] getParameterInfo()
      Returns the parameters that are used in this class and implementing classes. It returns a 2D String array. Each of the 1D arrays is for a different option, and they have 3 elements. The first element is the option name, the second one is the synopsis and the third one is a long description of what the parameter is. The synopsis or description may be 'null', in which case it is assumed that there is no synopsis or description of the option, respectively. Null may be returned if no options are supported.
      Returns:
      the options name, their synopsis and their explanation, or null if no options are supported.
    • createInstance

      public static ForwardWT createInstance(BlkImgDataSrc src, J2KImageWriteParamJava wp)
      Creates a ForwardWT object with the specified filters, and with other options specified in the parameter list 'pl'.
      Parameters:
      src - The source of data to be transformed
      wp - The writing parameters.
      Returns:
      A new ForwardWT object with the specified filters and options from 'pl'.
      Throws:
      IllegalArgumentException - If mandatory parameters are missing or if invalid values are given.