CodedCBlk (OME JAI 0.1.5 API)

java.lang.Object
- jj2000.j2k.entropy.CodedCBlk

Direct Known Subclasses:

CBlkRateDistStats, DecLyrdCBlk
```
public class CodedCBlk
extends java.lang.Object
```
This is the generic class to store coded (compressed) code-block. It stores the compressed data as well as the necessary side-information.
This class is normally not used. Instead the EncRDCBlk, EncLyrdCBlk and the DecLyrdCBlk subclasses are used.

See Also:

CBlkRateDistStats, DecLyrdCBlk

Field Summary

Fields
Modifier and Type	Field	Description
`byte[]`	`data`	The compressed data
`int`	`m`	The vertical index of the code-block, within the subband.
`int`	`n`	The horizontal index of the code-block, within the subband.
`int`	`skipMSBP`	The number of skipped most significant bit-planes.

Constructor Summary

Constructors
Constructor	Description
`CodedCBlk()`	Creates a new CodedCBlk object wit the default values and without allocating any space for its members.
`CodedCBlk(int m, int n, int skipMSBP, byte[] data)`	Creates a new CodedCBlk object with the specified values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

java.lang.String toString()
Returns the contents of the object in a string.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - n
```
public int n
```
    The horizontal index of the code-block, within the subband.
  - m
```
public int m
```
    The vertical index of the code-block, within the subband.
  - skipMSBP
```
public int skipMSBP
```
    The number of skipped most significant bit-planes.
  - data
```
public byte[] data
```
    The compressed data
- Constructor Detail
  - CodedCBlk
```
public CodedCBlk()
```
    Creates a new CodedCBlk object wit the default values and without allocating any space for its members.
  - CodedCBlk
```
public CodedCBlk(int m,
                 int n,
                 int skipMSBP,
                 byte[] data)
```
    Creates a new CodedCBlk object with the specified values.
    
    Parameters:
    
    m - The horizontal index of the code-block, within the subband.
    
    n - The vertical index of the code-block, within the subband.
    
    skipMSBP - The number of skipped most significant bit-planes for this code-block.
    
    data - The compressed data. This array is referenced by this object so it should not be modified after.
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Returns the contents of the object in a string. The string contains the following data: 'm', 'n', 'skipMSBP' and 'data.length. This is used for debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string with the contents of the object