SDK/ToolBoxReference/mlDicomREGSave_8h_source.html

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.

// **InsertLicense** code

//----------------------------------------------------------------------------------


//----------------------------------------------------------------------------------

#pragma once


// Local includes

#include "MLDicomOutputsSystem.h"


#include <mlModuleIncludes.h>

#include <mlDicomSaveBase.h>

#include <DicomTagInterfaces/mlDicomPatientModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomGeneralStudyModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomGeneralSeriesModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomFrameOfReferenceModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomGeneralEquipmentModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomContentDateTimeTagInterface.h>

#include <DicomTagInterfaces/mlDicomContentIdentificationMacroTagInterface.h>

#include <DicomTagInterfaces/mlDicomDeformableSpatialRegistrationModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomCommonInstanceReferenceModuleTagInterface.h>

#include <DicomTagInterfaces/mlDicomReferencedImageSequenceTagInterface.h>

#include <DicomTagInterfaces/mlDicomSOPCommonModuleTagInterface.h>


// DICOM tree etc.

#include <DCMTree_Tree.h>


ML_START_NAMESPACE


//----------------------------------------------------------------------------------

// See above.

//----------------------------------------------------------------------------------


class MLDICOMOUTPUTS_EXPORT DicomREGSave : public DicomSaveBase

{

public:


  DicomREGSave();


protected:


  void        handleNotification(Field *field) override;


  std::string _checkConsistency() const override;


  void        _inheritFieldValuesFromDCMTree(DCMTree::Const_TreePtr dcmTree) override;


  void        _updateInputState() override;


  void        _removeUndesiredInputTags(DCMTree::TreePtr resultTree) const;


  std::string _setUpTreeContent() override;


  DicomPatientModuleTagInterface                       _patientTags;


  DicomGeneralStudyModuleTagInterface                  _generalStudyTags;


  DicomGeneralSeriesModuleTagInterface                 _generalSeriesTags;


  DicomFrameOfReferenceModuleTagInterface              _frameOfReferenceTags;


  DicomGeneralEquipmentModuleTagInterface              _generalAndEnhancedGeneralEquipmentTags;


  DicomContentDateTimeTagInterface                     _contentDateTimeTags;


  DicomContentIdentificationMacroTagInterface          _contentIdentificationMacro;


  DicomDeformableSpatialRegistrationModuleTagInterface _deformableSpatialRegistrationModule;


  DicomReferencedImageSequenceTagInterface             _referencedImageSequence;


  DicomCommonInstanceReferenceModuleTagInterface       _commonInstanceReferenceModuleTags;


  DicomSOPCommonModuleTagInterface                     _sopCommonModuleTags;


  ML_MODULE_CLASS_HEADER(DicomREGSave);

};


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:21

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
Definition mlDicomREGSave.h:52

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::DicomSaveBase
Definition mlDicomSaveBase.h:51

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.

mlModuleIncludes.h

mlrange_cast
Target mlrange_cast(Source arg)
Generic version of checked ML casts.
Definition mlRangeCasts.h:332

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:72