DCMTK Version 3.6.8
OFFIS DICOM Toolkit
|
Interface class to those modules and data attributes are common for many DICOM IODs. More...
Public Member Functions | |
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 | clearData () |
Clear (removes) all attributes handled by the modules of this IOD. More... | |
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 | read (DcmItem &dataset) |
Read data into this class. 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... | |
virtual OFCondition | write (DcmItem &dataset) |
Write the attributes managed by this class to DICOM dataset. More... | |
Private Member Functions | |
DcmIODCommon & | operator= (const DcmIODCommon &rhs) |
Copy assignment disabled. More... | |
Private Attributes | |
OFshared_ptr< DcmItem > | m_Item |
The data hold by this class (shared with modules below) | |
OFshared_ptr< IODRules > | m_Rules |
The rules hold by this class (shared with modules below) | |
IODPatientModule | m_Patient |
Patient Module. | |
IODPatientStudyModule | m_PatientStudy |
Patient Study Module. | |
IODGeneralStudyModule | m_Study |
General Study Module. | |
IODGeneralEquipmentModule | m_Equipment |
General Equipment Module. | |
IODGeneralSeriesModule | m_Series |
General Series Module. | |
IODFoRModule | m_FrameOfReference |
Frame of Reference Module. | |
IODSOPCommonModule | m_SOPCommon |
SOP Common Module. | |
IODCommonInstanceReferenceModule | m_CommonInstanceReferenceModule |
Common Instance Reference Module. | |
OFVector< IODModule * > | m_Modules |
Collects all modules of this class for convenience (iteration) | |
Interface class to those modules and data attributes are common for many DICOM IODs.
The class offers a dedicated API for getting and settings those attributes. Modules included: Patient Module, General Study Module, General Equipment Module, General Series Module, Frame of Reference Module, SOP Common Module.
DcmIODCommon::DcmIODCommon | ( | const DcmIODCommon & | rhs | ) |
Copy Constructor.
rhs | The object to copy from |
|
virtual |
Clear (removes) all attributes handled by the modules of this IOD.
IOD Rules are not reset.
Reimplemented in DcmIODImage<>, DcmIODImage< IODImagePixelModule< Uint16 >, IODImagePixelModule< Sint16 >, IODFloatingPointImagePixelModule, IODDoubleFloatingPointImagePixelModule >, DcmIODImage< IODImagePixelModule< Uint8 > >, DcmIODImage< IODImagePixelModule< Uint16 >, IODImagePixelModule< Sint16 > >, DPMParametricMapBase, DcmSegmentation, and TrcTractographyResults.
Referenced by DcmIODImage<>::clearData().
|
virtual |
Create a new series.
After generating a new Series Instance UID the method createNewSOPInstance() is called, i.e. Series-related attributes managed by the series-level modules of this class are cleared, as well as instance-level data.
clearFoR | If OFTrue (default), also the frame of reference is cleared (FoR Module) |
|
virtual |
Create a new SOP instance.
Generate a new SOP Instance UID and set the Instance Creation Date/Time to the current date and time. It could be used explicitly from the calling application if a new UID should be created (this is the case if the Study Instance UID or Series Instance UID has changed as well as any other attribute on the instance level, e.g. image pixel data). Also clears other instance related data.
|
virtual |
Create new study.
After generating a new Study Instance UID the method createNewSeries() is called, i.e. also a new Series Instance UID and SOP instance UID are generated. This is a requirement of the DICOM standard. All other study-related attributes from the study-level modules managed by this class are cleared (as well as Series and Instance level attributes).
clearEquipment | If OFTrue (default), also the equipment information is cleared (General Equipment Module)) |
|
virtual |
Make sure that the IOD contains a SOP Instance, Series Instance and Study Instance UID.
They are created if empty. Invalid UIDs are corrected if desired.
correctInvalid | If OFTrue, invalid instance UIDs will be replaced by new ones |
IODCommonInstanceReferenceModule & DcmIODCommon::getCommonInstanceReference | ( | ) |
Get Common Instance Reference Module.
OFshared_ptr< DcmItem > DcmIODCommon::getData | ( | ) |
Get item managed by this IOD.
IODGeneralEquipmentModule & DcmIODCommon::getEquipment | ( | ) |
Get General Equipment Module.
IODFoRModule & DcmIODCommon::getFrameOfReference | ( | ) |
Get Frame of Reference Module.
IODPatientModule & DcmIODCommon::getPatient | ( | ) |
Get Patient Module.
IODPatientStudyModule & DcmIODCommon::getPatientStudy | ( | ) |
Get Patient Study Module.
OFshared_ptr< IODRules > DcmIODCommon::getRules | ( | ) |
Get rules handled by this IOD.
IODGeneralSeriesModule & DcmIODCommon::getSeries | ( | ) |
Get Series Module.
IODSOPCommonModule & DcmIODCommon::getSOPCommon | ( | ) |
Get SOP Common Module.
IODGeneralStudyModule & DcmIODCommon::getStudy | ( | ) |
Get General Study Module.
|
virtual |
CAUTION: Parameter order (readFoR and readSeries) changed compared to the old import() function.
Import common module attributes from DICOM file but only read Patient, Study, Series and/or Frame of Reference level portions. The current content is not deleted before reading. If the log stream is set and valid the reason for any error might be obtained from the error/warning output.
filename | The filename to read from. |
readPatient | Read Patient-level information if OFTrue |
readStudy | Read Study-level information if OFTrue, including equipment module |
readFoR | Read Frame of Reference information if OFTrue. See also readSeries parameter. |
readSeries | Read Series-level information if OFTrue, always includes Frame of Reference, i.e. readFoR is considered to be OFTrue |
takeOverCharset | If OFTrue (default), Specific Character Set is taken over from imported dataset. If it's not present or empty (invalid), the attribute will not be present in this class either. |
|
virtual |
Import common module attributes from dataset but only read Patient, Study, Series and/or Frame of Reference level portions.
The current content is not deleted before reading. If the log stream is set and valid the reason for any error might be obtained from the error/warning output.
dataset | Reference to DICOM dataset from which the document should be read |
readPatient | Read Patient-level information if OFTrue |
readStudy | Read Study-level information if OFTrue, including equipment module |
readFoR | Read Frame of Reference information if OFTrue. See also readSeries parameter. |
readSeries | Read Series-level information if OFTrue, always includes Frame of Reference, i.e. readFoR is considered to be OFTrue |
takeOverCharset | If OFTrue (default), Specific Character Set is taken over from imported dataset. If it's not present or empty (invalid), the attribute will not be present in this class either. |
|
private |
Copy assignment disabled.
rhs | Object to copy from |
|
virtual |
Read data into this class.
Please note that the current content is also deleted 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. The reading process will ignore missing attributes or values as possible in order to read as as much as possible.
dataset | DICOM dataset from which the document should be read |
Reimplemented in EctEnhancedCT, DcmIODImage<>, DcmIODImage< IODImagePixelModule< Uint16 >, IODImagePixelModule< Sint16 >, IODFloatingPointImagePixelModule, IODDoubleFloatingPointImagePixelModule >, DcmIODImage< IODImagePixelModule< Uint8 > >, DcmIODImage< IODImagePixelModule< Uint16 >, IODImagePixelModule< Sint16 > >, DPMParametricMapBase, DPMParametricMapIOD, DcmSegmentation, and TrcTractographyResults.
Referenced by DcmIODImage<>::read().
|
virtual |
Write the attributes managed by this class to DICOM dataset.
dataset | Reference to DICOM dataset to which the current document should be written. The dataset is not cleared before writing to it. |
Reimplemented in EctEnhancedCT, DcmIODImage<>, DcmIODImage< IODImagePixelModule< Uint16 >, IODImagePixelModule< Sint16 >, IODFloatingPointImagePixelModule, IODDoubleFloatingPointImagePixelModule >, DcmIODImage< IODImagePixelModule< Uint8 > >, DcmIODImage< IODImagePixelModule< Uint16 >, IODImagePixelModule< Sint16 > >, DPMParametricMapBase, DPMParametricMapIOD, and TrcTractographyResults.
Referenced by DcmIODImage<>::write().