#include <mlDicomEnhancedSave.h>

Inheritance diagram for ml::DicomEnhancedSave:

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 }
	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.
virtual	~DicomEnhancedSave ()
	Destructor.
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.
const BoolField &	getCopyOtherInputTagsFld () const
	Access to internal fields fields, see corresponding member documentation for details.
BoolField &	getDumpPrivateTagValuesFld () const
const StringField &	getFileNameField () const
const NotifyField &	getInheritDICOMTagsFld () const
const BoolField &	getPostBadParamErrorsField () const
NotifyField &	getSaveField () const
StringField &	getStatusField () const
IntField &	getTagDumpSizeFld () const
StringField &	getTagDumpFld () const
Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () const
	Returns the metaprofile for the base operator.
const char *	getTypeNameFast () const
	Module (int numInputImages, int numOutputImages)
	~Module () override
InputConnectorField *	getInputImageField (MLint i) const
	Returns the field representing input image `i`. `i` must be a valid index.
OutputConnectorField *	getOutputImageField (MLint i=0) const
	Returns the field representing output image `i`. `i` must be a valid index.
MLint	getNumInputImages () const
	Returns the number of input images of this module.
MLint	getNumOutputImages () const
	Returns the number of output images of this module.
PagedImage *	getOutputImage (MLint outputIndex=0) const
	Returns the output image `outputIndex`. The index needs to be in the range [0, getNumOutputImages()-1].
InputConnectorField *	addInputImage (const char *name=nullptr)
OutputConnectorField *	addOutputImage (const char *name=nullptr)
PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
PagedImage *	getUpdatedInputImage (MLint inputIndex, bool getReal=false) const
MLErrorCode	processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
MLErrorCode	processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
MLErrorCode	processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB progressCallback=nullptr, void progressCallbackUserData=nullptr)
void	clearOutputImage (MLint i=0)
	Clears cached output image pages of output image `i`.
MLint	getOutputImageInplace (MLint outputIndex=0) const
MLint	getBypass (MLint outputIndex=0) const
THREAD_SUPPORT	getThreadSupport () const
bool	areRecursiveHandleNotificationsPermitted () const
MLint	getHandleNotificationEntryCounter () const
PERMITTED_TYPES	getVoxelDataTypeSupport () const
bool	isSupportedVoxelDataType (MLDataType dt) const
virtual INPUT_HANDLE	handleInput (int, INPUT_STATE) const
INPUT_STATE	getInputState (MLint index)
INPUT_STATE	getUpdatedInputState (MLint index)
bool	isInputImageField (Field *field) const
void	touchOutputImageFields () const
	Touches all output image fields to indicate that the images have changed.
virtual void	beginSaveFields ()
virtual void	endSaveFields ()
Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor.
	~FieldContainer () override
	Destructor: Deletes all added fields.
std::string	whoAmI (bool withInstanceName=true) const
Field *	addField (const char name, const char type, const char *value)
Field *	addField (Field *field)
	Adds a `field`, the ownership of the field is passed to the FieldContainer.
BoolField *	addBool (const char *name)
	Creates a BoolField with `name` and adds it to the container. Default value is `false`.
BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with `name` and adds it to the container.
IntField *	addInt (const char *name)
	Creates an IntField with `name` and adds it to the container. Default value is 0.
IntField *	addInt (const char *name, MLint value)
	Creates an IntField with `name` and adds it to the container.
EnumField *	addEnum (const char name, const char const *enumerationItemNames, MLint numEnumerationItems)
EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
template<typename EnumType>
TypedEnumField< EnumType > *	addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
FloatField *	addFloat (const char *name)
	Creates a FloatField with `name` and adds it to the container. Default value is 0.f.
FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with `name` and adds it to the container.
ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with `name` and adds it to the container. Default value is 0.f.
ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with `name` and adds it to the container.
DoubleField *	addDouble (const char *name)
	Creates a DoubleField with `name` and adds it to the container. Default value is 0.
DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with `name` and adds it to the container.
StringField *	addString (const char *name)
	Creates a StringField with `name` and adds it to the container. Default value is empty string.
StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with `name` and adds it to the container.
NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with `name` and adds it to the container.
TriggerField *	addTrigger (const char *name)
BaseField *	addBase (const char *name)
	Creates a Base field with `name` and adds it to the container. Default value is NULL.
