Celartem::DjVu::JB2Encoder::Params Struct Reference

#include <djv_jb2encoder.h>

List of all members.

Public Types
enum	{ SHAPE_REFINEMENT_THRESHOLD_DEFAULT = 60, SHAPE_MATCH_THRESHOLD_DEFAULT = 12 }
enum	NoiseReductionMethod { , nrRemoveIsolated, nrInflate, nrDeflate, nrReserved }
enum	Flags { fl_ShapeExtractionOnlyByMask = 1, fl_DivideLargeShapes = 2 }
Public Member Functions
	Params ()
Public Attributes
size_t	shapeRefinementThreshold
	JB2 shape refinement threshold in 0-100.
size_t	shapeMatchThreshold
	JB2 shape match threshold in 0-100.
size_t	pivotSkewThreshold
	JB2 shape pivot skew threshold in 0-4.
size_t	maxPalettes
	Maximum number of palettes on Color-JB2.
bool	sortShapes
	Determine whether to sort the shapes before compression.
NoiseReductionMethod	noiseRuductionMethod
u32	flags

---

Detailed Description

This struct contains parameters to configure the JB2 encoder settings.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

SHAPE_REFINEMENT_THRESHOLD_DEFAULT	Default for refinement threshold.
SHAPE_MATCH_THRESHOLD_DEFAULT	Default for match threshold.

enum Celartem::DjVu::JB2Encoder::Params::Flags

Flags to control JB2 encoder behavior.

Enumerator:

fl_ShapeExtractionOnlyByMask	Extraction process should use only mask data even when encoding Color JB2.
fl_DivideLargeShapes	Extraction process should divide large shapes.

enum Celartem::DjVu::JB2Encoder::Params::NoiseReductionMethod

Noise reduction method for mask layer.

Enumerator:

nrRemoveIsolated	Remove any completely isolated pixels.
nrInflate	If any pixels on neighbour, set pixel.
nrDeflate	If any empty pixels on neighbour, remove pixel.
nrReserved	Reserved for internal use.

---

Constructor & Destructor Documentation

Celartem::DjVu::JB2Encoder::Params::Params

(

)

[inline]

Initializes a new JB2Param structure.

---

Member Data Documentation

u32 Celartem::DjVu::JB2Encoder::Params::flags

Combination of Flags flags to control JB2 encoder behavior.

size_t Celartem::DjVu::JB2Encoder::Params::maxPalettes

Maximum number of palettes on Color-JB2.

The default is 256.

NoiseReductionMethod Celartem::DjVu::JB2Encoder::Params::noiseRuductionMethod

Noise reduction method for mask layer.
For Agressive or Lossy, if nrNone is selected, noise reduction is anyway enabled and nrRemoveIsolated is used.

size_t Celartem::DjVu::JB2Encoder::Params::pivotSkewThreshold

JB2 shape pivot skew threshold in 0-4.

This parameter controls the shape pivot matching behavior. The default value is 1. to shapeMatchThreshold.

size_t Celartem::DjVu::JB2Encoder::Params::shapeMatchThreshold

JB2 shape match threshold in 0-100.

This parameter controls the shape match behavior.
The threshold is based on the pixel area. The default is 12. If the original shape has N pixels, it accepts the shapes of the pixel difference less than N * shapeMatchThreshold / 100. So if shapeMatchThreshold=0, it accepts only identical matches.

See also:

shapeRefinementThreshold

size_t Celartem::DjVu::JB2Encoder::Params::shapeRefinementThreshold

JB2 shape refinement threshold in 0-100.

This parameter controls the shape refinement behavior.
This actually affects on the compression ratio and the compression speed but it does not affect on the resulting quality and there's no linear relation with the compression ratio. The default is 60.

See also:

shapeMatchThreshold

bool Celartem::DjVu::JB2Encoder::Params::sortShapes

Determine whether to sort the shapes before compression.

The default is false.

---

The documentation for this struct was generated from the following file:

• djv_jb2encoder.h