Medical Imaging Interaction Toolkit  2023.12.99-3b10b122
Medical Imaging Interaction Toolkit
mitk::IDICOMTagsOfInterest Class Referenceabstract

Interface of DICOM tags of interest service. More...

#include <mitkIDICOMTagsOfInterest.h>

Inheritance diagram for mitk::IDICOMTagsOfInterest:

Public Member Functions

virtual ~IDICOMTagsOfInterest ()
 
virtual void AddTagOfInterest (const DICOMTagPath &tag, bool makePersistant=true)=0
 Add an tag to the TOI. If the tag was already added it will be overwritten with the passed values. More...
 
virtual DICOMTagPathMapType GetTagsOfInterest () const =0
 
virtual bool HasTag (const DICOMTagPath &tag) const =0
 
virtual void RemoveTag (const DICOMTagPath &tag)=0
 Remove specific tag. If it not exists the function will do nothing. More...
 
virtual void RemoveAllTags ()=0
 Remove all tags. More...
 

Detailed Description

Interface of DICOM tags of interest service.

This service allows you to manage the tags of interest (toi). All registered toi will be extracted when loading dicom data and stored as properties in the corresponding base data object. In addition the service can (if available) use IPropertyPersistance and IPropertyAliases to ensure that the tags of interests are also persisted and have a human readable alias.

Definition at line 33 of file mitkIDICOMTagsOfInterest.h.

Constructor & Destructor Documentation

◆ ~IDICOMTagsOfInterest()

virtual mitk::IDICOMTagsOfInterest::~IDICOMTagsOfInterest ( )
virtual

Member Function Documentation

◆ AddTagOfInterest()

virtual void mitk::IDICOMTagsOfInterest::AddTagOfInterest ( const DICOMTagPath tag,
bool  makePersistant = true 
)
pure virtual

Add an tag to the TOI. If the tag was already added it will be overwritten with the passed values.

Parameters
[in]tagTag that should be added.
[in]makePersistantIndicates if the tag should be made persistent if possible via the IPropertyPersistence service.

Implemented in mitk::DICOMTagsOfInterestService.

◆ GetTagsOfInterest()

virtual DICOMTagPathMapType mitk::IDICOMTagsOfInterest::GetTagsOfInterest ( ) const
pure virtual

Returns the map of all tags of interest. Key is the property name. Value is the DICOM tag.

Implemented in mitk::DICOMTagsOfInterestService.

◆ HasTag()

virtual bool mitk::IDICOMTagsOfInterest::HasTag ( const DICOMTagPath tag) const
pure virtual

Indicates if the given tag is already a tag of interest.

Implemented in mitk::DICOMTagsOfInterestService.

◆ RemoveAllTags()

virtual void mitk::IDICOMTagsOfInterest::RemoveAllTags ( )
pure virtual

Remove all tags.

Implemented in mitk::DICOMTagsOfInterestService.

◆ RemoveTag()

virtual void mitk::IDICOMTagsOfInterest::RemoveTag ( const DICOMTagPath tag)
pure virtual

Remove specific tag. If it not exists the function will do nothing.

Parameters
[in]tagTag that should be removed.

Implemented in mitk::DICOMTagsOfInterestService.


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