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

codec parameter for IJG codecs More...

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

Public Member Functions

 DJCodecParameter (E_CompressionColorSpaceConversion pCompressionCSConversion, E_DecompressionColorSpaceConversion pDecompressionCSConversion, E_UIDCreation pCreateSOPInstanceUID, E_PlanarConfiguration pPlanarConfiguration, OFBool predictor6WorkaroundEnable=OFFalse, OFBool pOptimizeHuffman=OFFalse, int pSmoothingFactor=0, int pForcedBitDepth=0, Uint32 pFragmentSize=0, OFBool pCreateOffsetTable=OFTrue, E_SubSampling pSampleFactors=ESS_444, OFBool pWriteYBR422=OFFalse, OFBool pConvertToSC=OFFalse, unsigned long pWindowType=0, unsigned long pWindowParameter=0, double pVoiCenter=0.0, double pVoiWidth=0.0, unsigned long pRoiLeft=0, unsigned long pRoiTop=0, unsigned long pRoiWidth=0, unsigned long pRoiHeight=0, OFBool pUsePixelValues=OFTrue, OFBool pUseModalityRescale=OFFalse, OFBool pAcceptWrongPaletteTags=OFFalse, OFBool pAcrNemaCompatibility=OFFalse, OFBool pTrueLosslessMode=OFTrue)
 constructor.
 
 DJCodecParameter (const DJCodecParameter &arg)
 copy constructor
 
virtual ~DJCodecParameter ()
 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 getOptimizeHuffmanCoding () const
 returns huffman table optimization flag for 8 bits/pixel compression
 
int getSmoothingFactor () const
 returns smoothing factor for image compression, 0..100
 
int getForcedBitDepth () const
 returns forced bit depth for image compression, 0 (auto) or 8/12/16
 
Uint32 getFragmentSize () const
 returns maximum fragment size (in kbytes) for compression, 0 for unlimited.
 
OFBool getCreateOffsetTable () const
 returns offset table creation flag
 
E_SubSampling getSampleFactors () const
 returns subsampling mode for color image compression
 
OFBool getWriteYBR422 () const
 returns flag indicating whether a compressed YBR color stream should be marked as YBR_FULL or YBR_FULL_422 on DICOM level
 
OFBool getConvertToSC () const
 returns secondary capture conversion flag
 
E_UIDCreation getUIDCreation () const
 returns mode for SOP Instance UID creation
 
unsigned long getWindowType () const
 returns mode for VOI transformation of monochrome images.
 
unsigned long getWindowParameter () const
 returns parameter for VOI transform of monochrome images, used in VOI modes 1, 2, 4, 6
 
void getVOIWindow (double &center, double &width) const
 returns VOI window center and width for VOI mode 5
 
void getROI (unsigned long &left_pos, unsigned long &top_pos, unsigned long &width, unsigned long &height) const
 returns ROI coordinates for VOI mode 7
 
E_PlanarConfiguration getPlanarConfiguration () const
 returns planar configuration flag
 
E_CompressionColorSpaceConversion getCompressionColorSpaceConversion () const
 returns color conversion mode for compression
 
E_DecompressionColorSpaceConversion getDecompressionColorSpaceConversion () const
 returns color conversion mode for compression
 
OFBool getUsePixelValues () const
 returns flag indicating if compression to be optimized for real pixel values
 
OFBool getUseModalityRescale () const
 returns flag indicating if compression should compute Rescale Slope/Intercept
 
OFBool getAcceptWrongPaletteTags () const
 Returns flag indicating if incorrect palette attribute tags should be accepted.
 
OFBool getAcrNemaCompatibility () const
 Returns flag indicating if compatibility to old ACR-NEMA images without photometric interpretation is enabled.
 
OFBool getTrueLosslessMode () const
 returns flag indicating if real lossless mode is enabled
 
OFBool predictor6WorkaroundEnabled () const
 returns flag indicating whether the workaround for buggy JPEG lossless images with incorrect predictor 6 is enabled
 
- Public Member Functions inherited from DcmCodecParameter
 DcmCodecParameter ()
 default constructor
 
 DcmCodecParameter (const DcmCodecParameter &)
 copy constructor
 
virtual ~DcmCodecParameter ()
 destructor
 

Private Member Functions

DJCodecParameteroperator= (const DJCodecParameter &)
 private undefined copy assignment operator
 

Private Attributes

