MeVisLab Toolbox Reference
ml::DicomEnhancedSave Class Reference

#include <mlDicomEnhancedSave.h>

Inheritance diagram for ml::DicomEnhancedSave:
ml::DicomSaveBase ml::Module ml::FieldContainer ml::Base

Public Types

enum  { NumSupportedIODs = 1 }
 Number of supported IODs. More...
 
enum  SupportedIODs { LegacyConvertedEnhancedMR = 0 }
 Enumerators for supported IODs. More...
 
- Public Types inherited from ml::Module
enum  PERMITTED_TYPES {
  ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , ALL_REGISTERED_TYPES , ONLY_STANDARD_TYPES = ONLY_SCALAR_TYPES ,
  FULLY_OPERATIONAL = ONLY_DEFAULT_TYPES , MINIMUM_OPERATIONAL = ALL_REGISTERED_TYPES
}
 See documentation of setVoxelDataTypeSupport. More...
 
enum  INPUT_STATE { DISCONNECTED = 0 , CONNECTED_BUT_INVALID = 1 , CONNECTED_AND_VALID = 2 , CONNECTED_BUT_NEEDS_UPDATE = 3 }
 See documentation of handleInput. More...
 
enum  INPUT_HANDLE { INVALIDATE = 0 , ALLOW_INVALID_INPUT = 2 }
 See documentation of handleInput. More...
 
- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 

Public Member Functions

 DicomEnhancedSave ()
 Constructor. More...
 
virtual ~DicomEnhancedSave ()
 Destructor. More...
 
- Public Member Functions inherited from ml::DicomSaveBase
 DicomSaveBase (int numInputs=1, int numOutputs=0)
 Constructor, currently 0-3 input images are allowed to be set by derived modules. More...
 
const BoolFieldgetCopyOtherInputTagsFld () const
 Access to internal fields fields, see corresponding member documentation for details. More...
 
BoolFieldgetDumpPrivateTagValuesFld () const
 
const StringFieldgetFileNameField () const
 
const NotifyFieldgetInheritDICOMTagsFld () const
 
const BoolFieldgetPostBadParamErrorsField () const
 
NotifyFieldgetSaveField () const
 
StringFieldgetStatusField () const
 
IntFieldgetTagDumpSizeFld () const
 
StringFieldgetTagDumpFld () const
 
- Public Member Functions inherited from ml::Module
MLMetaProfilePtrgetMetaProfile () const
 Returns the meta profile for the base operator. More...
 
const char * getTypeNameFast () const
 Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h). More...
 
 Module (int numInputImages, int numOutputImages)
 Constructor: Initializes numInputImages input images and numOutputImages output images of the module. More...
 
 ~Module () override
 Destructor: Destroys this module. More...
 
InputConnectorFieldgetInputImageField (MLint i) const
 Returns the field representing input image i. i must be a valid index. More...
 
OutputConnectorFieldgetOutputImageField (MLint i=0) const
 Returns field representing output image i. i must be a valid index. More...
 
MLint getNumInputImages () const
 Returns number of input images of this module. More...
 
MLint getNumOutputImages () const
 Returns number of output images of this module. More...
 
PagedImagegetOutputImage (MLint outputIndex=0) const
 Returns output image outputIndex. The index needs to be in the range [0, getNumOutputImages()-1]. More...
 
InputConnectorFieldaddInputImage (const char *name=nullptr)
 Adds a new input image with name to the module. More...
 
OutputConnectorFieldaddOutputImage (const char *name=nullptr)
 Adds a new output image with name to the module. More...
 
PagedImagegetInputImage (MLint inputIndex, bool getReal=false) const
 Returns the output image of the module connected to input inputIndex. More...
 
PagedImagegetUpdatedInputImage (MLint inputIndex, bool getReal=false) const
 Convenience method for safe access to the input image at index inputIndex. More...
 
MLErrorCode processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Processes all pages of a module for easy implementation of page-based image processing of complete images. More...
 
MLErrorCode processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Process input images with a ProcessAllPagesHandler handler on a temporary output image (which allocates no data) For details, see processAllPages(-1) above. More...
 
MLErrorCode processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 Processes all missing pages on the given output image. More...
 
void clearOutputImage (MLint i=0)
 Clear cached output image pages of output image i. More...
 
InputConnectorFieldaddInputConnector (const char *name, Module *module, MLint i) override
 
OutputConnectorFieldaddOutputConnector (const char *name, Module *module, MLint i) override
 
