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

codec parameter for JPEG-LS codecs More...

+ Inheritance diagram for DJLSCodecParameter:

Public Types

enum  interleaveMode { interleaveDefault, interleaveSample, interleaveLine, interleaveNone }
 Constants describing the interleave mode which the encoder will use. More...
 

Public Member Functions

 DJLSCodecParameter (OFBool jpls_optionsEnabled, 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, JLS_PlanarConfiguration planarConfiguration=EJLSPC_restore, OFBool ignoreOffsetTable=OFFalse, interleaveMode jplsInterleaveMode=interleaveLine)
 constructor, for use with encoders. More...
 
 DJLSCodecParameter (JLS_UIDCreation uidCreation=EJLSUC_default, JLS_PlanarConfiguration planarConfiguration=EJLSPC_restore, OFBool ignoreOffsetTable=OFFalse)
 constructor, for use with decoders. More...
 
 DJLSCodecParameter (const DJLSCodecParameter &arg)
 copy constructor
 
virtual ~DJLSCodecParameter ()
 destructor
 
virtual DcmCodecParameterclone () const
 this methods creates a copy of type DcmCodecParameter * it must be overweritten in every subclass. More...
 
virtual const char * className () const
 returns the class name as string. More...
 
OFBool getConvertToSC () const
 returns secondary capture conversion flag More...
 
OFBool getCreateOffsetTable () const
 returns create offset table flag More...
 
JLS_UIDCreation getUIDCreation () const
 returns mode for SOP Instance UID creation More...
 
JLS_PlanarConfiguration getPlanarConfiguration () const
 returns mode for handling planar configuration More...
 
OFBool cookedEncodingPreferred () const
 returns flag indicating whether or not the "cooked" lossless encoder should be preferred over the "raw" one More...
 
Uint32 getFragmentSize () const
 returns maximum fragment size (in kbytes) for compression, 0 for unlimited. More...
 
Uint16 getT1 () const
 returns JPEG-LS parameter T1 More...
 
Uint16 getT2 () const
 returns JPEG-LS parameter T2 More...
 
Uint16 getT3 () const
 returns JPEG-LS parameter T3 More...
 
Uint16 getReset () const
 returns JPEG-LS parameter RESET More...
 
Uint16 getLimit () const
 returns JPEG-LS parameter LIMIT More...
 
OFBool getUseCustomOptions () const
 returns true if JPEG-LS parameters T1-T3, RESET and LIMIT are enabled, false otherwise More...
 
OFBool ignoreOffsetTable () const
 returns true if the offset table should be ignored when decompressing multiframe images More...
 
interleaveMode getJplsInterleaveMode () const
 returns the interleave mode which the encoder should use More...
 
- Public Member Functions inherited from DcmCodecParameter
 DcmCodecParameter ()
 default constructor
 
 DcmCodecParameter (const DcmCodecParameter &)
 copy constructor
 
virtual ~DcmCodecParameter ()
 destructor
 

Private Member Functions

DJLSCodecParameteroperator= (const DJLSCodecParameter &)
 private undefined copy assignment operator
 

Private Attributes

OFBool jpls_optionsEnabled_
 enable/disable use of all five JPEG-LS parameters
 
Uint16 jpls_t1_
 JPEG-LS parameter "Threshold 1" (used for quantization)
 
Uint16 jpls_t2_
 JPEG-LS parameter "Threshold 2".
 
Uint16 jpls_t3_
 JPEG-LS parameter "Threshold 3".
 
Uint16 jpls_reset_
 JPEG-LS parameter "RESET", i.e., value at which the counters A, B, and N are halved.
 
Uint16 jpls_limit_
 JPEG-LS parameter "LIMIT".
 
Uint32 fragmentSize_
 maximum fragment size (in kbytes) for compression, 0 for unlimited.
 
OFBool createOffsetTable_
 create offset table during image compression
 
OFBool preferCookedEncoding_
 Flag indicating if the "cooked" lossless encoder should be preferred over the "raw" one.
 
JLS_UIDCreation uidCreation_
 mode for SOP Instance UID creation (used both for encoding and decoding)
 
OFBool convertToSC_
 flag indicating whether image should be converted to Secondary Capture upon compression
 
interleaveMode jplsInterleaveMode_
 Flag describing the interleave mode which the encoder will use.
 
JLS_PlanarConfiguration planarConfiguration_
 flag describing how planar configuration of decompressed color images should be handled
 
OFBool ignoreOffsetTable_
 flag indicating if temporary files should be kept, false if they should be deleted after use
 

Detailed Description

codec parameter for JPEG-LS codecs

Member Enumeration Documentation

◆ interleaveMode

Constants describing the interleave mode which the encoder will use.

Enumerator
interleaveDefault 

Use same interleave mode as the DICOM header says in planarConfiguration, if possible.

The cooked encoder will force interleaveLine.

interleaveSample 

