MeVisLab Toolbox Reference
mlDcmtkMLConverters.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
5 
11 //----------------------------------------------------------------------------------
12 #ifndef __mlDcmtkMLConverters_H
13 #define __mlDcmtkMLConverters_H
14 
15 #include "MLDcmtkMLConvertersSystem.h"
16 
17 #include <CSOBase/CSOList.h>
18 #include <mlDRTStructureSetIODBase.h>
19 #include <DCMTree_Tree.h>
20 #include <DCMTree_StructuredMF.h>
21 #include "DcmSequenceInterfaces/mlDcmDRTStructureSetROISequenceInterface.h"
22 #include "DcmSequenceInterfaces/mlDcmDRTROIContourSequenceInterface.h"
23 #include "DcmSequenceInterfaces/mlDcmDRTRTROIObservationsSequenceInterface.h"
24 #include "DcmSequenceInterfaces/mlDcmDRTRTDoseROISequenceInterface.h"
25 #include <mlDicomTree.h>
26 #include <string>
27 
28 ML_START_NAMESPACE
29 
30 #define SEQUENCES_ITEM_INTERFACES_IMPLEMENTED
31 
34 typedef void (*progress_callback_t)(MLdouble progress, void* userData);
35 
36 class MultiFileVolume;
37 class RTBase;
38 class DcmDRTStructureSetROISequenceInterface;
39 class DcmDRTROIContourSequenceInterface;
40 class DcmDRTRTROIObservationsSequenceInterface;
41 class DcmDRTRTDoseROISequenceInterface;
42 
43 //----------------------------------------------------------------------------------
45 //----------------------------------------------------------------------------------
46 class MLDCMTKMLCONVERTERS_EXPORT DcmtkMLConverters {
47 
48 public:
49 
50 #ifdef SEQUENCES_ITEM_INTERFACES_IMPLEMENTED
53  static bool convertDRTStructureSetIODBaseToCSOList(CSOList& csoList,
54  DRTStructureSetIODBase& rtStruct,
55  std::string* errVal=NULL,
56  progress_callback_t progressCB = NULL,
57  void* userData = NULL);
58 
62  static bool convertDRTStructureSetROISequenceToCSOList( CSOList& csoList,
63  DcmDRTStructureSetROISequenceInterface* structureSetROISequence,
64  DcmDRTROIContourSequenceInterface* roiContourSequence,
65  DcmDRTRTROIObservationsSequenceInterface* rtRoiObservationSeq,
66  DcmDRTRTDoseROISequenceInterface* rtDoseROISequencePtr=NULL,
67  std::string* errVal=NULL,
68  progress_callback_t progressCB = NULL,
69  void* userData = NULL);
70 
71 
74  static bool convertCSOListToDRTStructureSetIODBase(CSOList& csoList,
75  DRTStructureSetIODBase& rtStruct,
76  std::string* errVal=NULL,
77  progress_callback_t progressCB = NULL,
78  void* userData = NULL);
79 
82  /*
83  static bool convertImageToDRTDoseIODBase(ml::PagedImage* image,
84  DRTDoseIODBase& rtStruct,
85  std::string* errVal=NULL,
86  progress_callback_t progressCB = NULL,
87  void* userData = NULL);
88  */
89 #endif
90 
91 
94  static MultiFileVolume* createVolumeReferenceFromFile( DICOMCachedIOFileHandle filename,
95  std::string* errVal);
96 
97  static void constructNewSMFTreeFor(MultiFileVolume &newVolume,
98  std::string filename,
99  std::string* errVal,
100  DCMTree::StructuredMFPtr altSmfPtr);
101 
102  static void fillImageWithPixelData(MultiFileVolume &newVolume,
103  DCMTree::TreePtr treePtr,
104  std::string*errVal);
105 
114  static RTBase* createRTBaseFromDCMTreeRefCounted(DicomTree *refCountedDCMTree,
115  bool cloneNonConstTree=true,
116  bool alsoUseConstClones=false);
117 
121  template <typename RT_OBJ_TYPE>
122  static inline RT_OBJ_TYPE *createTypedRTObjectFromBase(Base *basePtrVal,
123  bool cloneNonConstTree=true,
124  bool alsoUseConstClones=false)
125  {
126  DicomTree *refCountedInTree = mlbase_cast<DicomTree*>(basePtrVal);
127  RTBase* inputRTBase = createRTBaseFromDCMTreeRefCounted(refCountedInTree, cloneNonConstTree, alsoUseConstClones);
128  return mlbase_cast<RT_OBJ_TYPE*>(inputRTBase);
129  }
130 
131 };
132 
133 ML_END_NAMESPACE
134 
135 #endif // __mlDcmtkMLConverters_H
136 
DCMTree_StructuredMF.h
DCMTree_Tree.h
MLDcmtkMLConvertersSystem.h
Project global and OS specific declarations.
MLDCMTKMLCONVERTERS_EXPORT
#define MLDCMTKMLCONVERTERS_EXPORT
Definition: MLDcmtkMLConvertersSystem.h:24
ml::Base
Class representing general ML objects that support import/export via strings (setPersistentState() an...
Definition: mlBase.h:62
ml::CSOList
A CSOList comprises a number of CSOs and CSOGroups and is the central object for contour segmentation...
Definition: CSOList.h:61
ml::DRTStructureSetIODBase
Base object class for passing DRTStructureSetIOD objects between MeVisLab modules.
Definition: mlDRTStructureSetIODBase.h:71
ml::DcmDRTROIContourSequenceInterface
Class to provide access to DRTROIContourSequence.
Definition: mlDcmDRTROIContourSequenceInterface.h:45
ml::DcmDRTRTDoseROISequenceInterface
Class to provide access to DRTRTDoseROISequence.
Definition: mlDcmDRTRTDoseROISequenceInterface.h:44
ml::DcmDRTRTROIObservationsSequenceInterface
Class to provide access to DRTRTROIObservationsSequence.
Definition: mlDcmDRTRTROIObservationsSequenceInterface.h:48
ml::DcmDRTStructureSetROISequenceInterface
Class to provide access to DRTStructureSetROISequence.
Definition: mlDcmDRTStructureSetROISequenceInterface.h:44
ml::DcmtkMLConverters
The tool function class DcmtkMLConverters.
Definition: mlDcmtkMLConverters.h:46
ml::DcmtkMLConverters::convertDRTStructureSetIODBaseToCSOList
static bool convertDRTStructureSetIODBaseToCSOList(CSOList &csoList, DRTStructureSetIODBase &rtStruct, std::string *errVal=NULL, progress_callback_t progressCB=NULL, void *userData=NULL)
Converts an RTStruct object to a CSOList object and returns true on success, false otherwise.
ml::DcmtkMLConverters::convertDRTStructureSetROISequenceToCSOList
static bool convertDRTStructureSetROISequenceToCSOList(CSOList &csoList, DcmDRTStructureSetROISequenceInterface *structureSetROISequence, DcmDRTROIContourSequenceInterface *roiContourSequence, DcmDRTRTROIObservationsSequenceInterface *rtRoiObservationSeq, DcmDRTRTDoseROISequenceInterface *rtDoseROISequencePtr=NULL, std::string *errVal=NULL, progress_callback_t progressCB=NULL, void *userData=NULL)
Converts an RTStruct object to a CSOList object and returns true on success, false otherwise.
ml::DcmtkMLConverters::createVolumeReferenceFromFile
static MultiFileVolume * createVolumeReferenceFromFile(DICOMCachedIOFileHandle filename, std::string *errVal)
Converts an image object to RTDose object and returns true on success, false otherwise.
ml::DcmtkMLConverters::convertCSOListToDRTStructureSetIODBase
static bool convertCSOListToDRTStructureSetIODBase(CSOList &csoList, DRTStructureSetIODBase &rtStruct, std::string *errVal=NULL, progress_callback_t progressCB=NULL, void *userData=NULL)
Converts a CSOList object to RTStruct object and returns true on success, false otherwise.
ml::DcmtkMLConverters::fillImageWithPixelData
static void fillImageWithPixelData(MultiFileVolume &newVolume, DCMTree::TreePtr treePtr, std::string *errVal)
ml::DcmtkMLConverters::createTypedRTObjectFromBase
static RT_OBJ_TYPE * createTypedRTObjectFromBase(Base *basePtrVal, bool cloneNonConstTree=true, bool alsoUseConstClones=false)
Tries to get a DicomTree from basePtrVal and to convert it to an RT object of type RT_OBJ_TYPE.
Definition: mlDcmtkMLConverters.h:122
ml::DcmtkMLConverters::createRTBaseFromDCMTreeRefCounted
static RTBase * createRTBaseFromDCMTreeRefCounted(DicomTree *refCountedDCMTree, bool cloneNonConstTree=true, bool alsoUseConstClones=false)
Checks the reference counted input tree for a valid RT SOP class UID and creates and returns a corres...
ml::DcmtkMLConverters::constructNewSMFTreeFor
static void constructNewSMFTreeFor(MultiFileVolume &newVolume, std::string filename, std::string *errVal, DCMTree::StructuredMFPtr altSmfPtr)
ml::DicomTree
The DicomTree class can be used to transport a DCMTree::Const_TreePtr as a ml::RefCountedBase object.
Definition: mlDicomTree.h:30
ml::MultiFileVolume
Management class used by DirectDicomImport to create, represent and describe volumes composed of mult...
Definition: mlMultiFileVolume.h:38
ml::RTBase
DcmtkBase derived base object class for base objects that wrap RT related objects.
Definition: mlRTBase.h:34
mlDRTStructureSetIODBase.h
Base object class for passing DRTStructureSetIOD objects between MeVisLab modules.
mlDcmDRTROIContourSequenceInterface.h
Class to provide access to DRTROIContourSequence.
mlDcmDRTRTDoseROISequenceInterface.h
Class to provide access to DRTRTDoseROISequence.
mlDcmDRTRTROIObservationsSequenceInterface.h
Class to provide access to DRTRTROIObservationsSequence.
mlDcmDRTStructureSetROISequenceInterface.h
Class to provide access to DRTStructureSetROISequence.
MLdouble
double MLdouble
Definition: mlTypeDefs.h:223
DCMTree::StructuredMFPtr
boost::shared_ptr< StructuredMF > StructuredMFPtr
Definition: DCMTree_Lib.h:168
DCMTree::TreePtr
boost::shared_ptr< Tree > TreePtr
shared pointer to a DCMTree::Tree
Definition: DCMTree_Lib.h:70
ml::progress_callback_t
void(* progress_callback_t)(MLdouble progress, void *userData)
Callback typedef that can be given to certain function that provide progress information.
Definition: mlDcmtkMLConverters.h:34