SubbandROIMask (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- io.scif.jj2000.j2k.roi.encoder.SubbandROIMask

Direct Known Subclasses:

SubbandRectROIMask
```
public abstract class SubbandROIMask
extends Object
```
This abstract class describes the ROI mask for a single subband. Each object of the class contains the mask for a particular subband and also has references to the masks of the children subbands of the subband corresponding to this mask.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`h` Height of the subband mask
`protected SubbandROIMask`	`hh` The subband masks of the child HH
`protected SubbandROIMask`	`hl` The subband masks of the child HL
`protected boolean`	`isNode` Flag indicating whether this subband mask is a node or not
`protected SubbandROIMask`	`lh` The subband masks of the child LH
`protected SubbandROIMask`	`ll` The subband masks of the child LL
`int`	`ulx` Horizontal uper-left coordinate of the subband mask
`int`	`uly` Vertical uper-left coordinate of the subband mask
`int`	`w` Width of the subband mask

Constructor Summary

Constructors
Constructor and Description
`SubbandROIMask(int ulx, int uly, int w, int h)` The constructor of the SubbandROIMask takes the dimensions of the subband as parameters

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubbandROIMask`	`getSubbandRectROIMask(int x, int y)` Returns a reference to the Subband mask element to which the specified point belongs.

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

- Field Detail
  - ll
```
protected SubbandROIMask ll
```
    The subband masks of the child LL
  - lh
```
protected SubbandROIMask lh
```
    The subband masks of the child LH
  - hl
```
protected SubbandROIMask hl
```
    The subband masks of the child HL
  - hh
```
protected SubbandROIMask hh
```
    The subband masks of the child HH
  - isNode
```
protected boolean isNode
```
    Flag indicating whether this subband mask is a node or not
  - ulx
```
public int ulx
```
    Horizontal uper-left coordinate of the subband mask
  - uly
```
public int uly
```
    Vertical uper-left coordinate of the subband mask
  - w
```
public int w
```
    Width of the subband mask
  - h
```
public int h
```
    Height of the subband mask
- Constructor Detail
  - SubbandROIMask
```
public SubbandROIMask(int ulx,
                      int uly,
                      int w,
                      int h)
```
    The constructor of the SubbandROIMask takes the dimensions of the subband as parameters
    
    Parameters:
    
    ulx - The upper left x coordinate of corresponding subband
    
    uly - The upper left y coordinate of corresponding subband
    
    w - The width of corresponding subband
    
    h - The height of corresponding subband
- Method Detail
  - getSubbandRectROIMask
```
public SubbandROIMask getSubbandRectROIMask(int x,
                                            int y)
```
    Returns a reference to the Subband mask element to which the specified point belongs. The specified point must be inside this (i.e. the one defined by this object) subband mask. This method searches through the tree.
    
    Parameters:
    
    x - horizontal coordinate of the specified point.
    
    y - horizontal coordinate of the specified point.

Class SubbandROIMask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ll

lh

hl

hh

isNode

ulx

uly

w

h

Constructor Detail

SubbandROIMask

Method Detail

getSubbandRectROIMask