001/*
002 * $RCSfile: WaveletTransform.java,v $
003 * $Revision: 1.1 $
004 * $Date: 2005/02/11 05:02:28 $
005 * $State: Exp $
006 *
007 * Class:                   WaveletTransform
008 *
009 * Description:             Interface that defines how a forward or
010 *                          inverse wavelet transform should present
011 *                          itself.
012 *
013 *
014 *
015 * COPYRIGHT:
016 * 
017 * This software module was originally developed by Raphaël Grosbois and
018 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
019 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
020 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
021 * Centre France S.A) in the course of development of the JPEG2000
022 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
023 * software module is an implementation of a part of the JPEG 2000
024 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
025 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
026 * Partners) agree not to assert against ISO/IEC and users of the JPEG
027 * 2000 Standard (Users) any of their rights under the copyright, not
028 * including other intellectual property rights, for this software module
029 * with respect to the usage by ISO/IEC and Users of this software module
030 * or modifications thereof for use in hardware or software products
031 * claiming conformance to the JPEG 2000 Standard. Those intending to use
032 * this software module in hardware or software products are advised that
033 * their use may infringe existing patents. The original developers of
034 * this software module, JJ2000 Partners and ISO/IEC assume no liability
035 * for use of this software module or modifications thereof. No license
036 * or right to this software module is granted for non JPEG 2000 Standard
037 * conforming products. JJ2000 Partners have full right to use this
038 * software module for his/her own purpose, assign or donate this
039 * software module to any third party and to inhibit third parties from
040 * using this software module for non JPEG 2000 Standard conforming
041 * products. This copyright notice must be included in all copies or
042 * derivative works of this software module.
043 * 
044 * Copyright (c) 1999/2000 JJ2000 Partners.
045 * 
046 * 
047 * 
048 */
049
050
051package jj2000.j2k.wavelet;
052
053import jj2000.j2k.image.*;
054
055/**
056 * This interface defines how a forward or inverse wavelet transform
057 * should present itself. As specified in the ImgData interface,
058 * from which this class inherits, all operations are confined to the
059 * current tile, and all coordinates are relative to it.
060 *
061 * <P>The definition of the methods in this interface allows for
062 * different types of implementation, reversibility and levels of
063 * decompositions for each component and each tile. An implementation
064 * of this interface does not need to support all this flexibility
065 * (e.g., it may provide the same implementation type and
066 * decomposition levels for all tiles and components).
067 * */
068public interface WaveletTransform extends ImgData {
069
070    /**
071     * ID for line based implementations of wavelet transforms.
072     */
073    public final static int WT_IMPL_LINE = 0;
074
075    /**
076     * ID for full-page based implementations of wavelet transforms. Full-page
077     * based implementations should be avoided since they require
078     * large amounts of memory.  */
079    public final static int WT_IMPL_FULL = 2;
080
081
082    /**
083     * Returns the reversibility of the wavelet transform for the
084     * specified component and tile. A wavelet transform is reversible
085     * when it is suitable for lossless and lossy-to-lossless
086     * compression.
087     *
088     * @param t The index of the tile.
089     *
090     * @param c The index of the component.
091     *
092     * @return true is the wavelet transform is reversible, false if not.
093     *
094     *
095     * */
096    public boolean isReversible(int t,int c);
097
098    /**
099     * Returns the implementation type of this wavelet transform
100     * (WT_IMPL_LINE or WT_IMPL_FRAME) for the specified component, 
101     * in the current tile.
102     *
103     * @param n The index of the component.
104     *
105     * @return WT_IMPL_LINE or WT_IMPL_FULL for line,
106     * block or full-page based transforms.
107     *
108     *
109     * */
110    public int getImplementationType(int n);
111
112}