MLint getOutputImageInplace (MLint outputIndex=0) const
 Return optimization flag: Return index of input image whose input tile is used also as output page for output outputIndex in calculateOutputSubImage() (instead of allocating its own memory). More...
 
MLint getBypass (MLint outputIndex=0) const
 Returns the currently bypass index or -1 if bypassing is disabled (default). More...
 
THREAD_SUPPORT getThreadSupport () const
 Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT. More...
 
bool areRecursiveHandleNotificationsPermitted () const
 Returns if recursive entries in handleNotification are permitted. More...
 
MLint getHandleNotificationEntryCounter () const
 A counter returning the current number of (recursive re)entries in handleNotification. More...
 
PERMITTED_TYPES getVoxelDataTypeSupport () const
 Returns the current state of supported voxel data types. More...
 
bool isSupportedVoxelDataType (MLDataType dt) const
 Check if a given data type is supported on the module as configured with setVoxelDataTypeSupport. More...
 
virtual INPUT_HANDLE handleInput (int, INPUT_STATE) const
 This method may be reimplemented to enable support for invalid input images on the module. More...
 
INPUT_STATE getInputState (MLint index)
 Returns the current state of the input connection. More...
 
INPUT_STATE getUpdatedInputState (MLint index)
 Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards. More...
 
bool isInputImageField (Field *field) const
 Returns if the given field is an input image field. This can be used in handleNotification(), to check if one of the input images has changed. More...
 
void touchOutputImageFields () const
 Touch all output image fields to indicate that the images have changed. More...
 
FieldContainergetFieldContainer ()
 Returns a pointer to the container of all the module's fields. More...
 
const FieldContainergetFieldContainer () const
 Returns a constant pointer to the container of all the module's fields. More...
 
virtual void beginSaveFields ()
 Called before all fields data contents of this modules are saved. More...
 
virtual void endSaveFields ()
 Called after saving all field contents of this module. More...
 
- Public Member Functions inherited from ml::FieldContainer
 FieldContainer ()
 Constructor. More...
 
 ~FieldContainer () override
 Destructor: Deletes all added fields. More...
 
std::string whoAmI (bool withInstanceName=true) const
 Returns type and instance name of format "ClassTypeName(instanceName)" if the instance name is not empty and withInstanceName is true. More...
 
FieldaddField (const char *name, const char *type, const char *value)
 Adds a new field with name name, type type and value value (coded as string) to the container. More...
 
FieldaddField (Field *field)
 Adds a field, the ownership of the field is passed to the FieldContainer. More...
 
BoolFieldaddBool (const char *name)
 Creates a BoolField with name and adds it to the container. Default value is false. More...
 
BoolFieldaddBool (const char *name, bool value)
 Creates a BoolField with name and adds it to the container. More...
 
IntFieldaddInt (const char *name)
 Creates an IntField with name and adds it to the container. Default value is 0. More...
 
IntFieldaddInt (const char *name, MLint value)
 Creates an IntField with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems)
 Creates an EnumField field with name and adds it to the container. More...
 
EnumFieldaddEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
 Creates an EnumField field with name and adds it to the container. More...
 
template<typename EnumType >
TypedEnumField< EnumType > * addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
 Creates a TypedEnumField field with name and adds it to the container. More...
 
FloatFieldaddFloat (const char *name)
 Creates a FloatField with name and adds it to the container. Default value is 0.f. More...
 
FloatFieldaddFloat (const char *name, float value)
 Creates a FloatField with name and adds it to the container. More...
 
ProgressFieldaddProgress (const char *name)
 Creates a float ProgressField with name and adds it to the container. Default value is 0.f. More...
 
ProgressFieldaddProgress (const char *name, float value)
 Creates a float ProgressField with name and adds it to the container. More...
 
DoubleFieldaddDouble (const char *name)
 Creates a DoubleField with name and adds it to the container. Default value is 0. More...
 
DoubleFieldaddDouble (const char *name, double value)
 Creates a DoubleField with name and adds it to the container. More...
 
StringFieldaddString (const char *name)
 Creates a StringField with name and adds it to the container. Default value is empty string. More...
 
StringFieldaddString (const char *name, const std::string &value)
 Creates a StringField with name and adds it to the container. More...
 
NotifyFieldaddNotify (const char *name)
 Creates a NotifyField field with name and adds it to the container. More...
 