Sample-interleaved (color-by-pixel)

interleaveLine 

Line-interleaved (color-by-line)

interleaveNone 

Uninterleaved (color-by-plane)

Constructor & Destructor Documentation

◆ DJLSCodecParameter() [1/2]

DJLSCodecParameter::DJLSCodecParameter ( OFBool  jpls_optionsEnabled,
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,
JLS_PlanarConfiguration  planarConfiguration = EJLSPC_restore,
OFBool  ignoreOffsetTable = OFFalse,
interleaveMode  jplsInterleaveMode = interleaveLine 
)

constructor, for use with encoders.

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
planarConfigurationflag describing how planar configuration of decompressed color images should be handled
ignoreOffsetTableflag indicating whether to ignore the offset table when decompressing multiframe images
jplsInterleaveModeflag describing which interleave the JPEG-LS datastream should use

◆ DJLSCodecParameter() [2/2]

DJLSCodecParameter::DJLSCodecParameter ( JLS_UIDCreation  uidCreation = EJLSUC_default,
JLS_PlanarConfiguration  planarConfiguration = EJLSPC_restore,
OFBool  ignoreOffsetTable = OFFalse 
)

constructor, for use with decoders.

Initializes all encoder options to defaults.

Parameters
uidCreationmode for SOP Instance UID creation (used both for encoding and decoding)
planarConfigurationflag describing how planar configuration of decompressed color images should be handled
ignoreOffsetTableflag indicating whether to ignore the offset table when decompressing multiframe images

Member Function Documentation

◆ className()

virtual const char* DJLSCodecParameter::className ( ) const
virtual

returns the class name as string.

can be used as poor man's RTTI replacement.

Implements DcmCodecParameter.

◆ clone()

virtual DcmCodecParameter* DJLSCodecParameter::clone ( ) const
virtual

this methods creates a copy of type DcmCodecParameter * it must be overweritten in every subclass.

Returns
copy of this object

Implements DcmCodecParameter.

◆ cookedEncodingPreferred()

OFBool DJLSCodecParameter::cookedEncodingPreferred ( ) const
inline

returns flag indicating whether or not the "cooked" lossless encoder should be preferred over the "raw" one

Returns
raw/cooked lossless encoding flag

◆ getConvertToSC()

OFBool DJLSCodecParameter::getConvertToSC ( ) const
inline

returns secondary capture conversion flag

Returns
secondary capture conversion flag

◆ getCreateOffsetTable()

OFBool DJLSCodecParameter::getCreateOffsetTable ( ) const
inline

returns create offset table flag

Returns
create offset table flag

◆ getFragmentSize()

Uint32 DJLSCodecParameter::getFragmentSize ( ) const
inline

returns maximum fragment size (in kbytes) for compression, 0 for unlimited.

Returns
maximum fragment size for compression

◆ getJplsInterleaveMode()

interleaveMode DJLSCodecParameter::getJplsInterleaveMode ( ) const
inline

returns the interleave mode which the encoder should use

Returns
the interleave mode which the encoder should use

◆ getLimit()

Uint16 DJLSCodecParameter::getLimit ( ) const
inline

returns JPEG-LS parameter LIMIT

Returns
JPEG-LS parameter LIMIT

◆ getPlanarConfiguration()

JLS_PlanarConfiguration DJLSCodecParameter::getPlanarConfiguration ( ) const
inline

returns mode for handling planar configuration

Returns
mode for handling planar configuration

◆ getReset()

Uint16 DJLSCodecParameter::getReset ( ) const
inline

returns JPEG-LS parameter RESET

Returns
JPEG-LS parameter RESET

◆ getT1()

Uint16 DJLSCodecParameter::getT1 ( ) const
inline

returns JPEG-LS parameter T1

Returns
JPEG-LS parameter T1

◆ getT2()

Uint16 DJLSCodecParameter::getT2 ( ) const
inline

returns JPEG-LS parameter T2

Returns
JPEG-LS parameter T2

◆ getT3()

Uint16 DJLSCodecParameter::getT3 ( ) const
inline

returns JPEG-LS parameter T3

Returns
JPEG-LS parameter T3

◆ getUIDCreation()

JLS_UIDCreation DJLSCodecParameter::getUIDCreation ( ) const
inline

returns mode for SOP Instance UID creation

Returns
mode for SOP Instance UID creation

◆ getUseCustomOptions()

OFBool DJLSCodecParameter::getUseCustomOptions ( ) const
inline

returns true if JPEG-LS parameters T1-T3, RESET and LIMIT are enabled, false otherwise

Returns
true if JPEG-LS parameters T1-T3, RESET and LIMIT are enabled, false otherwise

◆ ignoreOffsetTable()

OFBool DJLSCodecParameter::ignoreOffsetTable ( ) const
inline

returns true if the offset table should be ignored when decompressing multiframe images

Returns
true if the offset table should be ignored when decompressing multiframe images

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