Manages the module field interface according to DICOM Enhanced MR Image Modules C.8.13.1. More...

#include <mlDicomEnhancedMRImageModuleTagInterface.h>

Inheritance diagram for ml::DicomEnhancedMRImageModuleTagInterface:

Public Types
enum	IODMode { ImageTypeforLegacyConvertedEnhancedMR = 0 }
	Defined the mode how the up to four values are configured and filled with values on construction time. More...

Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Public Types inherited from ml::FieldAddOnBase
enum	FieldChangeState { NoChange = 0 , StatusOnlyChange , RecalculationRequired }
	Describes the type of a field changes detected in handleFieldChanges(Field *field). More...

Public Member Functions
	DicomEnhancedMRImageModuleTagInterface (Module &modRef, IODMode iodMode)
	Constructor, setting the reference of the module for which the fields shall be managed; iodMode defines for which IOD the AddOn shall be configured. More...

void	addFields () override
	Add fields to field container of module. More...

void	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments. More...

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::activateAttachments with a return of field change state. More...

void	inheritValues (DCMTree::Const_TreePtr dcmTree) override
	Implements the copy of tag values from the given dcmTree to the fields. More...

std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
	See DicomModifyFieldAddOnBase::applyModifications() for documentation; adds field values as tags to dcmTree. More...

void	_addLegacyConvertedEnhancedMRImageModuleSpecificTags (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos)
	Add tags of the Legacy Converted Enhanced MR Image Module, C.8.13.1. More...

