Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Member Functions | List of all members
mitk::IDICOMTagsOfInterest Class Referenceabstract
MITK Modules » Core » Micro Services Interfaces

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

#include <mitkIDICOMTagsOfInterest.h>

Inheritance diagram for mitk::IDICOMTagsOfInterest:
Inheritance graph
[legend]

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 registred 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 37 of file mitkIDICOMTagsOfInterest.h.

Constructor & Destructor Documentation

mitk::IDICOMTagsOfInterest::~IDICOMTagsOfInterest ( )
virtual

Definition at line 19 of file mitkIDICOMTagsOfInterest.cpp.

Member Function Documentation

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 persistant if possible via the IPropertyPersistence service.

Implemented in mitk::DICOMTagsOfInterestService.

Referenced by mitk::RTDoseReader::Read().

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.

Referenced by mitk::GetCurrentDICOMTagsOfInterest(), and mitk::RTDoseReader::Read().

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.

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

Remove all tags.

Implemented in mitk::DICOMTagsOfInterestService.

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 files: