# CSJ2K.j2k.wavelet.analysis.ForwardWT

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="CSJ2K_j2k_wavelet_analysis_ForwardWT" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT" class="text-break">ForwardWT Class
</h1>
  <div class="markdown level0 summary"><p>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.</p>
<pre><code>       &lt;p&gt;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.&lt;/p&gt;
</code></pre>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><a class="xref" href="CSJ2K.j2k.image.ImgDataAdapter.html">ImgDataAdapter</a></div>
    <div class="level2"><span class="xref">ForwardWT</span></div>
      <div class="level3"><a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwWTFull.html">ForwWTFull</a></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwWT.html">ForwWT</a></div>
    <div><a class="xref" href="CSJ2K.j2k.wavelet.WaveletTransform.html">WaveletTransform</a></div>
    <div><a class="xref" href="CSJ2K.j2k.wavelet.analysis.CBlkWTDataSrc.html">CBlkWTDataSrc</a></div>
    <div><a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwWTDataProps.html">ForwWTDataProps</a></div>
    <div><a class="xref" href="CSJ2K.j2k.image.ImgData.html">ImgData</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="CSJ2K.j2k.wavelet.analysis.html">CSJ2K.j2k.wavelet.analysis</a></h6>
  <h6><strong>Assembly</strong>: C1.WPF.ReportViewer.4.6.2.dll</h6>
  <h5 id="CSJ2K_j2k_wavelet_analysis_ForwardWT_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract class ForwardWT : ImgDataAdapter, ForwWT, WaveletTransform, CBlkWTDataSrc, ForwWTDataProps, ImgData</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public MustInherit Class ForwardWT
    Inherits ImgDataAdapter
    Implements ForwWT, WaveletTransform, CBlkWTDataSrc, ForwWTDataProps, ImgData</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT__ctor_CSJ2K_j2k_image_ImgData_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.#ctor(CSJ2K.j2k.image.ImgData)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.-ctor.html#CSJ2K_j2k_wavelet_analysis_ForwardWT__ctor_CSJ2K_j2k_image_ImgData_">ForwardWT(ImgData)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes this object for the specified number of tiles 'nt' and
components 'nc'.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="fields">Fields
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_OPT_PREFIX" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.OPT_PREFIX">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.OPT_PREFIX.html">OPT_PREFIX</a>
        </td>
        <td class="markdown level1 summary"><p>The prefix for wavelet transform options: 'W'</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_WT_DECOMP_DYADIC" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.WT_DECOMP_DYADIC">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.WT_DECOMP_DYADIC.html">WT_DECOMP_DYADIC</a>
        </td>
        <td class="markdown level1 summary"><p>ID for the dyadic wavelet tree decomposition (also called &quot;Mallat&quot; in
JPEG 2000): 0x00.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_CbULX" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.CbULX">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.CbULX.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_CbULX">CbULX</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the horizontal offset of the code-block partition. Allowable
values are 0 and 1, nothing else.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_CbULY" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.CbULY">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.CbULY.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_CbULY">CbULY</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the vertical offset of the code-block partition. Allowable
values are 0 and 1, nothing else.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_ParameterInfo" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.ParameterInfo">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.ParameterInfo.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_ParameterInfo">ParameterInfo</a>
        </td>
        <td class="markdown level1 summary"><p>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.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_createInstance_CSJ2K_j2k_image_BlkImgDataSrc_CSJ2K_j2k_util_ParameterList_CSJ2K_j2k_encoder_EncoderSpecs_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.createInstance(CSJ2K.j2k.image.BlkImgDataSrc,CSJ2K.j2k.util.ParameterList,CSJ2K.j2k.encoder.EncoderSpecs)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.createInstance.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_createInstance_CSJ2K_j2k_image_BlkImgDataSrc_CSJ2K_j2k_util_ParameterList_CSJ2K_j2k_encoder_EncoderSpecs_">createInstance(BlkImgDataSrc, ParameterList, EncoderSpecs)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a ForwardWT object with the specified filters, and with other
