OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DcmRLECodecParameter Class Reference

codec parameter for RLE codec More...

Inheritance diagram for DcmRLECodecParameter:
[legend]
Collaboration diagram for DcmRLECodecParameter:
[legend]

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
 
- Public Member Functions inherited from DcmCodecParameter
 DcmCodecParameter ()
 default constructor
 
 DcmCodecParameter (const DcmCodecParameter &)
 copy constructor
 
virtual ~DcmCodecParameter ()
 destructor
 

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

Definition at line 37 of file dcrlecp.h.

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

Definition at line 95 of file dcrlecp.h.

References convertToSC.

OFBool DcmRLECodecParameter::getCreateOffsetTable ( ) const
inline

returns offset table creation flag

Returns
offset table creation flag

Definition at line 87 of file dcrlecp.h.

References createOffsetTable.

Uint32 DcmRLECodecParameter::getFragmentSize ( ) const
inline

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

Returns
maximum fragment size for compression

Definition at line 79 of file dcrlecp.h.

References fragmentSize.

OFBool DcmRLECodecParameter::getReverseDecompressionByteOrder ( ) const
inline

returns reverse decompression byte order mode

Returns
reverse decompression byte order mode

Definition at line 111 of file dcrlecp.h.

References reverseDecompressionByteOrder.

OFBool DcmRLECodecParameter::getUIDCreation ( ) const
inline

returns mode for SOP Instance UID creation

Returns
mode for SOP Instance UID creation

Definition at line 103 of file dcrlecp.h.

References createInstanceUID.


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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2