std::string	checkConsistency () const override
	Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation. More...

Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
	DicomModifyFieldAddOnBase (FieldContainer &fieldContainerRef, size_t numInstances=1, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
	Constructor, setting the reference of the FieldContainer managing the fields, the number of field instances to create and optionally input and output fields to create modification pipelines. More...

	~DicomModifyFieldAddOnBase () override
	Destructor resetting connector fields if they exist. More...

size_t	getNumInstances () const
	Returns the number of instances to be created by derived fields. More...

BaseField *	getOutputModifierListFld () const
	Provide access to output base field if it was created. More...

BaseField *	getInputModifierListFld () const
	Provide access to input base connector field if it was created. More...

Public Member Functions inherited from ml::DicomModifyList
	DicomModifyList ()
	Constructor creating an empty list of tag modifiers and setting the optional input plugin with a concatenated DicomModifyList. More...

	~DicomModifyList () override
	Destructor also destroying all of its stored Modifiers. More...

void	addModifier (DicomModifyBase *modifier, bool atEnd=true)
	Add an object derived from DicomModifyBase which then will be owned (and on destruction deleted) by this. More...

void	clear ()
	Makes modifier array empty and deletes all of them. More...

std::vector< DicomModifyBase * > &	getModifierList ()
	Get direct access to internal list to allow callers direct manipulations which, however, must obey the restriction that ownership belongs to *this, i.e. More...

const std::vector< DicomModifyBase * > &	getModifierList () const
	Same as getModifierList() only for constant access. More...

void	setInputPlugin (DicomModifyList *inputPlugin=nullptr)
	Sets an optional plugin to be called by applyModififcations or resets it to nullptr; the input is called after the objects in _modfiers list. More...

DicomModifyList *	getInputPlugin () const
	Returns the optional plugin to be called by applyModififcations. More...

Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...

virtual	~Base ()
	Destructor. More...

virtual Base *	deepCopy () 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...

Public Member Functions inherited from ml::FieldAddOnBase
	FieldAddOnBase (FieldContainer &fieldContainerRef)
	Constructor, setting the reference of the FieldContainer managing the fields. More...

virtual	~FieldAddOnBase ()
	Destructor. More...

FieldContainer &	getFieldContainer ()
	Returns the referenced container. More...

const FieldContainer &	getFieldContainer () const
	Returns the referenced container. More...

std::vector< Field * > &	getFields ()
	Return modification access to the list of managed fields, use at own risk! More...

const std::vector< Field * > &	getFields () const
	Return constant access to the list of managed fields! More...

virtual FieldChangeState	getMergedFieldChangeState (FieldChangeState state1, FieldChangeState state2) const
	Returns a FieldChangeState which best represents a merge of the two given states. More...

virtual bool	hasField (Field *field) const
	Returns true if the passed fieldPtr is in _fieldPointers, otherwise false. More...

Static Public Member Functions
static bool	hasReferencedImageSequence (DCMTree::Const_TreePtr dcmTree)
	Small helper returning true if dcmTree has a top-level tag DCMTree_ReferencedImageSequence tag or one in the DCMTree_SharedFunctionalGroupsSequence, otherwise false. More...

Static Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
static bool	isIn (const std::string &str, const char const values, size_t numValues)
	Static helper function which checks whether str is part of the given list of values which has numValues entries. More...

Public Attributes
DicomCopyTagSetInterface	otherEnhancedImageAndSpectroscopyMacroTags
	All tags not available in the interface which are from Enhanced Image And Spectroscopy Macro. More...

DicomCopyTagSetInterface	otherMRImageModuleTags
	All tags not available in the interface which are from MR Image Module mostly must be moved into Unassigned Shared Functional Group. More...

DicomCopyTagSetInterface	otherEnhancedMRImageModuleTags
	All tags not available in the interface which are from Enhanced MR image. More...

DicomCopyTagSetInterface	otherImagePixelDescriptionMacroAttributesTags
	Subset from otherEnhancedMRImageModuleTags not handled there and which shall be configured independently. More...

DicomBoolInheritAndWriteTagInterface	burnedInAnnotationAddOn
	Manages burnedInAnnotation tag. More...

DicomBoolInheritAndWriteTagInterface	recognizableVisualFeaturesAddOn
	Manages recognizableVisualFeatures tag. More...

Protected Attributes
const IODMode	_iodMode
	Selects the configuration for the internal fields and possible values. More...

DCMTree::TreePtr	_referencedImageEvidenceSequenceTree
	Stores the pointer to some contents of ReferencedImageSequences inherited from dcmTree. More...

DCMTree::TreePtr	_sourceImageEvidenceSequenceTree
	Stores the pointer to some contents of SourceImageSequences inherited from dcmTree. More...

BoolField *	_alwaysWritePresentationLUTShapeFld
	Convenience flag to enable writing of PresentationLUTShape tag even if not needed to satisfy some IOD checkers which also want it if PhotometricInterpretation is not MONOCHROME2, which, however, is too strict since in LegacyConvertedEnhancedMR IOD -> Enhanced MR Image it is only required in non-MONOCHROME2 case. More...

Additional Inherited Members
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 Member Functions inherited from ml::FieldAddOnBase
void	_addFieldPointer (Field *field)
	Helper routine to add a Field pointer to _fieldPointers, empty pointers and pointers added more than once will be handled fatally. More...

Detailed Description

Manages the module field interface according to DICOM Enhanced MR Image Modules C.8.13.1.

Definition at line 23 of file mlDicomEnhancedMRImageModuleTagInterface.h.

Member Enumeration Documentation

◆ IODMode

enum ml::DicomEnhancedMRImageModuleTagInterface::IODMode

Defined the mode how the up to four values are configured and filled with values on construction time.

Enumerator
ImageTypeforLegacyConvertedEnhancedMR	Configure for Enhanced LegacyConverted MR.

Definition at line 28 of file mlDicomEnhancedMRImageModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomEnhancedMRImageModuleTagInterface()

ml::DicomEnhancedMRImageModuleTagInterface::DicomEnhancedMRImageModuleTagInterface	(	Module &	modRef,
		IODMode	iodMode
	)

Constructor, setting the reference of the module for which the fields shall be managed; iodMode defines for which IOD the AddOn shall be configured.

Member Function Documentation

◆ _addLegacyConvertedEnhancedMRImageModuleSpecificTags()

void ml::DicomEnhancedMRImageModuleTagInterface::_addLegacyConvertedEnhancedMRImageModuleSpecificTags	(	DCMTree::TreePtr	dcmTree,
		const FieldContainer *	treeInfos
	)

Add tags of the Legacy Converted Enhanced MR Image Module, C.8.13.1.

◆ addFields()

void ml::DicomEnhancedMRImageModuleTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

std::string ml::DicomEnhancedMRImageModuleTagInterface::applyModifications	(	DCMTree::TreePtr	dcmTree,
		const FieldContainer *	treeInfos = `nullptr`
	)

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation; adds field values as tags to dcmTree.

Requires that Image Pixel Macro Attributes already have been added to dcmTree and that setInputDcmTree has been called with a valid DICOM tree before.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ checkConsistency()

std::string ml::DicomEnhancedMRImageModuleTagInterface::checkConsistency ( ) const

overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldActivationChanges()

void ml::DicomEnhancedMRImageModuleTagInterface::handleFieldActivationChanges ( )

overridevirtual

Handle class changes according to Module::activateAttachments.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::DicomEnhancedMRImageModuleTagInterface::handleFieldChanges ( Field * field )

overridevirtual

Handle field notifications according to Module::activateAttachments with a return of field change state.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ hasReferencedImageSequence()

static bool ml::DicomEnhancedMRImageModuleTagInterface::hasReferencedImageSequence ( DCMTree::Const_TreePtr dcmTree )

static

Small helper returning true if dcmTree has a top-level tag DCMTree_ReferencedImageSequence tag or one in the DCMTree_SharedFunctionalGroupsSequence, otherwise false.

◆ inheritValues()

void ml::DicomEnhancedMRImageModuleTagInterface::inheritValues ( DCMTree::Const_TreePtr dcmTree )

overridevirtual

Implements the copy of tag values from the given dcmTree to the fields.

Reimplemented from ml::DicomModifyFieldAddOnBase.

Member Data Documentation

◆ _alwaysWritePresentationLUTShapeFld

BoolField* ml::DicomEnhancedMRImageModuleTagInterface::_alwaysWritePresentationLUTShapeFld

protected

Convenience flag to enable writing of PresentationLUTShape tag even if not needed to satisfy some IOD checkers which also want it if PhotometricInterpretation is not MONOCHROME2, which, however, is too strict since in LegacyConvertedEnhancedMR IOD -> Enhanced MR Image it is only required in non-MONOCHROME2 case.

Definition at line 108 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ _iodMode

const IODMode ml::DicomEnhancedMRImageModuleTagInterface::_iodMode

protected

Selects the configuration for the internal fields and possible values.

Definition at line 96 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ _referencedImageEvidenceSequenceTree

DCMTree::TreePtr ml::DicomEnhancedMRImageModuleTagInterface::_referencedImageEvidenceSequenceTree

protected

Stores the pointer to some contents of ReferencedImageSequences inherited from dcmTree.

Definition at line 99 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ _sourceImageEvidenceSequenceTree

DCMTree::TreePtr ml::DicomEnhancedMRImageModuleTagInterface::_sourceImageEvidenceSequenceTree

protected

Stores the pointer to some contents of SourceImageSequences inherited from dcmTree.

Definition at line 102 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ burnedInAnnotationAddOn

DicomBoolInheritAndWriteTagInterface ml::DicomEnhancedMRImageModuleTagInterface::burnedInAnnotationAddOn

Manages burnedInAnnotation tag.

Definition at line 89 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ otherEnhancedImageAndSpectroscopyMacroTags

DicomCopyTagSetInterface ml::DicomEnhancedMRImageModuleTagInterface::otherEnhancedImageAndSpectroscopyMacroTags

All tags not available in the interface which are from Enhanced Image And Spectroscopy Macro.

Definition at line 75 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ otherEnhancedMRImageModuleTags

DicomCopyTagSetInterface ml::DicomEnhancedMRImageModuleTagInterface::otherEnhancedMRImageModuleTags

All tags not available in the interface which are from Enhanced MR image.

Definition at line 82 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ otherImagePixelDescriptionMacroAttributesTags

DicomCopyTagSetInterface ml::DicomEnhancedMRImageModuleTagInterface::otherImagePixelDescriptionMacroAttributesTags

Subset from otherEnhancedMRImageModuleTags not handled there and which shall be configured independently.

Definition at line 86 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ otherMRImageModuleTags

DicomCopyTagSetInterface ml::DicomEnhancedMRImageModuleTagInterface::otherMRImageModuleTags

All tags not available in the interface which are from MR Image Module mostly must be moved into Unassigned Shared Functional Group.

Definition at line 79 of file mlDicomEnhancedMRImageModuleTagInterface.h.

◆ recognizableVisualFeaturesAddOn

DicomBoolInheritAndWriteTagInterface ml::DicomEnhancedMRImageModuleTagInterface::recognizableVisualFeaturesAddOn

Manages recognizableVisualFeatures tag.

Definition at line 92 of file mlDicomEnhancedMRImageModuleTagInterface.h.

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

FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomTagInterfaces/Sources/DicomTagInterfaces/mlDicomEnhancedMRImageModuleTagInterface.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ IODMode

Constructor & Destructor Documentation

◆ DicomEnhancedMRImageModuleTagInterface()

Member Function Documentation

◆ _addLegacyConvertedEnhancedMRImageModuleSpecificTags()

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ handleFieldActivationChanges()

◆ handleFieldChanges()

◆ hasReferencedImageSequence()

◆ inheritValues()

Member Data Documentation

◆ _alwaysWritePresentationLUTShapeFld

◆ _iodMode

◆ _referencedImageEvidenceSequenceTree

◆ _sourceImageEvidenceSequenceTree

◆ burnedInAnnotationAddOn

◆ otherEnhancedImageAndSpectroscopyMacroTags

◆ otherEnhancedMRImageModuleTags

◆ otherImagePixelDescriptionMacroAttributesTags

◆ otherMRImageModuleTags

◆ recognizableVisualFeaturesAddOn