TriggerFieldaddTrigger (const char *name)
 Creates a TriggerField field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name)
 Creates a Base field with name and adds it to the container. Default value is NULL. More...
 
BaseFieldaddBase (const char *name, Base *value)
 Creates a Base field with name and adds it to the container. More...
 
BaseFieldaddBase (const char *name, const RefCountedBasePtr &value)
 Creates a Base field with name and adds it to the container. Sets the value from intrusive pointer. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, T *value=nullptr)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
BaseFieldaddBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
 As above, but also sets the allowed type of the field. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name)
 Creates a TypedBaseField with name and adds it to the container. Default value is NULL. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, T *value)
 Creates a TypedBaseField with name and adds it to the container. More...
 
template<typename T >
TypedBaseField< T > * addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value)
 Creates a TypedBaseField with name and adds it to the container. Sets the value from intrusive pointer. More...
 
SoNodeFieldaddSoNode (const char *name)
 Creates a SoNodeField with name and adds it to the container. Default value is NULL. More...
 
SoNodeFieldaddSoNode (const char *name, SoNode *value)
 Creates a SoNodeField with name and adds it to the container. More...
 
PointerFieldaddPointer (const char *name)
 Creates a PointerField with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, const Vector2 &value)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector2FieldaddVector2 (const char *name, double x, double y)
 Creates a Vector2Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, const Vector3 &value)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector3FieldaddVector3 (const char *name, double x, double y, double z)
 Creates a Vector3Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, const Vector4 &value)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector4FieldaddVector4 (const char *name, double x, double y, double z, double w)
 Creates a Vector4Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector5FieldaddVector5 (const char *name, const Vector5 &value)
 Creates a Vector5Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector6FieldaddVector6 (const char *name, const Vector6 &value)
 Creates a Vector6Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name)
 Creates a Vector10Field with name and adds it to the container. More...
 
Vector10FieldaddVector10 (const char *name, const Vector10 &value)
 Creates a Vector10Field with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, const ImageVector &value)
 Creates a ImageVectorField with name and adds it to the container. More...
 
ImageVectorFieldaddImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
 Creates a ImageVectorField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxFieldaddSubImageBox (const char *name, const SubImageBox &value)
 Creates a SubImageBoxField with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
SubImageBoxdFieldaddSubImageBoxd (const char *name, const SubImageBoxd &value)
 Creates a SubImageBoxd field with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, float r, float g, float b)
 Creates a ColorField with name and adds it to the container. More...
 
ColorFieldaddColor (const char *name, const Vector3 &value)
 Creates a ColorField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, double f0, double f1, double f2, double f3)
 Creates a PlaneField with name and adds it to the container. More...
 
PlaneFieldaddPlane (const char *name, const Plane &value)
 Creates a PlaneField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name)
 Creates a RotationField with name and adds it to the container. More...
 
RotationFieldaddRotation (const char *name, const Rotation &value)
 Creates a RotationField with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix2FieldaddMatrix2 (const char *name, const Matrix2 &value)
 Creates a Matrix2Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix3FieldaddMatrix3 (const char *name, const Matrix3 &value)
 Creates a Matrix3Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix4FieldaddMatrix4 (const char *name, const Matrix4 &value)
 Creates a Matrix4Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix5FieldaddMatrix5 (const char *name, const Matrix5 &value)
 Creates a Matrix5Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name)
 Creates a Matrix6Field with name and adds it to the container. More...
 
Matrix6FieldaddMatrix6 (const char *name, const Matrix6 &value)
 Creates a Matrix6Field with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name)
 Creates a MatrixField with name and adds it to the container. More...
 
MatrixFieldaddMatrix (const char *name, const Matrix4 &value)
 Creates a MatrixField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
MLDataTypeFieldaddMLDataType (const char *name, MLDataType value)
 Creates a MTDataTypeField with name and adds it to the container. More...
 
UniversalTypeFieldaddUniversalType (const char *name)
 Creates an UniversalTypeField field with name and adds it to the container. More...
 
IntListFieldaddIntList (const char *name)
 Creates an IntListField field with name and empty list value and adds it to the container. More...
 
IntListFieldaddIntList (const char *name, const std::vector< MLint > &value)
 Creates an IntListField field with name and given list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name)
 Creates an DoubleListField field with name and empty list value and adds it to the container. More...
 
DoubleListFieldaddDoubleList (const char *name, const std::vector< double > &value)
 Creates an DoubleListField field with name and given list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name)
 Creates an Vector2ListField field with name and empty list value and adds it to the container. More...
 
