DCMTK  Version 3.6.1 20160216
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DcmIODImage Class Reference

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

+ Inheritance diagram for DcmIODImage:

Public Member Functions

 DcmIODImage ()
 Constructor.
 
IODGeneralImageModulegetGeneralImage ()
 Get General Image Module. More...
 
IODImagePixelModulegetImagePixel ()
 Get Image Pixel Module. More...
 
virtual ~DcmIODImage ()
 Virtual Destructor.
 
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.
 
OFshared_ptr< IODRulesgetRules ()
 Get rules handled by this IOD. More...
 
OFshared_ptr< DcmItemgetData ()
 Get item managed by this IOD. More...
 
IODPatientModulegetPatient ()
 Get Patient Module. More...
 
IODPatientStudyModulegetPatientStudy ()
 Get Patient Study Module. More...
 
IODGeneralStudyModulegetStudy ()
 Get General Study Module. More...
 
IODGeneralEquipmentModulegetEquipment ()
 Get General Equipment Module. More...
 
IODGeneralSeriesModulegetSeries ()
 Get Series Module. More...
 
IODFoRModulegetFrameOfReference ()
 Get Frame of Reference Module. More...
 
IODSOPCommonModulegetSOPCommon ()
 Get SOP Common Module. More...
 
IODCommonInstanceReferenceModulegetCommonInstanceReference ()
 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 import (DcmItem &dataset, OFBool readPatient, OFBool readStudy, OFBool readFoR=OFFalse, OFBool readSeries=OFFalse)
 Import common module attributes from dataset but only read Patient, Study, Series and/or Frame of Reference level portions. More...
 

Private Attributes

IODGeneralImageModule m_GeneralImage
 General Image Module.
 
IODImagePixelModule m_ImagePixel
 Image Pixel Module.
 

Detailed Description

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. Modules supported on top of DcmIODCommon: General Image Module and Image Pixel Module.

Member Function Documentation

virtual void DcmIODImage::clearData ( )
virtual

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

IOD Rules are not reset.

Reimplemented from DcmIODCommon.

Reimplemented in DcmSegmentation.

IODGeneralImageModule& DcmIODImage::getGeneralImage ( )

Get General Image Module.

Returns
Reference to General Image Module
IODImagePixelModule& DcmIODImage::getImagePixel ( )

Get Image Pixel Module.

Returns
Reference to Image Pixel Module

Referenced by DcmSegmentation::getSegmentationFractionalType().

virtual OFCondition DcmIODImage::read ( DcmItem dataset)
virtual

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
datasetReference 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.

Referenced by DcmSegmentation::getSegmentationFractionalType().

virtual OFCondition DcmIODImage::write ( DcmItem dataset)
virtual

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

Also writes attributes of base class DcmIODCommon afterwards.

Parameters
datasetReference to DICOM dataset to which the current document 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.

Referenced by DcmSegmentation::getSegmentationFractionalType().


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


Generated on Sun Jul 3 2016 for DCMTK Version 3.6.1 20160216 by Doxygen 1.8.11