MeVisLab Toolbox Reference
mlMultiFileVolumeListPROutput.h
Go to the documentation of this file.
1 // Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
2 // **InsertLicense** code
3 //----------------------------------------------------------------------------------
6 
13 
14 //----------------------------------------------------------------------------------
15 
16 #ifndef __mlMultiFileVolumeListPROutput_H
17 #define __mlMultiFileVolumeListPROutput_H
18 
19 
20 // Local includes
22 
23 // Base class of output module.
25 
26 // ML includes
27 #include <mlModuleIncludes.h>
28 
29 // base object wrapping a structured reporting document.
31 
32 // Forward to internally used classes.
33 class DVPresentationState;
34 
44 //#define _ENABLE_PRS_IMAGE_RENDERING
45 
46 ML_START_NAMESPACE
47 
48 // Forward to internally used classes.
49 class MultiFileVolume;
50 
51 //----------------------------------------------------------------------------------
54 //----------------------------------------------------------------------------------
56 {
57 public:
58 
60 #if defined(_ENABLE_PRS_IMAGE_RENDERING)
61  MultiFileVolumeListPROutput(int numInputs=0, int numOutputs=1);
62 #else
63  MultiFileVolumeListPROutput(int numInputs=0, int numOutputs=0);
64 #endif
65 
68 
69 protected:
70 
71 #if defined(_ENABLE_PRS_IMAGE_RENDERING)
73  virtual void calculateOutputImageProperties (int outIndex, PagedImage* outImg) override;
74 
80  virtual void calculateOutputSubImage (SubImage *outSubImg, int outIndex, SubImage *inSubImgs) override;
81 #endif
82 
85  virtual void _updateVolumeInformation(MultiFileVolume *currVol) override;
86 
88  virtual void _setInfosFromFile(const std::string &dcmFileName, std::string infoString);
89 
90  // Extraction methods:
92  virtual void _retrieveGeneralState(std::ostringstream &_str, DVPresentationState &dprState);
93 
94 #if 0
96  virtual void _retrieveOtherInformation(std::ostringstream &_str, DVPresentationState &dprState);
97 #endif
99  virtual void _retrieveOverlaysInPresentationState(std::ostringstream &_str, DVPresentationState &dprState);
100 
102  virtual void _retrieveOverlaysInImage(std::ostringstream &_str, DVPresentationState &dprState);
103 
105  virtual void _retrieveImageReferences(std::ostringstream &_str, DVPresentationState &dprState);
106 
108  virtual void _retrieveGraphicLayers(std::ostringstream &_str, DVPresentationState &dprState);
109 
111  virtual void _retrieveGraphicLayerGeneralInformation(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay);
112 
114  virtual void _retrieveGraphicLayerTextObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay);
115 
117  virtual void _retrieveGraphicLayerGraphicObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay);
118 
120  virtual void _retrieveGraphicLayerCurveObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay);
121 
123  virtual void _retrieveGraphicLayerActiveOverlayObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay);
124 
125 #if defined(_ENABLE_PRS_IMAGE_RENDERING)
128  virtual std::string _applyPRToImage(const MultiFileVolume &currVol);
129 #endif
130 
131 private:
132 
134  StringField *_infoStringFld;
135 
137  BaseField *_presentationStateObjectFld;
138 
140  PresentationState *_presentationStateObject;
141 
143  const std::string _IRefIndent;
144 
146  const size_t _NumIndentChars;
147 
150  NotifyField *_updatePROutputInformationDoneFld;
151 
152 #if defined(_ENABLE_PRS_IMAGE_RENDERING)
154  SubImage _outputImage;
155 #endif
156 
159 
160 };
161 
162 
163 ML_END_NAMESPACE
164 
165 #endif // __mlMultiFileVolumeListPROutput_H
166 
Project global and OS specific declarations.
#define ML_MULTIFILE_VOLUME_LIST_DCMTK_OUTPUTS_EXPORT
DLL export macro definition.
Field to encapsulate a pointer to an ML base object.
Definition: mlFields.h:1187
virtual void calculateOutputImageProperties(int outputIndex, PagedImage *)
Set properties of output image outputImage with output index outputIndex.
Definition: mlModule.h:600
virtual void calculateOutputSubImage(SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages)
Calculate page outputSubImage of output image with index outputIndex given the input image tiles in a...
The ML module base class MultiFileVolumeListBaseOutput used to implement further output modules for t...
The ML module class MultiFileVolumeListPROutput provides additional outputs for structured reporting ...
virtual void _retrieveOverlaysInPresentationState(std::ostringstream &_str, DVPresentationState &dprState)
Retrieves OverlaysInPresentationState information into the passed stream.
virtual void _retrieveGraphicLayerActiveOverlayObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay)
Retrieves ActiveOverlayObject information from Graphic Layer iGLay into the passed stream.
virtual void _setInfosFromFile(const std::string &dcmFileName, std::string infoString)
Retrieve all information from give DICOM file name and set it in _infoStringFld.
virtual void _retrieveGraphicLayerCurveObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay)
Retrieves VurveObject information from Graphic Layer iGLay into the passed stream.
virtual void _retrieveGraphicLayers(std::ostringstream &_str, DVPresentationState &dprState)
Retrieves GrapicLayer information into the passed stream.
virtual void _retrieveGraphicLayerTextObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay)
Retrieves TextObject information from Graphic Layer iGLay into the passed stream.
virtual ~MultiFileVolumeListPROutput()
Destructor.
virtual void _retrieveGeneralState(std::ostringstream &_str, DVPresentationState &dprState)
Retrieves general information into the passed stream.
virtual void _retrieveOverlaysInImage(std::ostringstream &_str, DVPresentationState &dprState)
Retrieves OverlaysInImage information into the passed stream.
virtual void _updateVolumeInformation(MultiFileVolume *currVol) override
This is called by the super class if the volume has changed.
virtual void _retrieveGraphicLayerGraphicObjects(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay)
Retrieves GraphicObject information from Graphic Layer iGLay into the passed stream.
virtual void _retrieveImageReferences(std::ostringstream &_str, DVPresentationState &dprState)
Retrieves ImageReferences information into the passed stream.
MultiFileVolumeListPROutput(int numInputs=0, int numOutputs=0)
Constructor.
virtual void _retrieveGraphicLayerGeneralInformation(std::ostringstream &_str, DVPresentationState &dprState, size_t iGLay)
Retrieves general information from Graphic Layer iGLay into the passed stream.
Management class used by DirectDicomImport to create, represent and describe volumes composed of mult...
Field without value for notifications.
Definition: mlFields.h:1049
Class which represents an image, which manages properties of an image and image data which is located...
Definition: mlPagedImage.h:70
Base object class for passing DVPresentationState objects between MeVisLab modules.
Field to encapsulate a string value.
Definition: mlFields.h:1000
This class manages/represents a rectangular 6d image region which is organized linearly in memory.
Definition: mlSubImage.h:75
#define ML_MODULE_CLASS_HEADER(className)
Like ML_CLASS_HEADER for the usage of derived classes from Module.
Provides the base class for an additional output for a MultiFileVolumeList module.
Base object class for passing DICOM presentation states between MeVisLab modules.