DCMTK  Version 3.6.2
OFFIS DICOM Toolkit
Static Public Member Functions | Static Private Attributes | List of all members
DJLSEncoderRegistration Class Reference

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

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. More...
 
static void cleanup ()
 deregisters encoders. More...
 
static OFString getLibraryVersionString ()
 get version information of the CharLS library. More...
 

Static Private Attributes

static OFBool registered_
 flag indicating whether the encoders are already registered.
 
static DJLSCodecParametercp_
 pointer to codec parameter shared by all encoders
 
static DJLSLosslessEncoderlosslessencoder_
 pointer to encoder for lossless JPEG-LS
 
static DJLSNearLosslessEncodernearlosslessencoder_
 pointer to encoder for lossy JPEG-LS
 

Detailed Description

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

Member Function Documentation

◆ cleanup()

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.

◆ getLibraryVersionString()

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

◆ registerCodecs()

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_optionsEnabledenable/disable use of all five JPEG-LS parameters
jpls_t1JPEG-LS parameter "Threshold 1" (used for quantization)
jpls_t2JPEG-LS parameter "Threshold 2"
jpls_t3JPEG-LS parameter "Threshold 3"
jpls_resetJPEG-LS parameter "RESET", i.e., value at which the counters A, B, and N are halved.
jpls_limitJPEG-LS parameter "LIMIT"
preferCookedEncodingtrue if the "cooked" lossless encoder should be preferred over the "raw" one
fragmentSizemaximum fragment size (in kbytes) for compression, 0 for unlimited.
createOffsetTablecreate offset table during image compression
uidCreationmode for SOP Instance UID creation
convertToSCflag indicating whether image should be converted to Secondary Capture upon compression
jplsInterleaveModeflag describing which interleave the JPEG-LS datastream should use

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


Generated on Mon Jul 17 2017 for DCMTK Version 3.6.2 by Doxygen 1.8.13