DCMTK  Version 3.6.7
OFFIS DICOM Toolkit
Static Public Member Functions | Static Private Attributes | List of all members
DJEncoderRegistration Class Reference

singleton class that registers encoders for all supported JPEG processes. More...

Static Public Member Functions

static void registerCodecs (E_CompressionColorSpaceConversion pCompressionCSConversion=ECC_lossyYCbCr, E_UIDCreation pCreateSOPInstanceUID=EUC_default, OFBool pOptimizeHuffman=OFFalse, int pSmoothingFactor=0, int pForcedBitDepth=0, Uint32 pFragmentSize=0, OFBool pCreateOffsetTable=OFTrue, E_SubSampling pSampleFactors=ESS_422, OFBool pWriteYBR422=OFTrue, 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 pRealLossless=OFTrue)
 registers encoders for all supported JPEG processes. More...
 
static void cleanup ()
 deregisters encoders. More...
 

Static Private Attributes

static OFBool registered
 flag indicating whether the encoders are already registered.
 
static DJCodecParametercp
 pointer to codec parameter shared by all encoders
 
static DJEncoderBaselineencbas
 pointer to encoder for baseline JPEG
 
static DJEncoderExtendedencext
 pointer to encoder for extended JPEG
 
static DJEncoderSpectralSelectionencsps
 pointer to encoder for spectral selection JPEG
 
static DJEncoderProgressiveencpro
 pointer to encoder for progressive JPEG
 
static DJEncoderP14SV1encsv1
 pointer to encoder for lossless SV1 JPEG
 
static DJEncoderLosslessenclol
 pointer to encoder for lossless JPEG
 

Detailed Description

singleton class that registers encoders for all supported JPEG processes.

Member Function Documentation

◆ cleanup()

static void DJEncoderRegistration::cleanup ( )
static

deregisters encoders.

Attention: Must not be called while other threads might still use the registered codecs, e.g. because they are currently encoding DICOM data sets through dcmdata.

◆ registerCodecs()

static void DJEncoderRegistration::registerCodecs ( E_CompressionColorSpaceConversion  pCompressionCSConversion = ECC_lossyYCbCr,
E_UIDCreation  pCreateSOPInstanceUID = EUC_default,
OFBool  pOptimizeHuffman = OFFalse,
int  pSmoothingFactor = 0,
int  pForcedBitDepth = 0,
Uint32  pFragmentSize = 0,
OFBool  pCreateOffsetTable = OFTrue,
E_SubSampling  pSampleFactors = ESS_422,
OFBool  pWriteYBR422 = OFTrue,
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  pRealLossless = OFTrue 
)
static

registers encoders for all supported JPEG processes.

If already registered, call is ignored unless cleanup() has been performed before.

Parameters
pCompressionCSConversioncolor conversion mode for compression
pCreateSOPInstanceUIDmode for SOP Instance UID creation
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 lossy YCbCr color image compression
pWriteYBR422flag indicating whether a compressed YBR color stream should be marked as YBR_FULL_422 (if true) or YBR_FULL (if false) 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)
pRealLosslessEnables true lossless compression (replaces old "pseudo" lossless encoders)

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


Generated on Thu Apr 28 2022 for DCMTK Version 3.6.7 by Doxygen 1.9.1