Vector2ListFieldaddVector2List (const char *name, const std::vector< Vector2 > &value)
 Creates an Vector2ListField field with name and given list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name)
 Creates an Vector3ListField field with name and empty list value and adds it to the container. More...
 
Vector3ListFieldaddVector3List (const char *name, const std::vector< Vector3 > &value)
 Creates an Vector3ListField field with name and given list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name)
 Creates an Vector4ListField field with name and empty list value and adds it to the container. More...
 
Vector4ListFieldaddVector4List (const char *name, const std::vector< Vector4 > &value)
 Creates an Vector4ListField field with name and given list value and adds it to the container. More...
 
size_t getNumFields () const
 Returns the number of added fields. More...
 
bool hasField (const std::string &name) const
 Returns true if the field with name name exists; otherwise false is returned. More...
 
FieldgetField (const std::string &name) const
 Returns the pointer to the field with name name. More...
 
FieldgetField (MLint index) const
 Returns pointer of field at index if it exists. If not, -1 is returned. More...
 
MLint getFieldIndex (Field *field) const
 Returns index of field if it exists. If not, -1 is returned. More...
 
void setFieldStringValue (const std::string &name, const std::string &value)
 Sets the value of the field with name if it exists. More...
 
std::string getFieldStringValue (const std::string &name) const
 Returns the string value of the field with name if it is found. More...
 
virtual void deactivateAttachments ()
 Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed. More...
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state. More...
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 

Static Public Attributes

static const char *const SupportedIODsStrings [NumSupportedIODs]
 String representations of supported IODs. More...
 

Protected Member Functions

void handleNotification (Field *field) override
 Handles field changes of the field field. More...
 
void activateAttachments () override
 Updates the internal module state after loading or cloning the module, and enables notification handling again. More...
 
std::string _checkConsistency () const override
 Checks for invalid parameters and return a textual description of the error if there is any, otherwise return an empty string. More...
 
virtual void _handleCommonInstanceReferenceFieldChanges (Field *field)
 Handles possible changes for CommonInstanceReference fields if compiled. More...
 
void _removeTags (DCMTree::TreePtr dcmTree, bool alsoSMFStuff)
 Removes tags not needed or not permitted in the IOD; remove SMF tree sequence only if alsoSMFStuff is true. More...
 
void _inheritFieldValuesFromDCMTree (DCMTree::Const_TreePtr dcmTree) override
 Overloads base class field inheritance and adds the additional tags needed by this class. More...
 
void _updateInputState () override
 Overwrites base class and sets up additional stuff in commonInstanceReferenceModuleTags. More...
 
std::string _setEnhancedIODTags (DCMTree::TreePtr resultTree, PagedImage &inputPagedImage, DCMTree::Const_TreePtr inputDcmTree)
 Creates and sets all tags for a valid Enhanced Image IOD dicom tree from inputPagedImage into dcmTree. More...
 
void _setUpCompression (DCMTree::TreePtr resultTree)
 Add tags configuring the compression scheme. More...
 
void _addAndSetEnhancedPixelDataTag (DCMTree::TreePtr resultTree, PagedImage &inputPagedImage)
 This routine saves the image data. More...
 
std::string _setUpTreeContent () override
 Sets the Enhanced DICOM tags in the tree; required that checkConsistency returns success. More...
 
 ML_MODULE_CLASS_HEADER (DicomEnhancedSave)
 Implements interface for the runtime type system of the ML. More...
 
- Protected Member Functions inherited from ml::DicomSaveBase
void handleNotification (Field *field) override
 Handles field changes of the field field. More...
 
void activateAttachments () override
 Updates the internal module state after loading or cloning the module, and enables notification handling again. More...
 
DCMTree::Const_TreePtr _getCurrentOriginalInputTree () const
 Returns content of the _currentOriginalInputTree after the recent call of _updateInputState(). More...
 
DCMTree::TreePtr _getCurrentModifiableTree () const
 Returns content of _currentModifiableTree after the recent call of _updateInputState(). More...
 
PagedImage_getCurrentInImg () const
 Returns content of _currentInImg after the recent call of _updateInputState(). More...
 
bool & _getAllowNULLInputTree ()
 Provides access to _allowNULLInputTree. More...
 
virtual DCMTree::Const_TreePtr _getInputDCMTree (DicomMessageCollector &dcmMsgCollector)
 Gets a DCMTree from the selected input or a nullptr tree if that is not available or empty. More...
 
