DJLSEncoderRegistration Class Reference

singleton class that registers encoders for all supported JPEG-LS processes. More...

List of all members.

Static Public Member Functions
static void	registerCodecs (OFBool jpls_optionsEnabled=OFFalse, Uint16 jpls_t1=3, Uint16 jpls_t2=7, Uint16 jpls_t3=21, Uint16 jpls_reset=64, Uint16 jpls_limit=0, OFBool preferCookedEncoding=OFTrue, Uint32 fragmentSize=0, OFBool createOffsetTable=OFTrue, JLS_UIDCreation uidCreation=EJLSUC_default, OFBool convertToSC=OFFalse, DJLSCodecParameter::interleaveMode jplsInterleaveMode=DJLSCodecParameter::interleaveDefault)
	registers encoders for all supported JPEG-LS processes.
static void	cleanup ()
	deregisters encoders.
static OFString	getLibraryVersionString ()
	get version information of the CharLS library.
Static Private Attributes
static OFBool	registered_
	flag indicating whether the encoders are already registered.
static DJLSCodecParameter *	cp_
	pointer to codec parameter shared by all encoders
static DJLSLosslessEncoder *	losslessencoder_
	pointer to encoder for lossless JPEG-LS
static DJLSNearLosslessEncoder *	nearlosslessencoder_
	pointer to encoder for lossy JPEG-LS

---

Detailed Description

singleton class that registers encoders for all supported JPEG-LS processes.

---

Member Function Documentation

static void DJLSEncoderRegistration::cleanup

(

)

[static]

deregisters encoders.

Attention: Must not be called while other threads might still use the registered codecs, e.g. because they are currently encoding DICOM data sets through dcmdata.

static OFString DJLSEncoderRegistration::getLibraryVersionString

(

)

[static]

get version information of the CharLS library.

Typical output format: "CharLS, Revision 55020 (modified)"

Returns:

name and version number of the CharLS library

static void DJLSEncoderRegistration::registerCodecs	(	OFBool	jpls_optionsEnabled = OFFalse,
		Uint16	jpls_t1 = 3,
		Uint16	jpls_t2 = 7,
		Uint16	jpls_t3 = 21,
		Uint16	jpls_reset = 64,
		Uint16	jpls_limit = 0,
		OFBool	preferCookedEncoding = OFTrue,
		Uint32	fragmentSize = 0,
		OFBool	createOffsetTable = OFTrue,
		JLS_UIDCreation	uidCreation = EJLSUC_default,
		OFBool	convertToSC = OFFalse,
		DJLSCodecParameter::interleaveMode	jplsInterleaveMode = DJLSCodecParameter::interleaveDefault
	)		[static]

registers encoders for all supported JPEG-LS processes.

If already registered, call is ignored unless cleanup() has been performed before.

Parameters:

jpls_optionsEnabled	enable/disable use of all five JPEG-LS parameters
jpls_t1	JPEG-LS parameter "Threshold 1" (used for quantization)
jpls_t2	JPEG-LS parameter "Threshold 2"
jpls_t3	JPEG-LS parameter "Threshold 3"
jpls_reset	JPEG-LS parameter "RESET", i.e., value at which the counters A, B, and N are halved.
jpls_limit	JPEG-LS parameter "LIMIT"
preferCookedEncoding	true if the "cooked" lossless encoder should be preferred over the "raw" one
fragmentSize	maximum fragment size (in kbytes) for compression, 0 for unlimited.
createOffsetTable	create offset table during image compression
uidCreation	mode for SOP Instance UID creation
convertToSC	flag indicating whether image should be converted to Secondary Capture upon compression
jplsInterleaveMode	flag describing which interleave the JPEG-LS datastream should use

---

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

• dcmjpls/include/dcmtk/dcmjpls/djencode.h