DJLSCodecParameter Class Reference

codec parameter for JPEG-LS codecs More...

Inheritance diagram for DJLSCodecParameter:

DcmCodecParameter List of all members.

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.
 DJLSCodecParameter (JLS_UIDCreation uidCreation=EJLSUC_default, JLS_PlanarConfiguration planarConfiguration=EJLSPC_restore, OFBool ignoreOffsetTable=OFFalse)
 constructor, for use with decoders.
 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.
virtual const char * className () const
 returns the class name as string.
OFBool getConvertToSC () const
 returns secondary capture conversion flag
OFBool getCreateOffsetTable () const
 returns create offset table flag
JLS_UIDCreation getUIDCreation () const
 returns mode for SOP Instance UID creation
JLS_PlanarConfiguration getPlanarConfiguration () const
 returns mode for handling planar configuration
OFBool cookedEncodingPreferred () const
 returns flag indicating whether or not the "cooked" lossless encoder should be preferred over the "raw" one
Uint32 getFragmentSize () const
 returns maximum fragment size (in kbytes) for compression, 0 for unlimited.
Uint16 getT1 () const
 returns JPEG-LS parameter T1
Uint16 getT2 () const
 returns JPEG-LS parameter T2
Uint16 getT3 () const
 returns JPEG-LS parameter T3
Uint16 getReset () const
 returns JPEG-LS parameter RESET
Uint16 getLimit () const
 returns JPEG-LS parameter LIMIT
OFBool getUseCustomOptions () const
 returns true if JPEG-LS parameters T1-T3, RESET and LIMIT are enabled, false otherwise
OFBool ignoreOffsetTable () const
 returns true if the offset table should be ignored when decompressing multiframe images
interleaveMode getJplsInterleaveMode () const
 returns the interleave mode which the encoder should use

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

Definition at line 38 of file djcparam.h.


Member Enumeration Documentation

enum DJLSCodecParameter::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).

Definition at line 44 of file djcparam.h.


Constructor & Destructor Documentation

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

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:
uidCreation mode for SOP Instance UID creation (used both for encoding and decoding)
planarConfiguration flag describing how planar configuration of decompressed color images should be handled
ignoreOffsetTable flag indicating whether to ignore the offset table when decompressing multiframe images


Member Function Documentation

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.

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

returns the class name as string.

can be used as poor man's RTTI replacement.

Implements DcmCodecParameter.

OFBool DJLSCodecParameter::getConvertToSC (  )  const [inline]

returns secondary capture conversion flag

Returns:
secondary capture conversion flag

Definition at line 119 of file djcparam.h.

References convertToSC_.

OFBool DJLSCodecParameter::getCreateOffsetTable (  )  const [inline]

returns create offset table flag

Returns:
create offset table flag

Definition at line 127 of file djcparam.h.

References createOffsetTable_.

JLS_UIDCreation DJLSCodecParameter::getUIDCreation (  )  const [inline]

returns mode for SOP Instance UID creation

Returns:
mode for SOP Instance UID creation

Definition at line 135 of file djcparam.h.

References uidCreation_.

JLS_PlanarConfiguration DJLSCodecParameter::getPlanarConfiguration (  )  const [inline]

returns mode for handling planar configuration

Returns:
mode for handling planar configuration

Definition at line 143 of file djcparam.h.

References planarConfiguration_.

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

Definition at line 152 of file djcparam.h.

References preferCookedEncoding_.

Uint32 DJLSCodecParameter::getFragmentSize (  )  const [inline]

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

Returns:
maximum fragment size for compression

Definition at line 160 of file djcparam.h.

References fragmentSize_.

Uint16 DJLSCodecParameter::getT1 (  )  const [inline]

returns JPEG-LS parameter T1

Returns:
JPEG-LS parameter T1

Definition at line 168 of file djcparam.h.

References jpls_t1_.

Uint16 DJLSCodecParameter::getT2 (  )  const [inline]

returns JPEG-LS parameter T2

Returns:
JPEG-LS parameter T2

Definition at line 176 of file djcparam.h.

References jpls_t2_.

Uint16 DJLSCodecParameter::getT3 (  )  const [inline]

returns JPEG-LS parameter T3

Returns:
JPEG-LS parameter T3

Definition at line 184 of file djcparam.h.

References jpls_t3_.

Uint16 DJLSCodecParameter::getReset (  )  const [inline]

returns JPEG-LS parameter RESET

Returns:
JPEG-LS parameter RESET

Definition at line 192 of file djcparam.h.

References jpls_reset_.

Uint16 DJLSCodecParameter::getLimit (  )  const [inline]

returns JPEG-LS parameter LIMIT

Returns:
JPEG-LS parameter LIMIT

Definition at line 200 of file djcparam.h.

References jpls_t1_.

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

Definition at line 208 of file djcparam.h.

References jpls_optionsEnabled_.

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

Definition at line 216 of file djcparam.h.

References ignoreOffsetTable_.

interleaveMode DJLSCodecParameter::getJplsInterleaveMode (  )  const [inline]

returns the interleave mode which the encoder should use

Returns:
the interleave mode which the encoder should use

Definition at line 224 of file djcparam.h.

References jplsInterleaveMode_.


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


Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1