DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Member Functions | Private Attributes
DcmRLECodecParameter Class Reference

codec parameter for RLE codec More...

+ Inheritance diagram for DcmRLECodecParameter:

List of all members.

Public Member Functions

 DcmRLECodecParameter (OFBool pCreateSOPInstanceUID=OFFalse, Uint32 pFragmentSize=0, OFBool pCreateOffsetTable=OFTrue, OFBool pConvertToSC=OFFalse, OFBool pReverseDecompressionByteOrder=OFFalse)
 constructor.
 DcmRLECodecParameter (const DcmRLECodecParameter &arg)
 copy constructor
virtual ~DcmRLECodecParameter ()
 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.
Uint32 getFragmentSize () const
 returns maximum fragment size (in kbytes) for compression, 0 for unlimited.
OFBool getCreateOffsetTable () const
 returns offset table creation flag
OFBool getConvertToSC () const
 returns secondary capture conversion flag
OFBool getUIDCreation () const
 returns mode for SOP Instance UID creation
OFBool getReverseDecompressionByteOrder () const
 returns reverse decompression byte order mode

Private Member Functions

DcmRLECodecParameteroperator= (const DcmRLECodecParameter &)
 private undefined copy assignment operator

Private Attributes

Uint32 fragmentSize
 maximum fragment size (in kbytes) for compression, 0 for unlimited.
OFBool createOffsetTable
 create offset table during image compression
OFBool convertToSC
 flag indicating whether image should be converted to Secondary Capture upon compression
OFBool createInstanceUID
 create new Instance UID during compression/decompression?
OFBool reverseDecompressionByteOrder
 enable reverse byte order of RLE segments during decompression, needed to decompress certain incorrectly encoded RLE images

Detailed Description

codec parameter for RLE codec


Constructor & Destructor Documentation

DcmRLECodecParameter::DcmRLECodecParameter ( OFBool  pCreateSOPInstanceUID = OFFalse,
Uint32  pFragmentSize = 0,
OFBool  pCreateOffsetTable = OFTrue,
OFBool  pConvertToSC = OFFalse,
OFBool  pReverseDecompressionByteOrder = OFFalse 
)

constructor.

Parameters:
pCreateSOPInstanceUIDtrue if a new SOP instance UID should be assigned upon compression/decompression
pFragmentSizemaximum fragment size (in kbytes) for compression, 0 for unlimited.
pCreateOffsetTablecreate offset table during image compression?
pConvertToSCflag indicating whether image should be converted to Secondary Capture upon compression
pReverseDecompressionByteOrderflag indicating whether the byte order should be reversed upon decompression. Needed to correctly decode some incorrectly encoded images with more than one byte per sample.

Member Function Documentation

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

returns the class name as string.

can be used as poor man's RTTI replacement.

Implements DcmCodecParameter.

virtual DcmCodecParameter* DcmRLECodecParameter::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.

OFBool DcmRLECodecParameter::getConvertToSC ( ) const [inline]

returns secondary capture conversion flag

Returns:
secondary capture conversion flag
OFBool DcmRLECodecParameter::getCreateOffsetTable ( ) const [inline]

returns offset table creation flag

Returns:
offset table creation flag
Uint32 DcmRLECodecParameter::getFragmentSize ( ) const [inline]

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

Returns:
maximum fragment size for compression

returns reverse decompression byte order mode

Returns:
reverse decompression byte order mode
OFBool DcmRLECodecParameter::getUIDCreation ( ) const [inline]

returns mode for SOP Instance UID creation

Returns:
mode for SOP Instance UID creation

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027