BaseField *	addBase (const char name, Base value)
	Creates a Base field with `name` and adds it to the container.
BaseField *	addBase (const char *name, const RefCountedBasePtr &value)
	Creates a Base field with `name` and adds it to the container. Sets the value from intrusive pointer.
template<typename T>
BaseField *	addBaseWithAllowedType (const char name, T value=nullptr)
	As above, but also sets the allowed type of the field.
template<typename T>
BaseField *	addBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
	As above, but also sets the allowed type of the field.
template<typename T>
TypedBaseField< T > *	addTypedBase (const char *name)
	Creates a TypedBaseField with `name` and adds it to the container. Default value is NULL.
template<typename T>
TypedBaseField< T > *	addTypedBase (const char name, T value)
	Creates a TypedBaseField with `name` and adds it to the container.
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.
SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with `name` and adds it to the container. Default value is NULL.
SoNodeField *	addSoNode (const char name, SoNode value)
	Creates a SoNodeField with `name` and adds it to the container.
PointerField *	addPointer (const char *name)
	Creates a PointerField with `name` and adds it to the container.
Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with `name` and adds it to the container.
Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with `name` and adds it to the container.
Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with `name` and adds it to the container.
Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with `name` and adds it to the container.
Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with `name` and adds it to the container.
Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with `name` and adds it to the container.
Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with `name` and adds it to the container.
Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with `name` and adds it to the container.
Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with `name` and adds it to the container.
Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with `name` and adds it to the container.
Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with `name` and adds it to the container.
Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with `name` and adds it to the container.
Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with `name` and adds it to the container.
Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with `name` and adds it to the container.
Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with `name` and adds it to the container.
ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with `name` and adds it to the container.
ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with `name` and adds it to the container.
ImageVectorField *	addImageVector (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.
SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with `name` and adds it to the container.
SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with `name` and adds it to the container.
SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with `name` and adds it to the container.
SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with `name` and adds it to the container.
ColorField *	addColor (const char *name)
	Creates a ColorField with `name` and adds it to the container.
ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with `name` and adds it to the container.
ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with `name` and adds it to the container.
PlaneField *	addPlane (const char *name)
	Creates a PlaneField with `name` and adds it to the container.
PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with `name` and adds it to the container.
PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with `name` and adds it to the container.
RotationField *	addRotation (const char *name)
	Creates a RotationField with `name` and adds it to the container.
RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with `name` and adds it to the container.
Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with `name` and adds it to the container.
Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with `name` and adds it to the container.
Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with `name` and adds it to the container.
Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with `name` and adds it to the container.
Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with `name` and adds it to the container.
Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with `name` and adds it to the container.
Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with `name` and adds it to the container.
Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with `name` and adds it to the container.
Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with `name` and adds it to the container.
Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with `name` and adds it to the container.
MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with `name` and adds it to the container.
MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with `name` and adds it to the container.
MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with `name` and adds it to the container.
MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with `name` and adds it to the container.
UniversalTypeField *	addUniversalType (const char *name)
	Creates an UniversalTypeField field with `name` and adds it to the container.
IntListField *	addIntList (const char *name)
	Creates an IntListField field with `name` and empty list value and adds it to the container.
IntListField *	addIntList (const char *name, const std::vector< MLint > &value)
	Creates an IntListField field with `name` and given list value and adds it to the container.
DoubleListField *	addDoubleList (const char *name)
	Creates an DoubleListField field with `name` and empty list value and adds it to the container.
DoubleListField *	addDoubleList (const char *name, const std::vector< double > &value)
	Creates an DoubleListField field with `name` and given list value and adds it to the container.
Vector2ListField *	addVector2List (const char *name)
	Creates an Vector2ListField field with `name` and empty list value and adds it to the container.
Vector2ListField *	addVector2List (const char *name, const std::vector< Vector2 > &value)
	Creates an Vector2ListField field with `name` and given list value and adds it to the container.
Vector3ListField *	addVector3List (const char *name)
	Creates an Vector3ListField field with `name` and empty list value and adds it to the container.
Vector3ListField *	addVector3List (const char *name, const std::vector< Vector3 > &value)
	Creates an Vector3ListField field with `name` and given list value and adds it to the container.
Vector4ListField *	addVector4List (const char *name)
	Creates an Vector4ListField field with `name` and empty list value and adds it to the container.
Vector4ListField *	addVector4List (const char *name, const std::vector< Vector4 > &value)
	Creates an Vector4ListField field with `name` and given list value and adds it to the container.
size_t	getNumFields () const
	Returns the number of added fields.
bool	hasField (const std::string &name) const
	Returns `true` if the field with name `name` exists; otherwise, `false` is returned.
Field *	getField (const std::string &name) const
Field *	getField (MLint index) const
	Returns pointer of field at `index` if it exists. If not, -1 is returned.
MLint	getFieldIndex (Field *field) const
	Returns index of `field` if it exists. If not, -1 is returned.
void	setFieldStringValue (const std::string &name, const std::string &value)
std::string	getFieldStringValue (const std::string &name) const
virtual void	deactivateAttachments ()
Public Member Functions inherited from ml::Base
	Base ()
	Constructor.
virtual	~Base ()
	Destructor.
virtual Base *	deepCopy () const
bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.
virtual std::string	detailString () const
virtual bool	implementsPersistence (PersistenceInterface) const
virtual std::string	persistentState () const
	Returns a string describing the object's internal state.
virtual void	setPersistentState (const std::string &state)
virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node.
virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node.
virtual void	writeTo (AbstractPersistenceOutputStream *) const
virtual void	readFrom (AbstractPersistenceInputStream *, int)

Static Public Attributes
static const char *const	SupportedIODsStrings [NumSupportedIODs]
	String representations of supported IODs.

Protected Member Functions
void	handleNotification (Field *field) override
	Handles field changes of the field `field`.
void	activateAttachments () override
std::string	_checkConsistency () const override
virtual void	_handleCommonInstanceReferenceFieldChanges (Field *field)
	Handles possible changes for CommonInstanceReference fields if compiled.
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.
void	_inheritFieldValuesFromDCMTree (DCMTree::Const_TreePtr dcmTree) override
	Overloads base class field inheritance and adds the additional tags needed by this class.
void	_updateInputState () override
	Overwrites base class and sets up additional stuff in commonInstanceReferenceModuleTags.
std::string	_setEnhancedIODTags (DCMTree::TreePtr resultTree, PagedImage &inputPagedImage, DCMTree::Const_TreePtr inputDcmTree)
void	_setUpCompression (DCMTree::TreePtr resultTree)
	Add tags configuring the compression scheme.
void	_addAndSetEnhancedPixelDataTag (DCMTree::TreePtr resultTree, PagedImage &inputPagedImage)
std::string	_setUpTreeContent () override
	ML_MODULE_CLASS_HEADER (DicomEnhancedSave)
	Implements interface for the runtime type system of the ML.
Protected Member Functions inherited from ml::DicomSaveBase
void	handleNotification (Field *field) override
	Handles field changes of the field `field`.
void	activateAttachments () override
	Updates the internal module state after loading or cloning the module, and enables notification handling again.
DCMTree::Const_TreePtr	_getCurrentOriginalInputTree () const
	Returns content of the _currentOriginalInputTree after the recent call of _updateInputState().
DCMTree::TreePtr	_getCurrentModifiableTree () const
	Returns content of _currentModifiableTree after the recent call of _updateInputState().
PagedImage *	_getCurrentInImg () const
	Returns content of _currentInImg after the recent call of _updateInputState().
bool &	_getAllowNULLInputTree ()
	Provides access to _allowNULLInputTree.
virtual DCMTree::Const_TreePtr	_getInputDCMTree (DicomMessageCollector &dcmMsgCollector)
virtual std::string	_getInputImageConfiguration (int inputImageConnector, DCMTree::Const_TreePtr &originalInputImageTree, DCMTree::TreePtr &resultDcmTree, PagedImage *&inImg)
virtual void	_updateTagDump (DCMTree::Const_TreePtr dcmTree)
virtual void	_createInputModifierConnector ()
virtual std::string	_applyInputModifiersIfAvailable (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr)
virtual void	_save ()
Protected Member Functions inherited from ml::Module
void	handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (PagedImage *outputImage)
virtual void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage)
virtual SubImageBox	calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
virtual void	calculateOutputSubImage (SubImage outputSubImage, int outputIndex, SubImage inputSubImages)
virtual void	provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
void	handleNotificationOff ()
void	handleNotificationOn ()
bool	isHandleNotificationOn ()
	Returns `true` if handleNotification calls are permitted; otherwise, it returns `false`.
