MeVisLab Toolbox Reference
mlDicomREGSave.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
5 
23 //----------------------------------------------------------------------------------
24 #pragma once
25 
26 // Local includes
27 #include "MLDicomOutputsSystem.h"
28 
29 #include <mlModuleIncludes.h>
30 #include <mlDicomSaveBase.h>
31 #include <DicomTagInterfaces/mlDicomPatientModuleTagInterface.h>
32 #include <DicomTagInterfaces/mlDicomGeneralStudyModuleTagInterface.h>
33 #include <DicomTagInterfaces/mlDicomGeneralSeriesModuleTagInterface.h>
34 #include <DicomTagInterfaces/mlDicomFrameOfReferenceModuleTagInterface.h>
35 #include <DicomTagInterfaces/mlDicomGeneralEquipmentModuleTagInterface.h>
36 #include <DicomTagInterfaces/mlDicomContentDateTimeTagInterface.h>
37 #include <DicomTagInterfaces/mlDicomContentIdentificationMacroTagInterface.h>
38 #include <DicomTagInterfaces/mlDicomDeformableSpatialRegistrationModuleTagInterface.h>
39 #include <DicomTagInterfaces/mlDicomCommonInstanceReferenceModuleTagInterface.h>
40 #include <DicomTagInterfaces/mlDicomReferencedImageSequenceTagInterface.h>
41 #include <DicomTagInterfaces/mlDicomSOPCommonModuleTagInterface.h>
42 
43 // DICOM tree etc.
44 #include <DCMTree_Tree.h>
45 
46 ML_START_NAMESPACE
47 
48 //----------------------------------------------------------------------------------
49 // See above.
50 //----------------------------------------------------------------------------------
51 class MLDICOMOUTPUTS_EXPORT DicomREGSave : public DicomSaveBase
52 {
53 public:
54 
56  DicomREGSave();
57 
58 protected:
59 
61  void handleNotification(Field *field) override;
62 
65  std::string _checkConsistency() const override;
66 
68  void _inheritFieldValuesFromDCMTree(DCMTree::Const_TreePtr dcmTree) override;
69 
72  void _updateInputState() override;
73 
75  void _removeUndesiredInputTags(DCMTree::TreePtr resultTree) const;
76 
79  std::string _setUpTreeContent() override;
80 
82  DicomPatientModuleTagInterface _patientTags;
83 
85  DicomGeneralStudyModuleTagInterface _generalStudyTags;
86 
90  DicomGeneralSeriesModuleTagInterface _generalSeriesTags;
91 
93  DicomFrameOfReferenceModuleTagInterface _frameOfReferenceTags;
94 
97  DicomGeneralEquipmentModuleTagInterface _generalAndEnhancedGeneralEquipmentTags;
98 
100  DicomContentDateTimeTagInterface _contentDateTimeTags;
101 
103  DicomContentIdentificationMacroTagInterface _contentIdentificationMacro;
104 
108  DicomDeformableSpatialRegistrationModuleTagInterface _deformableSpatialRegistrationModule;
109 
111  DicomReferencedImageSequenceTagInterface _referencedImageSequence;
112 
114  DicomCommonInstanceReferenceModuleTagInterface _commonInstanceReferenceModuleTags;
115 
117  DicomSOPCommonModuleTagInterface _sopCommonModuleTags;
118 
120  ML_MODULE_CLASS_HEADER(DicomREGSave);
121 };
122 
123 ML_END_NAMESPACE
DCMTree_Tree.h
MLDicomOutputsSystem.h
Project global and OS specific declarations.
MLDICOMOUTPUTS_EXPORT
#define MLDICOMOUTPUTS_EXPORT
DLL export macro definition.
Definition: MLDicomOutputsSystem.h:19
ml::DicomCommonInstanceReferenceModuleTagInterface
Manages the module field interface according to Common Instance Reference Module in DICOM Part 3.
Definition: mlDicomCommonInstanceReferenceModuleTagInterface.h:23
ml::DicomContentDateTimeTagInterface
Manages the module field interface according to DICOM ContentDate and ContentTime tags.
Definition: mlDicomContentDateTimeTagInterface.h:23
ml::DicomContentIdentificationMacroTagInterface
Manages the module field interface according to DICOM Content Identification macro,...
Definition: mlDicomContentIdentificationMacroTagInterface.h:22
ml::DicomDeformableSpatialRegistrationModuleTagInterface
Manages the module field interface according to DICOM Deformable Spatial Registration C....
Definition: mlDicomDeformableSpatialRegistrationModuleTagInterface.h:23
ml::DicomFrameOfReferenceModuleTagInterface
Manages the module field interface for the DICOM Frame Of Reference Module.
Definition: mlDicomFrameOfReferenceModuleTagInterface.h:22
ml::DicomGeneralEquipmentModuleTagInterface
Manages the module field interface according to DICOM General Equipment, C.7.5.1.
Definition: mlDicomGeneralEquipmentModuleTagInterface.h:25
ml::DicomGeneralSeriesModuleTagInterface
Manages the module field interface according to DICOM General Series, C.7.3.1.
Definition: mlDicomGeneralSeriesModuleTagInterface.h:24
ml::DicomGeneralStudyModuleTagInterface
Manages the module field interface according to DICOM General Study, C.7.1.3.
Definition: mlDicomGeneralStudyModuleTagInterface.h:23
ml::DicomPatientModuleTagInterface
Manages the module field interface according to DICOM Patient Module, C.7.1.1.
Definition: mlDicomPatientModuleTagInterface.h:23
ml::DicomREGSave::DicomREGSave
DicomREGSave()
Constructor.
ml::DicomREGSave::_updateInputState
void _updateInputState() override
Overwrites base class and sets up additional stuff in _commonInstanceReferenceModuleTags and _deforma...
ml::DicomREGSave::_generalStudyTags
DicomGeneralStudyModuleTagInterface _generalStudyTags
General Study tags, C.7.2.1, mandatory for A.39.2.3 Deformable Spatial Registration IOD Module.
Definition: mlDicomREGSave.h:85
ml::DicomREGSave::_checkConsistency
std::string _checkConsistency() const override
Checks for invalid parameters and return a textual description of the error if there is any,...
ml::DicomREGSave::_patientTags
DicomPatientModuleTagInterface _patientTags
Patient information tags, C.7.1.1., mandatory for A.39.2.3 Deformable Spatial Registration IOD Module...
Definition: mlDicomREGSave.h:82
ml::DicomREGSave::ML_MODULE_CLASS_HEADER
ML_MODULE_CLASS_HEADER(DicomREGSave)
Implements interface for the runtime type system of the ML.
ml::DicomREGSave::_contentIdentificationMacro
DicomContentIdentificationMacroTagInterface _contentIdentificationMacro
Content Identification macro, 10.9 (needed as mandatory part of Deformable Spatial Registration Modul...
Definition: mlDicomREGSave.h:103
ml::DicomREGSave::_frameOfReferenceTags
DicomFrameOfReferenceModuleTagInterface _frameOfReferenceTags
Frame Of Reference tags, C.7.4.1, mandatory for A.39.2.3 Deformable Spatial Registration IOD Module.
Definition: mlDicomREGSave.h:93
ml::DicomREGSave::handleNotification
void handleNotification(Field *field) override
Handles field changes of the field field.
ml::DicomREGSave::_contentDateTimeTags
DicomContentDateTimeTagInterface _contentDateTimeTags
ContentDate and ContentTime tags (needed as mandatory part of Deformable Spatial Registration Module ...
Definition: mlDicomREGSave.h:100
ml::DicomREGSave::_generalSeriesTags
DicomGeneralSeriesModuleTagInterface _generalSeriesTags
General Series tags, C.7.3.1, mandatory for A.39.2.3 Deformable Spatial Registration IOD Module.
Definition: mlDicomREGSave.h:90
ml::DicomREGSave::_removeUndesiredInputTags
void _removeUndesiredInputTags(DCMTree::TreePtr resultTree) const
Remove tags from tree which could disturb the correct interpretation of the written DICOM file.
ml::DicomREGSave::_inheritFieldValuesFromDCMTree
void _inheritFieldValuesFromDCMTree(DCMTree::Const_TreePtr dcmTree) override
Overloads base class field inheritance and adds the additional tags needed by this class.
ml::DicomREGSave::_commonInstanceReferenceModuleTags
DicomCommonInstanceReferenceModuleTagInterface _commonInstanceReferenceModuleTags
Common Instance Reference, C.12.2, mandatory for A.39.2.3 Deformable Spatial Registration IOD Module.
Definition: mlDicomREGSave.h:114
ml::DicomREGSave::_deformableSpatialRegistrationModule
DicomDeformableSpatialRegistrationModuleTagInterface _deformableSpatialRegistrationModule
Deformable Spatial Registration Module C.20.3, without ContentDate, ContentTime, and ContentIdentific...
Definition: mlDicomREGSave.h:108
ml::DicomREGSave::_setUpTreeContent
std::string _setUpTreeContent() override
Set the REG DICOM tags in the tree.
ml::DicomREGSave::_referencedImageSequence
DicomReferencedImageSequenceTagInterface _referencedImageSequence
ReferencedImageSequence according to Deformable Spatial Registration Module C.20.3.
Definition: mlDicomREGSave.h:111
ml::DicomREGSave::_generalAndEnhancedGeneralEquipmentTags
DicomGeneralEquipmentModuleTagInterface _generalAndEnhancedGeneralEquipmentTags
General Equipment tags, C.7.5.1, and C.2.2, Enhanced General Equipment, C.5.2, both mandatory for A....
Definition: mlDicomREGSave.h:97
ml::DicomREGSave::_sopCommonModuleTags
DicomSOPCommonModuleTagInterface _sopCommonModuleTags
SOP Common C.12.1, mandatory for A.39.2.3 Deformable Spatial Registration IOD Module.
Definition: mlDicomREGSave.h:117
ml::DicomReferencedImageSequenceTagInterface
Manages the module field interface according to Common Instance Reference Module in DICOM Part 3.
Definition: mlDicomReferencedImageSequenceTagInterface.h:23
ml::DicomSOPCommonModuleTagInterface
Manages the module field interface according to SOP Common Module shown in DICOM Table 12-1.
Definition: mlDicomSOPCommonModuleTagInterface.h:24
ml::Field
Base class for all fields used in the ML.
Definition: mlField.h:73
mlDicomCommonInstanceReferenceModuleTagInterface.h
Header file for the tag interface which manages the Common Instance Reference Module in DICOM Part 3.
mlDicomContentDateTimeTagInterface.h
Header file for the ML module base class DicomContentDateTimeTagInterface.
mlDicomContentIdentificationMacroTagInterface.h
Header file for the ML module base class DicomContentIdentificationMacroTagInterface.
mlDicomDeformableSpatialRegistrationModuleTagInterface.h
Header file for the ML module base class DicomDeformableSpatialRegistrationModuleTagInterface.
mlDicomFrameOfReferenceModuleTagInterface.h
Header file for the tag interface for the Frame Of Reference Module, C.7-6.
mlDicomGeneralEquipmentModuleTagInterface.h
Header file for the ML module base class DicomGeneralEquipmentModuleTagInterface.
mlDicomGeneralSeriesModuleTagInterface.h
Header file for the ML module base class DicomGeneralSeriesModuleTagInterface.
mlDicomGeneralStudyModuleTagInterface.h
Header file for the ML module base class DicomGeneralStudyModuleTagInterface.
mlDicomPatientModuleTagInterface.h
Header file for the ML module base class DicomPatientModuleTagInterface.
mlDicomReferencedImageSequenceTagInterface.h
Header file for the tag interface which manages the Referenced Image Sequence in DICOM Part 3.
mlDicomSOPCommonModuleTagInterface.h
Header file for the tag interface for the SOP Common Module shown as in DICOM Table 12-1.
mlDicomSaveBase.h
Header file for the ML module base class DicomSaveBase.
DCMTree::Const_TreePtr
boost::shared_ptr< const Tree > Const_TreePtr
Definition: DCMTree_Lib.h:73
DCMTree::TreePtr
boost::shared_ptr< Tree > TreePtr
shared pointer to a DCMTree::Tree
Definition: DCMTree_Lib.h:70