Interface to datasets that is presented to sorting classes such as DICOMDatasetSorter. More...
#include <mitkDICOMDatasetAccess.h>
Public Types | |
| typedef std::list< DICOMDatasetFinding > | FindingsListType |
| A list of DICOMDatasetFinding instances. More... | |
Public Member Functions | |
| virtual std::string | GetFilenameIfAvailable () const =0 |
| Return a filename if possible. More... | |
| virtual DICOMDatasetFinding | GetTagValueAsString (const DICOMTag &tag) const =0 |
| Return a DICOMDatasetFinding for a single DICOM tag. More... | |
| virtual FindingsListType | GetTagValueAsString (const DICOMTagPath &path) const =0 |
| Return a list of DICOMDatasetFindings for a tag path. More... | |
| virtual | ~DICOMDatasetAccess () |
Detailed Description
Interface to datasets that is presented to sorting classes such as DICOMDatasetSorter.
Minimal interface to hide actual implementation, which might rely on GDCM.
Definition at line 54 of file mitkDICOMDatasetAccess.h.
Member Typedef Documentation
◆ FindingsListType
| typedef std::list<DICOMDatasetFinding> mitk::DICOMDatasetAccess::FindingsListType |
A list of DICOMDatasetFinding instances.
Definition at line 58 of file mitkDICOMDatasetAccess.h.
Constructor & Destructor Documentation
◆ ~DICOMDatasetAccess()
|
inlinevirtual |
Definition at line 91 of file mitkDICOMDatasetAccess.h.
Member Function Documentation
◆ GetFilenameIfAvailable()
|
pure virtual |
Return a filename if possible.
If DICOM is not read from file but from somewhere else (network, database), we might not have files. In such cases, an empty string may be returned.
- Returns
- The absolute filename of this dataset, or empty string if unavailable.
Implemented in mitk::DICOMGenericImageFrameInfo, and mitk::DICOMGDCMImageFrameInfo.
◆ GetTagValueAsString() [1/2]
|
pure virtual |
Return a DICOMDatasetFinding for a single DICOM tag.
The return contains (if valid) the raw value of the tag as a string.
- Parameters
-
[in] tag The DICOM tag whose value should be retrieved.
- Returns
- A DICOMDatasetFinding with isValid indicating whether the tag was found.
Implemented in mitk::DICOMGenericImageFrameInfo, and mitk::DICOMGDCMImageFrameInfo.
◆ GetTagValueAsString() [2/2]
|
pure virtual |
Return a list of DICOMDatasetFindings for a tag path.
The return contains (if valid) the raw values of the matching tags as strings. This overload supports nested/sequence paths.
- Parameters
-
[in] path The tag path whose values should be retrieved.
- Returns
- A list of findings matching the given path.
Implemented in mitk::DICOMGenericImageFrameInfo, and mitk::DICOMGDCMImageFrameInfo.
The documentation for this class was generated from the following file:
