#include <djv_jpxencoder.h>

Public Member Functions
	Params (const String &inJasPerConfigParams)
	Params (CodingMode _codingMode=cm_Int, Progression _progression=prg_LRCP, bool _noMCT=false, size_t _numLevels=5, float _rate=0, size_t _tileWidth=0, size_t _tileHeight=0, bool _grayOutput=false, bool _generateSOP=false, bool _generateEPH=false, bool _lazyCoding=false, bool _termAll=false, bool _segSymbols=false, bool _virtCasual=false, bool _predictableTerm=false, bool _resetProb=false, size_t _numGuardBits=0)
void	init (const String &inJasPerConfigParams)
String	getJasPerStyleParams () const
bool	operator== (const Params &r) const
bool	operator!= (const Params &r) const
Public Attributes
CodingMode	codingMode
	Set the coding mode. (`mode`).
Progression	progression
	Set the progression order. (`prg`).
bool	noMCT
	Disallow the use of any multicomponent transform. (`nomct`).
size_t	numLevels
	Set the number of resolution levels.
float	rate
	Specify the target rate.
size_t	tileWidth
	Set the nominal tile width. (`tilewidth`).
size_t	tileHeight
	Set the nominal tile height. (`tileheight`).
size_t	precinctWidth
	Set the precinct width. (`prcwidth`).
size_t	precinctHeight
	Set the precinct height. (`prcheight`).
size_t	codeBlockWidth
	Set the nominal code block width. (`cblkwidth`).
size_t	codeBlockHeight
	Set the nominal code block height. (`cblkheight`).
bool	grayOutput
	Force grayscale output. (`gray`).
bool	generateSOP
	Generate SOP marker segments. (`sop`).
bool	generateEPH
	Generate EPH marker segments. (`eph`).
bool	lazyCoding
	Enable lazy coding mode (a.k.a. arithmetic coding bypass). (`lazy`).
bool	termAll
	Terminate all coding passes. (`termall`).
bool	segSymbols
	Use segmentation symbols. (`segsym`).
bool	virtCasual
	Use vertically stripe causal contexts. (`vcausal`).
bool	predictableTerm
	Use predictable termination. (`pterm`).
bool	resetProb
	Reset the probability models after each coding pass. (`resetprob`).
size_t	numGuardBits
	Set the number of guard bits. (`numgbits`).
SimpleArray< float >	rates
	Specify the rates for any intermediate layers. (`ilyrrates`).

Detailed Description

JPX encoder parameter.

Note:: All rates are specified in terms of compression factors (i.e., as reciprocals of compression ratio) and not as actual bit rates! Although image coding folks frequently use the number of bits per pixel to specify rate, this quantity is often inconvenient to use when dealing with images that have differing sample precisions. Furthermore, the number of bits per pixel is not well defined for multicomponent images with distinct subsampling factors. The compression factor, however, is independent of sample precision and well defined for all types of images. For these reasons, JasPer does uses the compression factor and not the number of bits per pixel to specify rates.

Constructor & Destructor Documentation

Celartem::DjVu::JPXEncoder::Params::Params ( const String & inJasPerConfigParams ) [inline]

Initialize the parameters with JasPer style parameter string.

Parameters:

inJasPerConfigParams

JasPer configuration string.

Celartem::DjVu::JPXEncoder::Params::Params	(	CodingMode	_codingMode = `cm_Int`,
		Progression	_progression = `prg_LRCP`,
		bool	_noMCT = `false`,
		size_t	_numLevels = `5`,
		float	_rate = `0`,
		size_t	_tileWidth = `0`,
		size_t	_tileHeight = `0`,
		bool	_grayOutput = `false`,
		bool	_generateSOP = `false`,
		bool	_generateEPH = `false`,
		bool	_lazyCoding = `false`,
		bool	_termAll = `false`,
		bool	_segSymbols = `false`,
		bool	_virtCasual = `false`,
		bool	_predictableTerm = `false`,
		bool	_resetProb = `false`,
		size_t	_numGuardBits = `0`
	)			`[inline]`

Initialize the parameters.

