corrade-vassal – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 vero 1 /*
2 * CVS identifier:
3 *
4 * $Id: ForwWT.java,v 1.9 2001/10/24 12:02:13 grosbois Exp $
5 *
6 * Class: ForwWT
7 *
8 * Description: The interface for implementations of a forward
9 * wavelet transform.
10 *
11 *
12 *
13 * COPYRIGHT:
14 *
15 * This software module was originally developed by Raphaël Grosbois and
16 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
17 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
18 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
19 * Centre France S.A) in the course of development of the JPEG2000
20 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
21 * software module is an implementation of a part of the JPEG 2000
22 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
23 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
24 * Partners) agree not to assert against ISO/IEC and users of the JPEG
25 * 2000 Standard (Users) any of their rights under the copyright, not
26 * including other intellectual property rights, for this software module
27 * with respect to the usage by ISO/IEC and Users of this software module
28 * or modifications thereof for use in hardware or software products
29 * claiming conformance to the JPEG 2000 Standard. Those intending to use
30 * this software module in hardware or software products are advised that
31 * their use may infringe existing patents. The original developers of
32 * this software module, JJ2000 Partners and ISO/IEC assume no liability
33 * for use of this software module or modifications thereof. No license
34 * or right to this software module is granted for non JPEG 2000 Standard
35 * conforming products. JJ2000 Partners have full right to use this
36 * software module for his/her own purpose, assign or donate this
37 * software module to any third party and to inhibit third parties from
38 * using this software module for non JPEG 2000 Standard conforming
39 * products. This copyright notice must be included in all copies or
40 * derivative works of this software module.
41 *
42 * Copyright (c) 1999/2000 JJ2000 Partners.
43 * */
44 using System;
45 using CSJ2K.j2k.wavelet;
46 namespace CSJ2K.j2k.wavelet.analysis
47 {
48  
49 /// <summary> This interface extends the WaveletTransform with the specifics of forward
50 /// wavelet transforms. Classes that implement forward wavelet transfoms should
51 /// implement this interface.
52 ///
53 /// <p>This class does not define the methods to transfer data, just the
54 /// specifics to forward wavelet transform. Different data transfer methods are
55 /// evisageable for different transforms.</p>
56 ///
57 /// </summary>
58 public interface ForwWT:WaveletTransform, ForwWTDataProps
59 {
60  
61 /// <summary> Returns the horizontal analysis wavelet filters used in each level, for
62 /// the specified tile-component. The first element in the array is the
63 /// filter used to obtain the lowest resolution (resolution level 0)
64 /// subbands (i.e. lowest frequency LL subband), the second element is the
65 /// one used to generate the resolution level 1 subbands, and so on. If
66 /// there are less elements in the array than the number of resolution
67 /// levels, then the last one is assumed to repeat itself.
68 ///
69 /// <p>The returned filters are applicable only to the specified component
70 /// and in the current tile.</p>
71 ///
72 /// <p>The resolution level of a subband is the resolution level to which a
73 /// subband contributes, which is different from its decomposition
74 /// level.</p>
75 ///
76 /// </summary>
77 /// <param name="t">The index of the tile for which to return the filters.
78 ///
79 /// </param>
80 /// <param name="c">The index of the component for which to return the filters.
81 ///
82 /// </param>
83 /// <returns> The horizontal analysis wavelet filters used in each level.
84 ///
85 /// </returns>
86 AnWTFilter[] getHorAnWaveletFilters(int t, int c);
87  
88 /// <summary> Returns the vertical analysis wavelet filters used in each level, for
89 /// the specified tile-component. The first element in the array is the
90 /// filter used to obtain the lowest resolution (resolution level 0)
91 /// subbands (i.e. lowest frequency LL subband), the second element is the
92 /// one used to generate the resolution level 1 subbands, and so on. If
93 /// there are less elements in the array than the number of resolution
94 /// levels, then the last one is assumed to repeat itself.
95 ///
96 /// <p>The returned filters are applicable only to the specified component
97 /// and in the current tile.</p>
98 ///
99 /// <p>The resolution level of a subband is the resolution level to which a
100 /// subband contributes, which is different from its decomposition
101 /// level.</p>
102 ///
103 /// </summary>
104 /// <param name="t">The index of the tile for which to return the filters.
105 ///
106 /// </param>
107 /// <param name="c">The index of the component for which to return the filters.
108 ///
109 /// </param>
110 /// <returns> The vertical analysis wavelet filters used in each level.
111 ///
112 /// </returns>
113 AnWTFilter[] getVertAnWaveletFilters(int t, int c);
114  
115 /// <summary> Returns the number of decomposition levels that are applied to obtain
116 /// the LL band, in the specified tile-component. A value of 0 means that
117 /// no wavelet transform is applied.
118 ///
119 /// </summary>
120 /// <param name="t">The tile index
121 ///
122 /// </param>
123 /// <param name="c">The index of the component.
124 ///
125 /// </param>
126 /// <returns> The number of decompositions applied to obtain the LL subband
127 /// (0 for no wavelet transform).
128 ///
129 /// </returns>
130 int getDecompLevels(int t, int c);
131  
132 /// <summary> Returns the wavelet tree decomposition. Only WT_DECOMP_DYADIC is
133 /// supported by JPEG 2000 part I.
134 ///
135 /// </summary>
136 /// <param name="t">The tile index
137 ///
138 /// </param>
139 /// <param name="c">The index of the component.
140 ///
141 /// </param>
142 /// <returns> The wavelet decomposition.
143 ///
144 /// </returns>
145 int getDecomp(int t, int c);
146 }
147 }