void	setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
void	unsetOutputImageInplace (MLint outputIndex=0)
void	setBypass (MLint outputIndex=0, MLint inputIndex=0)
void	setClampPagesToImageExtent (bool flag=true)
void	setThreadSupport (THREAD_SUPPORT supportMode)
void	permitRecursiveHandleNotifications (bool enable)
void	setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)

Protected Attributes
EnumField *	_supportedIODsFld
	Selector for the IOD to export.
EnumField *	_compressionFld
	Selector for supported lossless compressions.
BoolField *	_suppressUnassignedContentWriteFld
BoolField *	_strictChecksFld
_EnhancedFieldAddOnListType	_fieldAddOnList
	Container which handles all internally used DicomModifyFieldAddOns.
Protected Attributes inherited from ml::DicomSaveBase
TreeAndVolumeInputFieldAddOn	_dcmTreeInputFieldAddOn
	Field AddOn to manage selectors and input connectors for DCMTrees and MultiFileVolumes.
DicomTagDumpFieldAddOn	_dicomTagDumpFieldAddOn
	Field AddOns managing the DICOM tag dump as string field.

Additional Inherited Members
Static Public Member Functions inherited from ml::DicomSaveBase
static std::string	checkXYZValues (const ImageVector &ext)
static std::string	checkMaximumPixelDataSize (const PagedImage &inImg)
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)
static MLErrorCode	getTile (PagedImage image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB progressCallback=nullptr, void *progressCallbackUserData=nullptr)
static MLErrorCode	updateImageProperties (PagedImage *image)
static void	freeTile (void *data)
	For documentation see Host::freeTile().