E_CompressionColorSpaceConversion compressionCSConversion
 color conversion mode for compression
 
E_DecompressionColorSpaceConversion decompressionCSConversion
 color conversion mode for decompression
 
E_PlanarConfiguration planarConfiguration
 flag describing how planar configuration of decompressed color images should be handled
 
OFBool optimizeHuffman
 perform huffman table optimization for 8 bits/pixel compression?
 
int smoothingFactor
 smoothing factor for image compression, 0..100
 
int forcedBitDepth
 forced bit depth for image compression, 0 (auto) or 8/12/16
 
Uint32 fragmentSize
 maximum fragment size (in kbytes) for compression, 0 for unlimited.
 
OFBool createOffsetTable
 create offset table during image compression
 
E_SubSampling sampleFactors
 subsampling mode for color image compression
 
OFBool writeYBR422
 flag indicating whether a compressed YBR color stream should be marked as YBR_FULL or YBR_FULL_422 on DICOM level
 
OFBool convertToSC
 flag indicating whether image should be converted to Secondary Capture upon compression
 
E_UIDCreation uidCreation
 mode for SOP Instance UID creation
 
unsigned long windowType
 mode for VOI transformation of monochrome images.
 
unsigned long windowParameter
 parameter for VOI transform of monochrome images, used in modes 1, 2, 4, 6
 
double voiCenter
 VOI window center for mode 5.
 
double voiWidth
 VOI window width for mode 5.
 
unsigned long roiLeft
 Region of Interest left corner for for VOI transform of monochrome images, mode 7.
 
unsigned long roiTop
 Region of Interest upper corner for for VOI transform of monochrome images, mode 7.
 
unsigned long roiWidth
 Region of Interest width for for VOI transform of monochrome images, mode 7.
 
unsigned long roiHeight
 Region of Interest height for for VOI transform of monochrome images, mode 7.
 
OFBool usePixelValues
 Check smallest and largest pixel value and optimize compression, mode 0 only.
 
OFBool useModalityRescale
 Create Rescale Slope/Intercept to scale back to original pixel range, mode 0 only.
 
OFBool acceptWrongPaletteTags
 Accept wrong palette attribute tags.
 
OFBool acrNemaCompatibility
 Compatibility with old ACR-NEMA images without photometric interpretation.
 
OFBool trueLosslessMode
 True losless mode, replaces old "pseudo" lossless encoders, when true (default)
 
OFBool predictor6WorkaroundEnabled_
 flag indicating that the workaround for buggy JPEG lossless images with incorrect predictor 6 is enabled
 

Detailed Description

codec parameter for IJG codecs

Definition at line 38 of file djcparam.h.

Constructor & Destructor Documentation

DJCodecParameter::DJCodecParameter ( E_CompressionColorSpaceConversion  pCompressionCSConversion,
E_DecompressionColorSpaceConversion  pDecompressionCSConversion,
E_UIDCreation  pCreateSOPInstanceUID,
E_PlanarConfiguration  pPlanarConfiguration,
OFBool  predictor6WorkaroundEnable = OFFalse,
OFBool  pOptimizeHuffman = OFFalse,
int  pSmoothingFactor = 0,
int  pForcedBitDepth = 0,
Uint32  pFragmentSize = 0,
OFBool  pCreateOffsetTable = OFTrue,
E_SubSampling  pSampleFactors = ESS_444,
OFBool  pWriteYBR422 = OFFalse,
OFBool  pConvertToSC = OFFalse,
unsigned long  pWindowType = 0,
unsigned long  pWindowParameter = 0,
double  pVoiCenter = 0.0,
double  pVoiWidth = 0.0,
unsigned long  pRoiLeft = 0,
unsigned long  pRoiTop = 0,
unsigned long  pRoiWidth = 0,
unsigned long  pRoiHeight = 0,
OFBool  pUsePixelValues = OFTrue,
OFBool  pUseModalityRescale = OFFalse,
OFBool  pAcceptWrongPaletteTags = OFFalse,
OFBool  pAcrNemaCompatibility = OFFalse,
OFBool  pTrueLosslessMode = OFTrue 
)

constructor.

