ForwWTFull (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- io.scif.jj2000.j2k.image.ImgDataAdapter
- - io.scif.jj2000.j2k.wavelet.analysis.ForwardWT
  - - io.scif.jj2000.j2k.wavelet.analysis.ForwWTFull

All Implemented Interfaces:

ImgData, CBlkWTDataSrc, ForwWT, ForwWTDataProps, WaveletTransform
```
public class ForwWTFull
extends ForwardWT
```
This class implements the ForwardWT with the full-page approach to be used either with integer or floating-point filters

Field Summary
- Fields inherited from class io.scif.jj2000.j2k.wavelet.analysis.ForwardWT
  OPT_PREFIX, WT_DECOMP_DYADIC
- Fields inherited from class io.scif.jj2000.j2k.image.ImgDataAdapter
  imgdatasrc, tIdx
- Fields inherited from interface io.scif.jj2000.j2k.wavelet.WaveletTransform
  WT_IMPL_FULL, WT_IMPL_LINE

Constructor Summary

Constructors
Constructor and Description
`ForwWTFull(BlkImgDataSrc src, J2KImageWriteParamJava wp, int pox, int poy)` Initializes this object with the given source of image data and with all the decompositon parameters

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubbandAn`	`getAnSubbandTree(int t, int c)` Returns a reference to the subband tree structure representing the subband decomposition for the specified tile-component of the source.
`int`	`getCbULX()` Returns the horizontal offset of the code-block partition.
`int`	`getCbULY()` Returns the vertical offset of the code-block partition.
`int`	`getDataType(int t, int c)` Return the data type of this CBlkWTDataSrc.
`int`	`getDecomp(int t, int c)` Returns the wavelet tree decomposition.
`int`	`getDecompLevels(int t, int c)` Returns the number of decomposition levels that are applied to the LL band, in the specified tile-component.
`int`	`getFixedPoint(int c)` Returns the position of the fixed point in the specified component.
`AnWTFilter[]`	`getHorAnWaveletFilters(int t, int c)` Returns the horizontal analysis wavelet filters used in each level, for the specified component and tile.
`int`	`getImplementationType(int c)` Returns the implementation type of this wavelet transform, WT_IMPL_FULL (full-page based transform).
`CBlkWTData`	`getNextCodeBlock(int c, CBlkWTData cblk)` Returns the next code-block in the current tile for the specified component, as a copy (see below).
`CBlkWTData`	`getNextInternCodeBlock(int c, CBlkWTData cblk)` Returns the next code-block in the current tile for the specified component.
`AnWTFilter[]`	`getVertAnWaveletFilters(int t, int c)` Returns the vertical analysis wavelet filters used in each level, for the specified component and tile.
`boolean`	`isReversible(int t, int c)` Returns the reversibility of the wavelet transform for the specified component and tile.
`void`	`nextTile()` Advances to the next tile, in standard scan-line order (by rows then columns).
`void`	`setTile(int x, int y)` Changes the current tile, given the new coordinates.

Methods inherited from class io.scif.jj2000.j2k.wavelet.analysis.ForwardWT
createInstance, getParameterInfo

Methods inherited from class io.scif.jj2000.j2k.image.ImgDataAdapter
getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getCompULX, getCompULY, getImgHeight, getImgULX, getImgULY, getImgWidth, getNomRangeBits, getNomTileHeight, getNomTileWidth, getNumComps, getNumTiles, getNumTiles, getTile, getTileCompHeight, getTileCompWidth, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.scif.jj2000.j2k.image.ImgData
getCompImgHeight, getCompImgWidth, getCompSubsX, getCompSubsY, getCompULX, getCompULY, getImgHeight, getImgULX, getImgULY, getImgWidth, getNomRangeBits, getNomTileHeight, getNomTileWidth, getNumComps, getNumTiles, getNumTiles, getTile, getTileCompHeight, getTileCompWidth, getTileHeight, getTileIdx, getTilePartULX, getTilePartULY, getTileWidth

- Constructor Detail
  - ForwWTFull
```
public ForwWTFull(BlkImgDataSrc src,
                  J2KImageWriteParamJava wp,
                  int pox,
                  int poy)
```
    Initializes this object with the given source of image data and with all the decompositon parameters
    
    Parameters:
    
    src - From where the image data should be obtained.
    
    encSpec - The encoder specifications
    
    pox - The horizontal coordinate of the cell and code-block partition origin with respect to the canvas origin, on the reference grid.
    
    poy - The vertical coordinate of the cell and code-block partition origin with respect to the canvas origin, on the reference grid.
    
    See Also:
    
    ForwardWT
- Method Detail
  - getImplementationType
```
public int getImplementationType(int c)
```
    Returns the implementation type of this wavelet transform, WT_IMPL_FULL (full-page based transform). All components return the same.
    
    Parameters:
    
    c - The index of the component.
    
    Returns:
    
    WT_IMPL_FULL
  - getDecompLevels
```
public int getDecompLevels(int t,
                           int c)
```
    Returns the number of decomposition levels that are applied to the LL band, in the specified tile-component. A value of 0 means that no wavelet transform is applied.
    
    Parameters:
    
    t - The tile index
    
    c - The index of the component.
    
    Returns:
    
    The number of decompositions applied to the LL band (0 for no wavelet transform).
  - getDecomp
```
public int getDecomp(int t,
                     int c)
```
    Returns the wavelet tree decomposition. Actually JPEG 2000 part 1 only supports WT_DECOMP_DYADIC decomposition.
    
    Parameters:
    
    t - The tile-index
    
    c - The index of the component.
    
    Returns:
    
    The wavelet decomposition.
  - getHorAnWaveletFilters
```
public AnWTFilter[] getHorAnWaveletFilters(int t,
                                           int c)
```
    Returns the horizontal analysis wavelet filters used in each level, for the specified component and tile. The first element in the array is the filter used to obtain the lowest resolution (resolution level 0) subbands (i.e. lowest frequency LL subband), the second element is the one used to generate the resolution level 1 subbands, and so on. If there are less elements in the array than the number of resolution levels, then the last one is assumed to repeat itself.
    The returned filters are applicable only to the specified component and in the current tile.
    The resolution level of a subband is the resolution level to which a subband contributes, which is different from its decomposition level.
    
    Parameters:
    
    t - The index of the tile for which to return the filters.
    
    c - The index of the component for which to return the filters.
    
    Returns:
    
    The horizontal analysis wavelet filters used in each level.
  - getVertAnWaveletFilters
```
public AnWTFilter[] getVertAnWaveletFilters(int t,
                                            int c)
```
    Returns the vertical analysis wavelet filters used in each level, for the specified component and tile. The first element in the array is the filter used to obtain the lowest resolution (resolution level 0) subbands (i.e. lowest frequency LL subband), the second element is the one used to generate the resolution level 1 subbands, and so on. If there are less elements in the array than the number of resolution levels, then the last one is assumed to repeat itself.
    The returned filters are applicable only to the specified component and in the current tile.
    The resolution level of a subband is the resolution level to which a subband contributes, which is different from its decomposition level.
    
    Parameters:
    
    t - The index of the tile for which to return the filters.
    
    c - The index of the component for which to return the filters.
    
    Returns:
    
    The vertical analysis wavelet filters used in each level.
  - isReversible
```
public boolean isReversible(int t,
                            int c)
```
    Returns the reversibility of the wavelet transform for the specified component and tile. A wavelet transform is reversible when it is suitable for lossless and lossy-to-lossless compression.
    
    Parameters:
    
    t - The index of the tile.
    
    c - The index of the component.
    
    Returns:
    
    true is the wavelet transform is reversible, false if not.
  - getCbULX
```
public int getCbULX()
```
    Returns the horizontal offset of the code-block partition. Allowable values are 0 and 1, nothing else.
  - getCbULY
```
public int getCbULY()
```
    Returns the vertical offset of the code-block partition. Allowable values are 0 and 1, nothing else.
  - getFixedPoint
```
public int getFixedPoint(int c)
```
    Returns the position of the fixed point in the specified component. This is the position of the least significant integral (i.e. non-fractional) bit, which is equivalent to the number of fractional bits. For instance, for fixed-point values with 2 fractional bits, 2 is returned. For floating-point data this value does not apply and 0 should be returned. Position 0 is the position of the least significant bit in the data.
    
    Parameters:
    
    c - The index of the component.
    
    Returns:
    
    The position of the fixed-point, which is the same as the number of fractional bits. For floating-point data 0 is returned.
  - getNextInternCodeBlock
```
public CBlkWTData getNextInternCodeBlock(int c,
                                         CBlkWTData cblk)
```
    Returns the next code-block in the current tile for the specified component. The order in which code-blocks are returned is not specified. However each code-block is returned only once and all code-blocks will be returned if the method is called 'N' times, where 'N' is the number of code-blocks in the tile. After all the code-blocks have been returned for the current tile calls to this method will return 'null'.
    When changing the current tile (through 'setTile()' or 'nextTile()') this method will always return the first code-block, as if this method was never called before for the new current tile.
    
    The data returned by this method is the data in the internal buffer of this object, and thus can not be modified by the caller. The 'offset' and 'scanw' of the returned data have, in general, some non-zero value. The 'magbits' of the returned data is not set by this method and should be ignored. See the 'CBlkWTData' class.
    
    The 'ulx' and 'uly' members of the returned 'CBlkWTData' object contain the coordinates of the top-left corner of the block, with respect to the tile, not the subband.
    
    Parameters:
    
    c - The component for which to return the next code-block.
    
    cblk - If non-null this object will be used to return the new code-block. If null a new one will be allocated and returned.
    
    Returns:
    
    The next code-block in the current tile for component 'n', or null if all code-blocks for the current tile have been returned.
    
    See Also:
    
    CBlkWTData
  - getNextCodeBlock
```
public CBlkWTData getNextCodeBlock(int c,
                                   CBlkWTData cblk)
```
    Returns the next code-block in the current tile for the specified component, as a copy (see below). The order in which code-blocks are returned is not specified. However each code-block is returned only once and all code-blocks will be returned if the method is called 'N' times, where 'N' is the number of code-blocks in the tile. After all the code-blocks have been returned for the current tile calls to this method will return 'null'.
    When changing the current tile (through 'setTile()' or 'nextTile()') this method will always return the first code-block, as if this method was never called before for the new current tile.
    The data returned by this method is always a copy of the internal data of this object, and it can be modified "in place" without any problems after being returned. The 'offset' of the returned data is 0, and the 'scanw' is the same as the code-block width. The 'magbits' of the returned data is not set by this method and should be ignored. See the 'CBlkWTData' class.
    The 'ulx' and 'uly' members of the returned 'CBlkWTData' object contain the coordinates of the top-left corner of the block, with respect to the tile, not the subband.
    
    Parameters:
    
    c - The component for which to return the next code-block.
    
    cblk - If non-null this object will be used to return the new code-block. If null a new one will be allocated and returned. If the "data" array of the object is non-null it will be reused, if possible, to return the data.
    
    Returns:
    
    The next code-block in the current tile for component 'c', or null if all code-blocks for the current tile have been returned.
    
    See Also:
    
    CBlkWTData
  - getDataType
```
public int getDataType(int t,
                       int c)
```
    Return the data type of this CBlkWTDataSrc. Its value should be either DataBlk.TYPE_INT or DataBlk.TYPE_FLOAT but can change according to the current tile-component.
    
    Parameters:
    
    t - The index of the tile for which to return the data type.
    
    c - The index of the component for which to return the data type.
    
    Returns:
    
    Current data type
  - setTile
```
public void setTile(int x,
                    int y)
```
    Changes the current tile, given the new coordinates.
    This method resets the 'subbTrees' array, and recalculates the values of the 'reversible' array. It also resets the decomposed component buffers.
    
    Specified by:
    
    setTile in interface ImgData
    
    Overrides:
    
    setTile in class ImgDataAdapter
    
    Parameters:
    
    x - The horizontal coordinate of the tile.
    
    y - The vertical coordinate of the new tile.
  - nextTile
```
public void nextTile()
```
    Advances to the next tile, in standard scan-line order (by rows then columns). An NoNextElementException is thrown if the current tile is the last one (i.e. there is no next tile).
    This method resets the 'subbTrees' array, and recalculates the values of the 'reversible' array. It also resets the decomposed component buffers.
    
    Specified by:
    
    nextTile in interface ImgData
    
    Overrides:
    
    nextTile in class ImgDataAdapter
  - getAnSubbandTree
```
public SubbandAn getAnSubbandTree(int t,
                                  int c)
```
    Returns a reference to the subband tree structure representing the subband decomposition for the specified tile-component of the source.
    
    Parameters:
    
    t - The index of the tile.
    
    c - The index of the component.
    
    Returns:
    
    The subband tree structure, see Subband.
    
    See Also:
    
    SubbandAn, Subband

Class ForwWTFull

Field Summary

Fields inherited from class io.scif.jj2000.j2k.wavelet.analysis.ForwardWT

Fields inherited from class io.scif.jj2000.j2k.image.ImgDataAdapter

Fields inherited from interface io.scif.jj2000.j2k.wavelet.WaveletTransform

Constructor Summary

Method Summary

Methods inherited from class io.scif.jj2000.j2k.wavelet.analysis.ForwardWT

Methods inherited from class io.scif.jj2000.j2k.image.ImgDataAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.scif.jj2000.j2k.image.ImgData

Constructor Detail

ForwWTFull

Method Detail

getImplementationType

getDecompLevels

getDecomp

getHorAnWaveletFilters

getVertAnWaveletFilters

isReversible

getCbULX

getCbULY

getFixedPoint

getNextInternCodeBlock

getNextCodeBlock

getDataType

setTile

nextTile

getAnSubbandTree