CBlkSizeSpec (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- io.scif.jj2000.j2k.ModuleSpec
- - io.scif.jj2000.j2k.entropy.CBlkSizeSpec

All Implemented Interfaces:

Cloneable
```
public class CBlkSizeSpec
extends ModuleSpec
```
This class extends ModuleSpec class for code-blocks sizes holding purposes.
It stores the size a of code-block.

Field Summary
- Fields inherited from class io.scif.jj2000.j2k.ModuleSpec
  compDef, def, nComp, nTiles, SPEC_COMP_DEF, SPEC_DEF, SPEC_TILE_COMP, SPEC_TILE_DEF, SPEC_TYPE_COMP, SPEC_TYPE_TILE, SPEC_TYPE_TILE_COMP, specified, specType, specValType, tileCompVal, tileDef

Constructor Summary

Constructors
Constructor and Description
`CBlkSizeSpec(int nt, int nc, byte type)` Creates a new CBlkSizeSpec object for the specified number of tiles and components.
`CBlkSizeSpec(int nt, int nc, byte type, J2KImageWriteParamJava wp, String values)` Creates a new CBlkSizeSpec object for the specified number of tiles and components and the ParameterList instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCBlkHeight(byte type, int t, int c)` Returns the code-block height: for the specified tile/component for the specified tile for the specified component default value The value returned depends on the value of the variable 'type' which can take the following values : SPEC_DEF -> Default value is returned.
`int`	`getCBlkWidth(byte type, int t, int c)` Returns the code-block width : for the specified tile/component for the specified tile for the specified component default value The value returned depends on the value of the variable 'type' which can take the following values : SPEC_DEF -> Default value is returned.
`int`	`getMaxCBlkHeight()` Returns the maximum code-block's height
`int`	`getMaxCBlkWidth()` Returns the maximum code-block's width
`void`	`setCompDef(int c, Object value)` Sets default value for specified component and specValType tag if allowed by its priority.
`void`	`setDefault(Object value)` Sets default value for this module
`void`	`setTileCompVal(int t, int c, Object value)` Sets value for specified tile-component.
`void`	`setTileDef(int t, Object value)` Sets default value for specified tile and specValType tag if allowed by its priority.

Methods inherited from class io.scif.jj2000.j2k.ModuleSpec
clone, getCompDef, getCopy, getDefault, getSpec, getSpecValType, getTileCompVal, getTileDef, isCompSpecified, isTileCompSpecified, isTileSpecified, parseIdx, rotate90

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

- Constructor Detail
  - CBlkSizeSpec
```
public CBlkSizeSpec(int nt,
                    int nc,
                    byte type)
```
    Creates a new CBlkSizeSpec object for the specified number of tiles and components.
    
    Parameters:
    
    nt - The number of tiles
    
    nc - The number of components
    
    type - the type of the specification module i.e. tile specific, component specific or both.
  - CBlkSizeSpec
```
public CBlkSizeSpec(int nt,
                    int nc,
                    byte type,
                    J2KImageWriteParamJava wp,
                    String values)
```
    Creates a new CBlkSizeSpec object for the specified number of tiles and components and the ParameterList instance.
    
    Parameters:
    
    nt - The number of tiles
    
    nc - The number of components
    
    type - the type of the specification module i.e. tile specific, component specific or both.
    
    imgsrc - The image source (used to get the image size)
    
    pl - The ParameterList instance
- Method Detail
  - getMaxCBlkWidth
```
public int getMaxCBlkWidth()
```
    Returns the maximum code-block's width
  - getMaxCBlkHeight
```
public int getMaxCBlkHeight()
```
    Returns the maximum code-block's height
  - getCBlkWidth
```
public int getCBlkWidth(byte type,
                        int t,
                        int c)
```
    Returns the code-block width :
    - for the specified tile/component
    - for the specified tile
    - for the specified component
    - default value
    The value returned depends on the value of the variable 'type' which can take the following values :
    - SPEC_DEF -> Default value is returned. t and c values are ignored
    - SPEC_COMP_DEF -> Component default value is returned. t value is ignored
    - SPEC_TILE_DEF -> Tile default value is returned. c value is ignored
    - SPEC_TILE_COMP -> Tile/Component value is returned.
    Parameters:
    
    type - The type of the value we want to be returned
    
    t - The tile index
    
    c - the component index
    
    Returns:
    
    The code-block width for the specified tile and component
  - getCBlkHeight
```
public int getCBlkHeight(byte type,
                         int t,
                         int c)
```
    Returns the code-block height:
    - for the specified tile/component
    - for the specified tile
    - for the specified component
    - default value
    The value returned depends on the value of the variable 'type' which can take the following values :
    - SPEC_DEF -> Default value is returned. t and c values are ignored
    - SPEC_COMP_DEF -> Component default value is returned. t value is ignored
    - SPEC_TILE_DEF -> Tile default value is returned. c value is ignored
    - SPEC_TILE_COMP -> Tile/Component value is returned.
    Parameters:
    
    type - The type of the value we want to be returned
    
    t - The tile index
    
    c - the component index
    
    Returns:
    
    The code-block height for the specified tile and component
  - setDefault
```
public void setDefault(Object value)
```
    Sets default value for this module
    
    Overrides:
    
    setDefault in class ModuleSpec
    
    Parameters:
    
    value - Default value
  - setTileDef
```
public void setTileDef(int t,
                       Object value)
```
    Sets default value for specified tile and specValType tag if allowed by its priority.
    
    Overrides:
    
    setTileDef in class ModuleSpec
    
    Parameters:
    
    c - Tile index.
    
    value - Tile's default value
  - setCompDef
```
public void setCompDef(int c,
                       Object value)
```
    Sets default value for specified component and specValType tag if allowed by its priority.
    
    Overrides:
    
    setCompDef in class ModuleSpec
    
    Parameters:
    
    c - Component index
    
    value - Component's default value
  - setTileCompVal
```
public void setTileCompVal(int t,
                           int c,
                           Object value)
```
    Sets value for specified tile-component.
    
    Overrides:
    
    setTileCompVal in class ModuleSpec
    
    Parameters:
    
    t - Tie index
    
    c - Component index
    
    value - Tile-component's value

Class CBlkSizeSpec

Field Summary

Fields inherited from class io.scif.jj2000.j2k.ModuleSpec

Constructor Summary

Method Summary

Methods inherited from class io.scif.jj2000.j2k.ModuleSpec

Methods inherited from class java.lang.Object

Constructor Detail

CBlkSizeSpec

CBlkSizeSpec

Method Detail

getMaxCBlkWidth

getMaxCBlkHeight

getCBlkWidth

getCBlkHeight

setDefault

setTileDef

setCompDef

setTileCompVal