virtual std::string _getInputImageConfiguration (int inputImageConnector, DCMTree::Const_TreePtr &originalInputImageTree, DCMTree::TreePtr &resultDcmTree, PagedImage *&inImg)
 Returns some important parameters of the module's input image configuration: More...
 
virtual void _updateTagDump (DCMTree::Const_TreePtr dcmTree)
 Updates the _dicomTagDumpFieldAddOn according to the content of dcmTree; called automatically by _save(). More...
 
virtual void _createInputModifierConnector ()
 If called then an input Base field for a DicomModifyList object is installed, typically called in constructor where fields are created. More...
 
virtual std::string _applyInputModifiersIfAvailable (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr)
 If an InputModifierConnector is available and modifiers are connected then apply them to dcmTree, otherwise the call is ignored. More...
 
virtual void _save ()
 Saves the DICOM object in the file(s) defined by _fileNameFld. More...
 
- Protected Member Functions inherited from ml::Module
void handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
 Called from FieldContainer whenever a field changes. More...
 
virtual void provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
 This method allows a Module to provide its own pages to the Host for the outputIndex output image. More...
 
void handleNotificationOff ()
 Decreases lock counter for handleNotification calls. More...
 
void handleNotificationOn ()
 Increases lock counter for handleNotification calls. More...
 
bool isHandleNotificationOn ()
 Returns true if handleNotification calls are permitted, otherwise false. More...
 
void setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
 Set optimization flag: If calculating a page in calculateOutputSubImage(), the output image page of output outputIndex shall use the same memory as the input page of input inputIndex. More...
 
void unsetOutputImageInplace (MLint outputIndex=0)
 Clear optimization flag: output page of output at outputIndex and input tile shall use different memory buffers in calculateOutputSubImage(). More...
 
void setBypass (MLint outputIndex=0, MLint inputIndex=0)
 Sets the input image whose pages can also be used instead of output pages for the output image at outputIndex to avoid recalculations. More...
 
void setClampPagesToImageExtent (bool flag=true)
 Enables/disables page clamping on all output images. More...
 
void setThreadSupport (THREAD_SUPPORT supportMode)
 Pass any THREAD_SUPPORT supportMode to decide whether and what type of multithreading is supported by this module. More...
 
void permitRecursiveHandleNotifications (bool enable)
 If this flag is set to enable =true, recursive entries in handleNotification are permitted. More...
 
void setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
 Specifies which types this module supports. More...
 
virtual CalculateOutputImageHandlercreateCalculateOutputImageHandler (PagedImage *outputImage)
 Creates the CalculateOutputImageHandler for the given output image outputImage. More...
 
virtual void calculateOutputImageProperties (int outputIndex, PagedImage *)
 Set properties of output image outputImage with output index outputIndex. More...
 
virtual SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
 Called by the Host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output outputIndex. More...
 
virtual void calculateOutputSubImage (SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages)
 Calculate page outputSubImage of output image with index outputIndex given the input image tiles in array inputSubImages. More...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 

Protected Attributes

EnumField_supportedIODsFld
 Selector for the IOD to export. More...
 
EnumField_compressionFld
 Selector for supported lossless compressions. More...
 
BoolField_suppressUnassignedContentWriteFld
 If true then no contents are written into Unassigned[PerFrame|Shared]ConvertedAttributesSequence in LegacyConvertedEnhanced IODs even there are any; basically this is only for testing since some tools complain about them; for proper operation this flag always should be false. More...
 
BoolField_strictChecksFld
 If false then no advanced checks (for example for a matching Modality tag) is performed when exporting information from the input; if true then exporting for example CT modality data is claimed as error. More...
 
_EnhancedFieldAddOnListType _fieldAddOnList
 Container which handles all internally used DicomModifyFieldAddOns. More...
 
- Protected Attributes inherited from ml::DicomSaveBase
TreeAndVolumeInputFieldAddOn _dcmTreeInputFieldAddOn
 Field AddOn to manage selectors and input connectors for DCMTrees and MultiFileVolumes. More...
 
DicomTagDumpFieldAddOn _dicomTagDumpFieldAddOn
 Field AddOns managing the DICOM tag dump as string field. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ml::DicomSaveBase
