Manages the module field interface according to DICOM SC-Multi-frame Image, C.8.6.3 Image Pixel module C.7.6.3 SOP Common Module, C.12.1, handled by adding a newly created SOPInstanceUID by default. More...

#include <mlDicomSCMultiframeImageModuleTagInterface.h>

Inheritance diagram for ml::DicomSCMultiframeImageModuleTagInterface:

Public Member Functions
	DicomSCMultiframeImageModuleTagInterface (Module &modRef, bool autoCreateSOPInstanceUID=true)
	Constructor, setting the reference of the module for which the fields shall be managed; autoCreateSOPInstanceUID will fulfill SOP Commmon Module, C.12.1 by adding a newly created SOPInstanceUID by default; a special character set is not.

void	setInputPagedImage (PagedImage &inImg)
	Sets the input image from which the vector grid data shall be retrieved.

PagedImage *	getInputPagedImage () const
	Returns the currently set input image from which the vector grid data shall be retrieved.

void	setIsDigitizedFilm (bool isDigiFilm)
	If set to true then tags are written assuming that the conversion type is DigitizedFilm.

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

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

std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
	See DicomModifyFieldAddOnBase::applyModifications() for documentation.

std::string	checkConsistency () const override
	Checks for invalid parameters; return textual description on error, or empty string on success.

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.

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

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

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

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

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

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

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.

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

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

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

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.

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

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.

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

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

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Creates a deep copy of the given object.

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Checks whether this object's type is equal to or derived from one of the types given in the argument.

virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Returns a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().

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
	Writes the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object.

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

virtual	~FieldAddOnBase ()
	Destructor.

FieldContainer &	getFieldContainer ()
	Returns the referenced container.

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

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

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

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

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

Public Attributes
EnumField *	_burnedInAnnotationFld
	Fields.

DoubleField *	_rescaleInterceptFld
	Rescale Intercept for the image data to be written.

DoubleField *	_rescaleSlopeFld
	Rescale Intercept for the image data to be written.

StringField *	_rescaleTypeFld
	Rescale Intercept for the image data to be written.

Vector2Field *	_nominalScannedPixelSpacingFld
	The NominalScannedPixelSpacing tag to be written in case of ConversionType==DigitizedFilm.

Additional Inherited Members
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...

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.

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.

Detailed Description

Manages the module field interface according to DICOM SC-Multi-frame Image, C.8.6.3 Image Pixel module C.7.6.3 SOP Common Module, C.12.1, handled by adding a newly created SOPInstanceUID by default.

Also sets NumberOfFrames, SliceLocationVector, and FrameIncrementVector.

Definition at line 25 of file mlDicomSCMultiframeImageModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomSCMultiframeImageModuleTagInterface()

ml::DicomSCMultiframeImageModuleTagInterface::DicomSCMultiframeImageModuleTagInterface	(	Module &	modRef,
		bool	autoCreateSOPInstanceUID = `true`
	)

Constructor, setting the reference of the module for which the fields shall be managed; autoCreateSOPInstanceUID will fulfill SOP Commmon Module, C.12.1 by adding a newly created SOPInstanceUID by default; a special character set is not.

Member Function Documentation

◆ addFields()

void ml::DicomSCMultiframeImageModuleTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

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

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ checkConsistency()

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

overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ getInputPagedImage()

PagedImage * ml::DicomSCMultiframeImageModuleTagInterface::getInputPagedImage ( ) const

inline

Returns the currently set input image from which the vector grid data shall be retrieved.

Definition at line 38 of file mlDicomSCMultiframeImageModuleTagInterface.h.

◆ inheritValues()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ setInputPagedImage()

void ml::DicomSCMultiframeImageModuleTagInterface::setInputPagedImage ( PagedImage & inImg )

inline

Sets the input image from which the vector grid data shall be retrieved.

Definition at line 35 of file mlDicomSCMultiframeImageModuleTagInterface.h.

◆ setIsDigitizedFilm()

void ml::DicomSCMultiframeImageModuleTagInterface::setIsDigitizedFilm ( bool isDigiFilm )

inline

If set to true then tags are written assuming that the conversion type is DigitizedFilm.

Definition at line 41 of file mlDicomSCMultiframeImageModuleTagInterface.h.

Member Data Documentation

◆ _burnedInAnnotationFld

EnumField* ml::DicomSCMultiframeImageModuleTagInterface::_burnedInAnnotationFld

Fields.

Indicates whether or not image contains sufficient burned in annotation to identify the patient and date the image was acquired.

Definition at line 59 of file mlDicomSCMultiframeImageModuleTagInterface.h.

◆ _nominalScannedPixelSpacingFld

Vector2Field* ml::DicomSCMultiframeImageModuleTagInterface::_nominalScannedPixelSpacingFld

The NominalScannedPixelSpacing tag to be written in case of ConversionType==DigitizedFilm.

Definition at line 68 of file mlDicomSCMultiframeImageModuleTagInterface.h.

◆ _rescaleInterceptFld

DoubleField* ml::DicomSCMultiframeImageModuleTagInterface::_rescaleInterceptFld

Rescale Intercept for the image data to be written.

Definition at line 61 of file mlDicomSCMultiframeImageModuleTagInterface.h.

◆ _rescaleSlopeFld

DoubleField* ml::DicomSCMultiframeImageModuleTagInterface::_rescaleSlopeFld

Rescale Intercept for the image data to be written.

Definition at line 63 of file mlDicomSCMultiframeImageModuleTagInterface.h.

◆ _rescaleTypeFld

StringField* ml::DicomSCMultiframeImageModuleTagInterface::_rescaleTypeFld

Rescale Intercept for the image data to be written.

Definition at line 65 of file mlDicomSCMultiframeImageModuleTagInterface.h.

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

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DicomSCMultiframeImageModuleTagInterface()

Member Function Documentation

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ getInputPagedImage()

◆ inheritValues()

◆ setInputPagedImage()

◆ setIsDigitizedFilm()

Member Data Documentation

◆ _burnedInAnnotationFld

◆ _nominalScannedPixelSpacingFld

◆ _rescaleInterceptFld

◆ _rescaleSlopeFld

◆ _rescaleTypeFld