Parameters:

	_codingMode	Set the coding mode. The default is cm_Int.
	_progression	Set the progression order. The default is prg_LRCP.
	_noMCT	Disallow the use of any multicomponent transform. The default value is `false` (using MCT).
	_numLevels	Set the number of resolution levels. It must be an integer that is greater than or equal to one. The default value is 5.
	_rate	Specify the target rate. It is a positive real number. Since a rate of one corresponds to no compression, one should never need to explicitly specify a rate greater than one. By default, the target rate is considered to be infinite.
	_tileWidth	Set the nominal tile width.
	_tileHeight	Set the nominal tile height.
	_grayOutput	Force grayscale output.
	_generateSOP	Generate SOP marker segments. The default is `false`.
	_generateEPH;	Generate EPH marker segments. The default is `false`.
	_lazyCoding;	Enable lazy coding mode (a.k.a. arithmetic coding bypass). The default is `false`.
	_termAll	Terminate all coding passes. The default is `false`.
	_segSymbols	Use segmentation symbols. The default is `false`.
	_virtCasual;	Use vertically stripe causal contexts. The default is `false`.
	_predictableTerm;	Use predictable termination. The default is `false`.
	_resetProb;	Reset the probability models after each coding pass. The default is `false`.
	_numGuardBits;	Set the number of guard bits.

Member Function Documentation

String Celartem::DjVu::JPXEncoder::Params::getJasPerStyleParams ( ) const

Gets JasPer style parameter string.

Returns:: JasPer style parameter string.

void Celartem::DjVu::JPXEncoder::Params::init ( const String & inJasPerConfigParams )

Initialize the parameters with JasPer style parameter string.

Parameters:

inJasPerConfigParams

JasPer configuration string.

Referenced by Params().

bool Celartem::DjVu::JPXEncoder::Params::operator!= ( const Params & r ) const [inline]

For comparison.

bool Celartem::DjVu::JPXEncoder::Params::operator== ( const Params & r ) const

For comparison.

Member Data Documentation

size_t Celartem::DjVu::JPXEncoder::Params::codeBlockHeight

Set the nominal code block height. (cblkheight).

It must be an integer power of two. The default value is 64.

size_t Celartem::DjVu::JPXEncoder::Params::codeBlockWidth

Set the nominal code block width. (cblkwidth).

It must be an integer power of two. The default value is 64.

CodingMode Celartem::DjVu::JPXEncoder::Params::codingMode

Set the coding mode. (mode).

The default is cm_Int.

bool Celartem::DjVu::JPXEncoder::Params::generateEPH

Generate EPH marker segments. (eph).

The default is false.

bool Celartem::DjVu::JPXEncoder::Params::generateSOP

Generate SOP marker segments. (sop).

The default is false.

bool Celartem::DjVu::JPXEncoder::Params::grayOutput

Force grayscale output. (gray).

The default is false.

Note:: This is not a JasPer option but specialized for this encoder.

bool Celartem::DjVu::JPXEncoder::Params::lazyCoding

Enable lazy coding mode (a.k.a. arithmetic coding bypass). (lazy).

The default is false.

bool Celartem::DjVu::JPXEncoder::Params::noMCT

Disallow the use of any multicomponent transform. (nomct).

The default value is false (using MCT).

size_t Celartem::DjVu::JPXEncoder::Params::numGuardBits

Set the number of guard bits. (numgbits).

size_t Celartem::DjVu::JPXEncoder::Params::numLevels

Set the number of resolution levels.

It must be an integer that is greater than or equal to one. The default value is 5.

size_t Celartem::DjVu::JPXEncoder::Params::precinctHeight

Set the precinct height. (prcheight).

It must be an integer power of two. The default value is 32768.

size_t Celartem::DjVu::JPXEncoder::Params::precinctWidth

Set the precinct width. (prcwidth).

It must be an integer power of two. The default value is 32768.

bool Celartem::DjVu::JPXEncoder::Params::predictableTerm

Use predictable termination. (pterm).

The default is false.

Progression Celartem::DjVu::JPXEncoder::Params::progression

Set the progression order. (prg).

The default is prg_LRCP.

float Celartem::DjVu::JPXEncoder::Params::rate

Specify the target rate.

It is a positive real number. Since a rate of one corresponds to no compression, one should never need to explicitly specify a rate greater than one. By default, the target rate is considered to be infinite.

SimpleArray<float> Celartem::DjVu::JPXEncoder::Params::rates

Specify the rates for any intermediate layers. (ilyrrates).

This is list of N rates. Each rate is a positive real number. The rates must increase monotonically. The last rate in the list should be less than or equal to the overall rate (as specified with the rate option).

bool Celartem::DjVu::JPXEncoder::Params::resetProb

Reset the probability models after each coding pass. (resetprob).

The default is false.

bool Celartem::DjVu::JPXEncoder::Params::segSymbols

Use segmentation symbols. (segsym).

The default is false.

bool Celartem::DjVu::JPXEncoder::Params::termAll

Terminate all coding passes. (termall).

The default is false.

size_t Celartem::DjVu::JPXEncoder::Params::tileHeight

Set the nominal tile height. (tileheight).

size_t Celartem::DjVu::JPXEncoder::Params::tileWidth