Parameters
pCompressionCSConversioncolor conversion mode for compression
pDecompressionCSConversioncolor conversion mode for decompression
pCreateSOPInstanceUIDmode for SOP Instance UID creation
pPlanarConfigurationflag describing how planar configuration of decompressed color images should be handled
predictor6WorkaroundEnableenable workaround for buggy lossless compressed images with overflow in predictor 6 for images with 16 bits/pixel
pOptimizeHuffmanperform huffman table optimization for 8 bits/pixel compression?
pSmoothingFactorsmoothing factor for image compression, 0..100
pForcedBitDepthforced bit depth for image compression, 0 (auto) or 8/12/16
pFragmentSizemaximum fragment size (in kbytes) for compression, 0 for unlimited.
pCreateOffsetTablecreate offset table during image compression?
pSampleFactorssubsampling mode for color image compression
pWriteYBR422flag indicating whether a compressed YBR color stream should be marked as YBR_FULL or YBR_FULL_422 on DICOM level
pConvertToSCflag indicating whether image should be converted to Secondary Capture upon compression
pWindowTypemode for VOI transformation of monochrome images
pWindowParameterparameter for VOI transform of monochrome images, used in modes 1, 2, 4, 6
pVoiCenterVOI window center for mode 5
pVoiWidthVOI window width for mode 5
pRoiLeftRegion of Interest left corner for for VOI transform of monochrome images, mode 7
pRoiTopRegion of Interest upper corner for for VOI transform of monochrome images, mode 7
pRoiWidthRegion of Interest width for for VOI transform of monochrome images, mode 7
pRoiHeightRegion of Interest height for for VOI transform of monochrome images, mode 7
pUsePixelValuescheck smallest and largest pixel value and optimize compression, mode 0 only
pUseModalityRescalecreate Rescale Slope/Intercept to scale back to original pixel range, mode 0 only
pAcceptWrongPaletteTagsaccept wrong palette attribute tags (only "pseudo lossless" encoder)
pAcrNemaCompatibilityaccept old ACR-NEMA images without photometric interpretation (only "pseudo" lossless encoder)
pTrueLosslessModeEnables true lossless compression (replaces old "pseudo lossless" encoder)

Member Function Documentation

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

returns the class name as string.

can be used as poor man's RTTI replacement.

Implements DcmCodecParameter.

virtual DcmCodecParameter* DJCodecParameter::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 DJCodecParameter::getAcceptWrongPaletteTags ( ) const
inline

Returns flag indicating if incorrect palette attribute tags should be accepted.

Returns
flag indicating if incorrect palette attribute tags should be accepted

Definition at line 280 of file djcparam.h.

References acceptWrongPaletteTags.

OFBool DJCodecParameter::getAcrNemaCompatibility ( ) const
inline

Returns flag indicating if compatibility to old ACR-NEMA images without photometric interpretation is enabled.

Returns
flag indicating if ACR-NEMA compatibility is enabled

Definition at line 290 of file djcparam.h.

References acrNemaCompatibility.

E_CompressionColorSpaceConversion DJCodecParameter::getCompressionColorSpaceConversion ( ) const
inline

returns color conversion mode for compression

Returns
color conversion mode for compression

Definition at line 248 of file djcparam.h.

References compressionCSConversion.

OFBool DJCodecParameter::getConvertToSC ( ) const
inline

returns secondary capture conversion flag

Returns
secondary capture conversion flag

Definition at line 180 of file djcparam.h.

References convertToSC.

OFBool DJCodecParameter::getCreateOffsetTable ( ) const
inline

returns offset table creation flag

Returns
offset table creation flag

Definition at line 155 of file djcparam.h.

References createOffsetTable.

E_DecompressionColorSpaceConversion DJCodecParameter::getDecompressionColorSpaceConversion ( ) const
inline

returns color conversion mode for compression

Returns
color conversion mode for compression

Definition at line 256 of file djcparam.h.

References decompressionCSConversion.

int DJCodecParameter::getForcedBitDepth ( ) const
inline

returns forced bit depth for image compression, 0 (auto) or 8/12/16

Returns
forced bit depth for image compression

Definition at line 139 of file djcparam.h.

References forcedBitDepth.

Uint32 DJCodecParameter::getFragmentSize ( ) const
inline

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

fragment size for compression

Definition at line 147 of file djcparam.h.

References fragmentSize.

OFBool DJCodecParameter::getOptimizeHuffmanCoding ( ) const
inline

returns huffman table optimization flag for 8 bits/pixel compression

Returns
huffman table optimization flag for 8 bits/pixel compression

Definition at line 123 of file djcparam.h.

References optimizeHuffman.

E_PlanarConfiguration DJCodecParameter::getPlanarConfiguration ( ) const
inline