static void	updateProgress (const char info1, const char info2)
	For documentation see Host::updateProgress().
static bool	shouldTerminate ()
	For documentation see Host::shouldTerminate().
static Field *	getPressedNotifyField ()
	For documentation see Host::getPressedNotifyField().
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))
static std::string	getVoxelValueAsString (PagedImage image, const ImageVector &position, MLErrorCode errorCode=nullptr, const std::string &errorResult="")
static size_t	getNumModules ()
	Returns the number of instantiated modules.
static Module *	getModule (size_t index)
	Returns a pointer to instantiated module `index`.
static MLint	findModuleIndex (Module &module)
	Returns the index of Module `module`. If not found, -1 is returned.
static void	destroyModule ()
Protected Types inherited from ml::Module
enum	THREAD_SUPPORT { NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD }

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

enum ml::DicomEnhancedSave::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.

Referenced by ML_MODULE_CLASS_HEADER().

◆ ~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

resultTree	The DCMTree in which the pixeldata tag is inserted.
inputPagedImage	The 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

resultTree	Must be the valid tree pointer into which all tags shall be inserted.
inputPagedImage	The ML PagedImage providing all image properties and perhaps DICOM inheritance information.
inputDcmTree	Maybe 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.

References DicomEnhancedSave().

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:

FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomOutputs/Sources/mlDicomEnhancedSave.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ SupportedIODs

Constructor & Destructor Documentation

◆ DicomEnhancedSave()

◆ ~DicomEnhancedSave()

Member Function Documentation

◆ _addAndSetEnhancedPixelDataTag()

◆ _checkConsistency()

◆ _handleCommonInstanceReferenceFieldChanges()

◆ _inheritFieldValuesFromDCMTree()

◆ _removeTags()

◆ _setEnhancedIODTags()

◆ _setUpCompression()

◆ _setUpTreeContent()

◆ _updateInputState()

◆ activateAttachments()

◆ handleNotification()

◆ ML_MODULE_CLASS_HEADER()

Member Data Documentation

◆ _compressionFld

◆ _fieldAddOnList

◆ _strictChecksFld

◆ _supportedIODsFld

◆ _suppressUnassignedContentWriteFld

◆ SupportedIODsStrings