Manages the module field interface according to DICOM Spatial Fiducials C.21.2 without ContentDate, ContentTime, and ContentIdentificationMacro. More...
#include <mlDicomSpatialFiducialsModuleTagInterface.h>
Public Member Functions | |
| DicomSpatialFiducialsModuleTagInterface (Module &modRef) | |
| Constructor, setting the reference of the module for which the fields shall be managed. More... | |
| void | addFields () override |
| Add fields to field container of module. 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; if no or an empty XMarkerList is connected then no modifications will be performed on dcmTree and a non-empty description is returned describing that issue. 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... | |
| void | handleFieldActivationChanges () override |
| Handle class changes according to Module::activateAttachments. More... | |
| FieldAddOnBase::FieldChangeState | handleFieldChanges (Field *field) override |
| Handle field notifications according to Module::handleNotification with a return of field change state. 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 |
| Creates a deep copy of the given object. More... | |
| 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. More... | |
| virtual bool | isRefCountedBase () const |
| Returns whether the instance is derived from RefCountedBase. More... | |
| virtual std::string | detailString () const |
| Returns 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 |
| Writes the objects state to the data stream object. More... | |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
| Reads 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... | |
Public Attributes | |
| BoolField * | _createNewFrameOfReferenceUIDFld |
| Fields. More... | |
| StringField * | _frameOfReferenceUIDFld |
| FrameOfReferenceUID which references the image the FID data set is based on. More... | |
| StringField * | _fiducialIdentifierBaseFld |
| Base name for the fiducial identifiers which are expanded by indexes. More... | |
| BoolField * | _addFiducialDescriptionTagFld |
| Enables/disables whether the fidicialsDescription string tag is added to the DCMTree or not. More... | |
| StringField * | _fiducialDescriptionBaseFld |
| String used as base for all fiducial descriptions which are expanded by indexes. More... | |
| BaseField * | _xMarkerListInputFld |
| Input connector for an XMarkerList to store as fiducials in the DICOM tags. More... | |
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. 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 Spatial Fiducials C.21.2 without ContentDate, ContentTime, and ContentIdentificationMacro.
Definition at line 24 of file mlDicomSpatialFiducialsModuleTagInterface.h.
Constructor & Destructor Documentation
◆ DicomSpatialFiducialsModuleTagInterface()
|
inline |
Constructor, setting the reference of the module for which the fields shall be managed.
Definition at line 28 of file mlDicomSpatialFiducialsModuleTagInterface.h.
Member Function Documentation
◆ addFields()
|
overridevirtual |
Add fields to field container of module.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ applyModifications()
|
overridevirtual |
See DicomModifyFieldAddOnBase::applyModifications() for documentation; if no or an empty XMarkerList is connected then no modifications will be performed on dcmTree and a non-empty description is returned describing that issue.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ checkConsistency()
|
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.
◆ inheritValues()
|
overridevirtual |
Implements the copy of tag values from the given dcmTree to the fields.
Reimplemented from ml::DicomModifyFieldAddOnBase.
Member Data Documentation
◆ _addFiducialDescriptionTagFld
| BoolField* ml::DicomSpatialFiducialsModuleTagInterface::_addFiducialDescriptionTagFld |
Enables/disables whether the fidicialsDescription string tag is added to the DCMTree or not.
String used as base for all fiducial descriptions which are expanded by indexes.
Definition at line 59 of file mlDicomSpatialFiducialsModuleTagInterface.h.
◆ _createNewFrameOfReferenceUIDFld
| BoolField* ml::DicomSpatialFiducialsModuleTagInterface::_createNewFrameOfReferenceUIDFld |
Fields.
If enabled then for stored fiducials a new unique FrameOfReferenceUID is used instead of another (inherited) one.
Definition at line 49 of file mlDicomSpatialFiducialsModuleTagInterface.h.
◆ _fiducialDescriptionBaseFld
| StringField* ml::DicomSpatialFiducialsModuleTagInterface::_fiducialDescriptionBaseFld |
String used as base for all fiducial descriptions which are expanded by indexes.
Definition at line 62 of file mlDicomSpatialFiducialsModuleTagInterface.h.
◆ _fiducialIdentifierBaseFld
| StringField* ml::DicomSpatialFiducialsModuleTagInterface::_fiducialIdentifierBaseFld |
Base name for the fiducial identifiers which are expanded by indexes.
Definition at line 55 of file mlDicomSpatialFiducialsModuleTagInterface.h.
◆ _frameOfReferenceUIDFld
| StringField* ml::DicomSpatialFiducialsModuleTagInterface::_frameOfReferenceUIDFld |
FrameOfReferenceUID which references the image the FID data set is based on.
Definition at line 52 of file mlDicomSpatialFiducialsModuleTagInterface.h.
◆ _xMarkerListInputFld
| BaseField* ml::DicomSpatialFiducialsModuleTagInterface::_xMarkerListInputFld |
Input connector for an XMarkerList to store as fiducials in the DICOM tags.
Definition at line 65 of file mlDicomSpatialFiducialsModuleTagInterface.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomTagInterfaces/Sources/DicomTagInterfaces/mlDicomSpatialFiducialsModuleTagInterface.h