returns planar configuration flag

Returns
planar configuration flag

Definition at line 240 of file djcparam.h.

References planarConfiguration.

void DJCodecParameter::getROI ( unsigned long &  left_pos,
unsigned long &  top_pos,
unsigned long &  width,
unsigned long &  height 
) const
inline

returns ROI coordinates for VOI mode 7

Parameters
left_posROI left edge returned in this parameter
top_posROI top edge returned in this parameter
widthROI width returned in this parameter
heightROI height returned in this parameter

Definition at line 225 of file djcparam.h.

References roiHeight, roiLeft, roiTop, and roiWidth.

E_SubSampling DJCodecParameter::getSampleFactors ( ) const
inline

returns subsampling mode for color image compression

Returns
subsampling mode for color image compression

Definition at line 163 of file djcparam.h.

References sampleFactors.

int DJCodecParameter::getSmoothingFactor ( ) const
inline

returns smoothing factor for image compression, 0..100

Returns
smoothing factor for image compression, 0..100

Definition at line 131 of file djcparam.h.

References smoothingFactor.

OFBool DJCodecParameter::getTrueLosslessMode ( ) const
inline

returns flag indicating if real lossless mode is enabled

Returns
flag indicating if real lossless mode is enabled

Definition at line 298 of file djcparam.h.

References trueLosslessMode.

E_UIDCreation DJCodecParameter::getUIDCreation ( ) const
inline

returns mode for SOP Instance UID creation

Returns
mode for SOP Instance UID creation

Definition at line 188 of file djcparam.h.

References uidCreation.

OFBool DJCodecParameter::getUseModalityRescale ( ) const
inline

returns flag indicating if compression should compute Rescale Slope/Intercept

Returns
flag indicating if compression should compute Rescale Slope/Intercept

Definition at line 272 of file djcparam.h.

References useModalityRescale.

OFBool DJCodecParameter::getUsePixelValues ( ) const
inline

returns flag indicating if compression to be optimized for real pixel values

Returns
flag indicating if compression to be optimized for real pixel values

Definition at line 264 of file djcparam.h.

References usePixelValues.

void DJCodecParameter::getVOIWindow ( double &  center,
double &  width 
) const
inline

returns VOI window center and width for VOI mode 5

Parameters
centerVOI center returned in this parameter
widthVOI width returned in this parameter

Definition at line 213 of file djcparam.h.

References voiCenter, and voiWidth.

unsigned long DJCodecParameter::getWindowParameter ( ) const
inline

returns parameter for VOI transform of monochrome images, used in VOI modes 1, 2, 4, 6

Returns
parameter for VOI transform of monochrome images, used in VOI modes 1, 2, 4, 6

Definition at line 204 of file djcparam.h.

References windowParameter.

unsigned long DJCodecParameter::getWindowType ( ) const
inline

returns mode for VOI transformation of monochrome images.

Returns
mode for VOI transformation of monochrome images

Definition at line 196 of file djcparam.h.

References windowType.

OFBool DJCodecParameter::getWriteYBR422 ( ) const
inline

returns flag indicating whether a compressed YBR color stream should be marked as YBR_FULL or YBR_FULL_422 on DICOM level

Returns
YBR422 flag

Definition at line 172 of file djcparam.h.

References writeYBR422.

OFBool DJCodecParameter::predictor6WorkaroundEnabled ( ) const
inline

returns flag indicating whether the workaround for buggy JPEG lossless images with incorrect predictor 6 is enabled

Returns
flag indicating whether the workaround for buggy JPEG lossless images with incorrect predictor 6 is enabled

Definition at line 306 of file djcparam.h.

References predictor6WorkaroundEnabled_.

Member Data Documentation

unsigned long DJCodecParameter::windowType
private

mode for VOI transformation of monochrome images.

possible values: 0: no VOI transformation (default). See also variables usePixelValues (default) or useModalityRescale denoting two further variables tweaking compression behaviour. 1: use the n-th VOI window from the image file (see variable windowType) 2: use the n-th VOI look up table from the image file (see variable windowType) 3: compute VOI window using min-max algorithm 4: compute VOI window using Histogram algorithm, ignoring n percent 5: compute VOI window using center r and width s 6: compute VOI window using min-max algorithm ignoring extremes 7: compute region of interest VOI window

Definition at line 366 of file djcparam.h.

Referenced by getWindowType().


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