static std::string checkXYZValues (const ImageVector &ext)
 If Y and X are used as row and column, they can hold at most values of 65535, because these tags are of Vr US (unsigned short); NumberOfFrames tag is usually used for the z-slices and is an integer string and should not exceed is of type IS, which can hold up values up at most of 2^31-1; If any of these values exceed these ranges, a non empty error description is returned, otherwise an empty string. More...
 
static std::string checkMaximumPixelDataSize (const PagedImage &inImg)
 Returns an empty string if the passed PagedImage describes an image whose pixel data would fit into a DICOM PixelData tag and also calls checkXYValues(); if any range is exceeded a non-empty error string is returned. More...
 
- Static Public Member Functions inherited from ml::Module
static MLErrorCode getTile (PagedImage *image, SubImageBox loc, MLDataType datatype, void **data, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 For documentation see Host::getTile() function with same signature. More...
 
static MLErrorCode getTile (PagedImage *image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
 For documentation see Host::getTile() function with same signature and Module passed as reference. More...
 
static MLErrorCode updateImageProperties (PagedImage *image)
 For documentation see Host::updateImageProperties() function with same signature. More...
 
static void freeTile (void *data)
 For documentation see Host::freeTile(). More...
 
static void updateProgress (const char *info1, const char *info2)
 For documentation see Host::updateProgress(). More...
 
static bool shouldTerminate ()
 For documentation see Host::shouldTerminate(). More...
 
static FieldgetPressedNotifyField ()
 For documentation see Host::getPressedNotifyField(). More...
 
static void adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImgExtent, const ImageVector &oldImgExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0))
 Adapt page size. More...
 
static std::string getVoxelValueAsString (PagedImage *image, const ImageVector &position, MLErrorCode *errorCode=nullptr, const std::string &errorResult="")
 Returns the voxel value at position position of the image image. More...
 
static size_t getNumModules ()
 Returns number of instantiated modules. More...
 
static ModulegetModule (size_t index)
 Returns pointer to instantiated module index. More...
 
static MLint findModuleIndex (Module &module)
 Returns index of Module module. If not found -1 is returned. More...
 
static void destroyModule ()
 Destroys static allocated tables to avoid memory leaks. More...
 
- Protected Types inherited from ml::Module
enum  THREAD_SUPPORT {
  NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD , ML_CALCULATEOUTPUTSUBIMAGE_ON_STD_TYPES = PagedImage::MULTITHREADED ,
  ML_CALCULATEOUTPUTSUBIMAGE_ON_ALL_TYPES = PagedImage::MULTITHREADED
}
 Enumerator deciding whether and which type of multithreading is supported by this module. More...
 

Detailed Description

Definition at line 48 of file mlDicomEnhancedSave.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Number of supported IODs.

Enumerator
NumSupportedIODs 

Definition at line 75 of file mlDicomEnhancedSave.h.

◆ SupportedIODs

Enumerators for supported IODs.

Enumerator
LegacyConvertedEnhancedMR 

According to A.71 Legacy Converted Enhanced MR Image IOD in DICOM Standard.

Definition at line 78 of file mlDicomEnhancedSave.h.

Constructor & Destructor Documentation

◆ DicomEnhancedSave()

ml::DicomEnhancedSave::DicomEnhancedSave ( )

Constructor.

◆ ~DicomEnhancedSave()

virtual ml::DicomEnhancedSave::~DicomEnhancedSave ( )
virtual

Destructor.

Member Function Documentation

◆ _addAndSetEnhancedPixelDataTag()

void ml::DicomEnhancedSave::_addAndSetEnhancedPixelDataTag ( DCMTree::TreePtr  resultTree,
PagedImage inputPagedImage 
)
protected

This routine saves the image data.

Parameters
resultTreeThe DCMTree in which the pixeldata tag is inserted.
inputPagedImageThe valid image from which the can be retrieved with getTile.

◆ _checkConsistency()

std::string ml::DicomEnhancedSave::_checkConsistency ( ) const
overrideprotectedvirtual

Checks for invalid parameters and return a textual description of the error if there is any, otherwise return an empty string.

Implements ml::DicomSaveBase.

◆ _handleCommonInstanceReferenceFieldChanges()

virtual void ml::DicomEnhancedSave::_handleCommonInstanceReferenceFieldChanges ( Field field)
protectedvirtual

Handles possible changes for CommonInstanceReference fields if compiled.

◆ _inheritFieldValuesFromDCMTree()

