Class for managing common image IOD attributes. More...

Inheritance diagram for DcmIODImage<>:

Public Types
typedef DcmIODImage	IODImage
	typedef for old compilers that do not define the type 'DcmIODImage' in derived classes.

typedef IODImagePixelVariant< OFVARIADIC_TEMPLATE_PARAMETER_PACK(T)>	IODImagePixelModuleType
	A good comment would be nice, but I have nothing in mind.

Public Member Functions
	DcmIODImage ()
	Constructor, creates new DcmIODImage instance with integer-based pixel data.

template<typename ImagePixel >
	DcmIODImage (OFin_place_type_t(ImagePixel))
	Constructor, constructs new DcmIODImage instance with integer, float or double based Image Pixel Module (i. More...

virtual	~DcmIODImage ()
	Virtual Destructor.

IODGeneralImageModule &	getGeneralImage ()
	Get General Image Module. More...

IODImagePixelModuleType &	getImagePixel ()
	Get Image Pixel Module (variant) More...

virtual void	clearData ()
	Clear (removes) all attributes handled by the modules of this IOD. More...

virtual OFCondition	read (DcmItem &dataset)
	Read common image module attributes (all those handled by this class) from given item. More...

virtual OFCondition	write (DcmItem &dataset)
	Write current common image module's attributes to DICOM dataset. More...

Public Member Functions inherited from DcmIODCommon
	DcmIODCommon ()
	Constructor.

	DcmIODCommon (const DcmIODCommon &rhs)
	Copy Constructor. More...

OFshared_ptr< IODRules >	getRules ()
	Get rules handled by this IOD. More...

OFshared_ptr< DcmItem >	getData ()
	Get item managed by this IOD. More...

IODPatientModule &	getPatient ()
	Get Patient Module. More...

IODPatientStudyModule &	getPatientStudy ()
	Get Patient Study Module. More...

IODGeneralStudyModule &	getStudy ()
	Get General Study Module. More...

IODGeneralEquipmentModule &	getEquipment ()
	Get General Equipment Module. More...

IODGeneralSeriesModule &	getSeries ()
	Get Series Module. More...

IODFoRModule &	getFrameOfReference ()
	Get Frame of Reference Module. More...

IODSOPCommonModule &	getSOPCommon ()
	Get SOP Common Module. More...

IODCommonInstanceReferenceModule &	getCommonInstanceReference ()
	Get Common Instance Reference Module. More...

virtual	~DcmIODCommon ()
	Destructor.

virtual void	createNewStudy (const OFBool clearEquipment=OFTrue)
	Create new study. More...

virtual void	createNewSeries (const OFBool clearFoR=OFTrue)
	Create a new series. More...

virtual void	createNewSOPInstance ()
	Create a new SOP instance. More...

virtual void	ensureInstanceUIDs (const OFBool correctInvalid=OFFalse)
	Make sure that the IOD contains a SOP Instance, Series Instance and Study Instance UID. More...

virtual OFCondition	importHierarchy (DcmItem &dataset, const OFBool readPatient, const OFBool readStudy, const OFBool readFoR=OFFalse, const OFBool readSeries=OFFalse, const OFBool takeOverCharset=OFTrue)
	Import common module attributes from dataset but only read Patient, Study, Series and/or Frame of Reference level portions. More...

virtual OFCondition	importHierarchy (const OFString &filename, const OFBool readPatient, const OFBool readStudy, const OFBool readFoR=OFFalse, const OFBool readSeries=OFFalse, const OFBool takeOverCharset=OFTrue)
	CAUTION: Parameter order (readFoR and readSeries) changed compared to the old import() function. More...

Private Attributes
IODGeneralImageModule	m_GeneralImage
	General Image Module.

IODImagePixelModuleType	m_ImagePixel
	Image Pixel Module.

Detailed Description

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T)>
class DcmIODImage<>

Class for managing common image IOD attributes.

At the moment support for the palette-related attributes and the smallest/largest image pixel value attributes is still missing. Also, pixel data must be handled separately. However, pixel-data related attributes are provided by the Image Pixel Module, the Floating Point Image Pixel Module or the Double Floating Point Image Pixel Module, based on the provided template parameter. Modules supported on top of DcmIODCommon: General Image Module and Image Pixel Module.

Constructor & Destructor Documentation

◆ DcmIODImage()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T) >

template<typename ImagePixel >

DcmIODImage<>::DcmIODImage ( OFin_place_type_t(ImagePixel) )

inline

Constructor, constructs new DcmIODImage instance with integer, float or double based Image Pixel Module (i.

e. Image Pixel Module, Floating Point Image Pixel Module or the Double Floating Point Image Pixel Module), based on the provided Image Pixel module type.

Member Function Documentation

◆ clearData()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T) >

virtual void DcmIODImage<>::clearData ( )

inlinevirtual

Clear (removes) all attributes handled by the modules of this IOD.

IOD Rules are not reset.

Reimplemented from DcmIODCommon.

Reimplemented in DcmSegmentation, and DPMParametricMapBase.

Referenced by DcmIODImage< IODImagePixelModule< Uint8 > >::read().

◆ getGeneralImage()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T) >

IODGeneralImageModule& DcmIODImage<>::getGeneralImage ( )

inline

Get General Image Module.

Returns: Reference to General Image Module

◆ getImagePixel()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T) >

IODImagePixelModuleType& DcmIODImage<>::getImagePixel ( )

inline

Get Image Pixel Module (variant)

Returns: Reference to Image Pixel Module

◆ read()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T) >

virtual OFCondition DcmIODImage<>::read ( DcmItem & dataset )

inlinevirtual

Read common image module attributes (all those handled by this class) from given item.

Reads attributes from base class DcmIODCommon before. The current content is deleted even if the reading process fails. If the log stream is set and valid the reason for any error might be obtained from the error/warning output.

Parameters

dataset Reference to DICOM dataset from which the document should be read

Returns: EC_Normal if successful, an error code otherwise

Reimplemented from DcmIODCommon.

Reimplemented in DcmSegmentation, DPMParametricMapBase, and DPMParametricMapIOD.

◆ write()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T) >

virtual OFCondition DcmIODImage<>::write ( DcmItem & dataset )

inlinevirtual

Write current common image module's attributes to DICOM dataset.

Also writes attributes of base class DcmIODCommon afterwards.

Parameters

dataset Reference to DICOM dataset to which the current data should be written. The dataset is not cleared before writing to it!

Returns: EC_Normal if successful, an error code otherwise

Reimplemented from DcmIODCommon.

Reimplemented in DcmSegmentation, DPMParametricMapBase, and DPMParametricMapIOD.

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

dcmiod/include/dcmtk/dcmiod/iodimage.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T)> class DcmIODImage<>

Constructor & Destructor Documentation

◆ DcmIODImage()

Member Function Documentation

◆ clearData()

◆ getGeneralImage()

◆ getImagePixel()

◆ read()

◆ write()

template<OFVARIADIC_DECLARE_TEMPLATE_PARAMETER_PACK_WITH_DEFAULTS(T)>
class DcmIODImage<>