options specified in the parameter list 'pl'.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getAnSubbandTree_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getAnSubbandTree(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getAnSubbandTree.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getAnSubbandTree_System_Int32_System_Int32_">getAnSubbandTree(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a reference to the root of subband tree structure representing
the subband decomposition for the specified tile-component.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getDataType_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getDataType(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getDataType.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getDataType_System_Int32_System_Int32_">getDataType(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Return the data type of this CBlkWTDataSrc for the given component in
the current tile. Its value should be either DataBlk.TYPE_INT or
DataBlk.TYPE_FLOAT but can change according to the current
tile-component.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getDecomp_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getDecomp(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getDecomp.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getDecomp_System_Int32_System_Int32_">getDecomp(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the wavelet tree decomposition. Only WT_DECOMP_DYADIC is
supported by JPEG 2000 part I.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getDecompLevels_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getDecompLevels(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getDecompLevels.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getDecompLevels_System_Int32_System_Int32_">getDecompLevels(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the number of decomposition levels that are applied to obtain
the LL band, in the specified tile-component. A value of 0 means that
no wavelet transform is applied.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getFixedPoint_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getFixedPoint(System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getFixedPoint.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getFixedPoint_System_Int32_">getFixedPoint(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the position of the fixed point in the specified component, or
equivalently the number of fractional bits. 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.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getHorAnWaveletFilters_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getHorAnWaveletFilters(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getHorAnWaveletFilters.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getHorAnWaveletFilters_System_Int32_System_Int32_">getHorAnWaveletFilters(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the horizontal analysis wavelet filters used in each level, for
the specified tile-component. 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.</p>
<pre><code>       &lt;p&gt;The returned filters are applicable only to the specified component
       and in the current tile.&lt;/p&gt;&lt;p&gt;The resolution level of a subband is the resolution level to which a
       subband contributes, which is different from its decomposition
       level.&lt;/p&gt;
</code></pre>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getImplementationType_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getImplementationType(System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getImplementationType.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getImplementationType_System_Int32_">getImplementationType(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the implementation type of this wavelet transform (WT_IMPL_LINE
or WT_IMPL_FRAME) for the specified component, in the current tile.</p>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getNextCodeBlock_System_Int32_CSJ2K_j2k_wavelet_analysis_CBlkWTData_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getNextCodeBlock(System.Int32,CSJ2K.j2k.wavelet.analysis.CBlkWTData)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getNextCodeBlock.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getNextCodeBlock_System_Int32_CSJ2K_j2k_wavelet_analysis_CBlkWTData_">getNextCodeBlock(int, CBlkWTData)</a>
        </td>
        <td class="markdown level1 summary"><p>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'.</p>
<pre><code>       &lt;p&gt;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.&lt;/p&gt;&lt;p&gt;The data returned by this method is always a copy of the internal
       data of this object, if any, and it can be modified &quot;in place&quot; 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.&lt;/p&gt;&lt;p&gt;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.&lt;/p&gt;
</code></pre>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getNextInternCodeBlock_System_Int32_CSJ2K_j2k_wavelet_analysis_CBlkWTData_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getNextInternCodeBlock(System.Int32,CSJ2K.j2k.wavelet.analysis.CBlkWTData)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getNextInternCodeBlock.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getNextInternCodeBlock_System_Int32_CSJ2K_j2k_wavelet_analysis_CBlkWTData_">getNextInternCodeBlock(int, CBlkWTData)</a>
        </td>
        <td class="markdown level1 summary"><p>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'.</p>
<pre><code>       &lt;p&gt;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.&lt;/p&gt;&lt;p&gt;The data returned by this method can be the data in the internal
       buffer of this object, if any, and thus can not be modified by the
       caller. The 'offset' and 'scanw' of the returned data can be
       arbitrary. The 'magbits' of the returned data is not set by this method
       and should be ignored. See the 'CBlkWTData' class.&lt;/p&gt;&lt;p&gt;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.&lt;/p&gt;
</code></pre>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_getVertAnWaveletFilters_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.getVertAnWaveletFilters(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.getVertAnWaveletFilters.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_getVertAnWaveletFilters_System_Int32_System_Int32_">getVertAnWaveletFilters(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the vertical analysis wavelet filters used in each level, for
the specified tile-component. 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.</p>
<pre><code>       &lt;p&gt;The returned filters are applicable only to the specified component
       and in the current tile.&lt;/p&gt;&lt;p&gt;The resolution level of a subband is the resolution level to which a
       subband contributes, which is different from its decomposition
       level.&lt;/p&gt;
</code></pre>
</td>
      </tr>
      <tr>
        <td id="CSJ2K_j2k_wavelet_analysis_ForwardWT_isReversible_System_Int32_System_Int32_" data-uid="CSJ2K.j2k.wavelet.analysis.ForwardWT.isReversible(System.Int32,System.Int32)">
          <a class="xref" href="CSJ2K.j2k.wavelet.analysis.ForwardWT.isReversible.html#CSJ2K_j2k_wavelet_analysis_ForwardWT_isReversible_System_Int32_System_Int32_">isReversible(int, int)</a>
        </td>
        <td class="markdown level1 summary"><p>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.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