void ml::DicomEnhancedSave::_inheritFieldValuesFromDCMTree ( DCMTree::Const_TreePtr  dcmTree)
overrideprotectedvirtual

Overloads base class field inheritance and adds the additional tags needed by this class.

Implements ml::DicomSaveBase.

◆ _removeTags()

void ml::DicomEnhancedSave::_removeTags ( DCMTree::TreePtr  dcmTree,
bool  alsoSMFStuff 
)
protected

Removes tags not needed or not permitted in the IOD; remove SMF tree sequence only if alsoSMFStuff is true.

◆ _setEnhancedIODTags()

std::string ml::DicomEnhancedSave::_setEnhancedIODTags ( DCMTree::TreePtr  resultTree,
PagedImage inputPagedImage,
DCMTree::Const_TreePtr  inputDcmTree 
)
protected

Creates and sets all tags for a valid Enhanced Image IOD dicom tree from inputPagedImage into dcmTree.

Parameters
resultTreeMust be the valid tree pointer into which all tags shall be inserted.
inputPagedImageThe ML PagedImage providing all image properties and perhaps DICOM inheritance information.
inputDcmTreeMaybe null in some contexts (e.g. SEG IOD), however, needed if ReferencedImageSequence or SourceImageSequence must be copied or added to destination.
Returns
An empty string on success, otherwise a descriptive string describing the problem.

◆ _setUpCompression()

void ml::DicomEnhancedSave::_setUpCompression ( DCMTree::TreePtr  resultTree)
protected

Add tags configuring the compression scheme.

◆ _setUpTreeContent()

std::string ml::DicomEnhancedSave::_setUpTreeContent ( )
overrideprotectedvirtual

Sets the Enhanced DICOM tags in the tree; required that checkConsistency returns success.

Returns
An empty string on success, otherwise a textual description of the error.

Implements ml::DicomSaveBase.

◆ _updateInputState()

void ml::DicomEnhancedSave::_updateInputState ( )
overrideprotectedvirtual

Overwrites base class and sets up additional stuff in commonInstanceReferenceModuleTags.

Reimplemented from ml::DicomSaveBase.

◆ activateAttachments()

void ml::DicomEnhancedSave::activateAttachments ( )
overrideprotectedvirtual

Updates the internal module state after loading or cloning the module, and enables notification handling again.

Reimplemented from ml::FieldContainer.

◆ handleNotification()

void ml::DicomEnhancedSave::handleNotification ( Field field)
overrideprotectedvirtual

Handles field changes of the field field.

Reimplemented from ml::Module.

◆ ML_MODULE_CLASS_HEADER()

ml::DicomEnhancedSave::ML_MODULE_CLASS_HEADER ( DicomEnhancedSave  )
protected

Implements interface for the runtime type system of the ML.

Member Data Documentation

◆ _compressionFld

EnumField* ml::DicomEnhancedSave::_compressionFld
protected

Selector for supported lossless compressions.

Definition at line 142 of file mlDicomEnhancedSave.h.

◆ _fieldAddOnList

_EnhancedFieldAddOnListType ml::DicomEnhancedSave::_fieldAddOnList
protected

Container which handles all internally used DicomModifyFieldAddOns.

Definition at line 155 of file mlDicomEnhancedSave.h.

◆ _strictChecksFld

BoolField* ml::DicomEnhancedSave::_strictChecksFld
protected

If false then no advanced checks (for example for a matching Modality tag) is performed when exporting information from the input; if true then exporting for example CT modality data is claimed as error.

Definition at line 152 of file mlDicomEnhancedSave.h.

◆ _supportedIODsFld

EnumField* ml::DicomEnhancedSave::_supportedIODsFld
protected

Selector for the IOD to export.

Definition at line 139 of file mlDicomEnhancedSave.h.

◆ _suppressUnassignedContentWriteFld

BoolField* ml::DicomEnhancedSave::_suppressUnassignedContentWriteFld
protected

If true then no contents are written into Unassigned[PerFrame|Shared]ConvertedAttributesSequence in LegacyConvertedEnhanced IODs even there are any; basically this is only for testing since some tools complain about them; for proper operation this flag always should be false.

Definition at line 147 of file mlDicomEnhancedSave.h.

◆ SupportedIODsStrings

const char* const ml::DicomEnhancedSave::SupportedIODsStrings[NumSupportedIODs]
static

String representations of supported IODs.

Definition at line 83 of file mlDicomEnhancedSave.h.


The documentation for this class was generated from the following file: