StdEntropyCoderOptions (Bio-Formats API)

All Known Implementing Classes:

EntropyCoder, FileBitstreamReaderAgent, HeaderDecoder, HeaderEncoder, PktDecoder, StdEntropyCoder, StdEntropyDecoder
```
public interface StdEntropyCoderOptions
```
This interface define the constants that identify the possible options for the entropy coder, as well some fixed parameters of the JPEG 2000 entropy coder.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FIRST_BYPASS_PASS_IDX` The index of the first "raw" pass, if bypass mode is on.
`static int`	`MAX_CB_AREA` The maximum code-block area (width x height).
`static int`	`MAX_CB_DIM` The maximum code-block dimension.
`static int`	`MIN_CB_DIM` The minimum code-block dimension.
`static int`	`NUM_EMPTY_PASSES_IN_MS_BP` The number of empty passes in the most significant bit-plane.
`static int`	`NUM_NON_BYPASS_MS_BP` The number of most significant bit-planes where bypass mode is not to be used, even if bypass mode is on: 4.
`static int`	`NUM_PASSES` The number of coding passes per bit-plane.
`static int`	`OPT_BYPASS` The flag bit to indicate that selective arithmetic coding bypass should be used.
`static int`	`OPT_PRED_TERM` The flag bit to indicate that error resilience info is embedded on MQ termination.
`static int`	`OPT_RESET_MQ` The flag bit to indicate that the MQ states for all contexts should be reset at the end of each non-bypass coding pass.
`static int`	`OPT_SEG_SYMBOLS` The flag bit to indicate that a segmentation marker is to be inserted at the end of each normalization coding pass.
`static int`	`OPT_TERM_PASS` The flag bit to indicate that regular termination should be used.
`static int`	`OPT_VERT_STR_CAUSAL` The flag bit to indicate the vertically stripe-causal context formation should be used.
`static int`	`STRIPE_HEIGHT` The stripe height.

- Field Detail
  - OPT_BYPASS
```
static final int OPT_BYPASS
```
    The flag bit to indicate that selective arithmetic coding bypass should be used. In this mode some of the coding passes bypass the arithmetic coder and raw bits are output. If this flag is turned on and the 'OPT_TERM_PASS' one is turned off then the any non-bypass coding pass before a bypass coding pass must use MQ termination.
    
    See Also:
    Constant Field Values
  - OPT_RESET_MQ
```
static final int OPT_RESET_MQ
```
    The flag bit to indicate that the MQ states for all contexts should be reset at the end of each non-bypass coding pass.
    
    See Also:
    Constant Field Values
  - OPT_TERM_PASS
```
static final int OPT_TERM_PASS
```
    The flag bit to indicate that regular termination should be used. When this is specified termination is performed after each coding pass. Termination is applied to both arithmetically coded and bypass (i.e. raw) passes .
    
    See Also:
    Constant Field Values
  - OPT_VERT_STR_CAUSAL
```
static final int OPT_VERT_STR_CAUSAL
```
    The flag bit to indicate the vertically stripe-causal context formation should be used.
    
    See Also:
    Constant Field Values
  - OPT_PRED_TERM
```
static final int OPT_PRED_TERM
```
    The flag bit to indicate that error resilience info is embedded on MQ termination. The predictable error-resilient MQ termination at the encoder is necessary in this case.
    
    See Also:
    Constant Field Values
  - OPT_SEG_SYMBOLS
```
static final int OPT_SEG_SYMBOLS
```
    The flag bit to indicate that a segmentation marker is to be inserted at the end of each normalization coding pass. The segment marker is the four symbol sequence 1010 that are sent through the MQ coder using the UNIFORM context.
    
    See Also:
    Constant Field Values
  - MIN_CB_DIM
```
static final int MIN_CB_DIM
```
    The minimum code-block dimension. The nominal width or height of a code-block must never be less than this. It is 4.
    
    See Also:
    Constant Field Values
  - MAX_CB_DIM
```
static final int MAX_CB_DIM
```
    The maximum code-block dimension. No code-block should be larger, either in width or height, than this value. It is 1024.
    
    See Also:
    Constant Field Values
  - MAX_CB_AREA
```
static final int MAX_CB_AREA
```
    The maximum code-block area (width x height). The surface covered by a nominal size block should never be larger than this. It is 4096
    
    See Also:
    Constant Field Values
  - STRIPE_HEIGHT
```
static final int STRIPE_HEIGHT
```
    The stripe height. This is the nominal value of the stripe height. It is 4.
    
    See Also:
    Constant Field Values
  - NUM_PASSES
```
static final int NUM_PASSES
```
    The number of coding passes per bit-plane. This is the number of passes per bit-plane. It is 3.
    
    See Also:
    Constant Field Values
  - NUM_NON_BYPASS_MS_BP
```
static final int NUM_NON_BYPASS_MS_BP
```
    The number of most significant bit-planes where bypass mode is not to be used, even if bypass mode is on: 4.
    
    See Also:
    Constant Field Values
  - NUM_EMPTY_PASSES_IN_MS_BP
```
static final int NUM_EMPTY_PASSES_IN_MS_BP
```
    The number of empty passes in the most significant bit-plane. It is 2.
    
    See Also:
    Constant Field Values
  - FIRST_BYPASS_PASS_IDX
```
static final int FIRST_BYPASS_PASS_IDX
```
    The index of the first "raw" pass, if bypass mode is on.
    
    See Also:
    Constant Field Values

Interface StdEntropyCoderOptions

Field Summary

Field Detail

OPT_BYPASS

OPT_RESET_MQ

OPT_TERM_PASS

OPT_VERT_STR_CAUSAL

OPT_PRED_TERM

OPT_SEG_SYMBOLS

MIN_CB_DIM

MAX_CB_DIM

MAX_CB_AREA

STRIPE_HEIGHT

NUM_PASSES

NUM_NON_BYPASS_MS_BP

NUM_EMPTY_PASSES_IN_MS_BP

FIRST_BYPASS_PASS_IDX