Encapsulates the tag scanning process for a set of DICOM files. More...
#include <mitkDICOMGDCMTagScanner.h>
Public Member Functions | |
| mitkClassMacro (DICOMGDCMTagScanner, DICOMTagScanner) | |
| Pointer | Clone () const |
| void | AddTag (const DICOMTag &tag) override |
| Add this tag to the scanning process. More... | |
| void | AddTags (const DICOMTagList &tags) override |
| Add a list of tags to the scanning process. More... | |
| void | AddTagPath (const DICOMTagPath &tag) override |
| Add this tag path to the scanning process. More... | |
| void | AddTagPaths (const DICOMTagPathList &tags) override |
| Add a list of tag paths to the scanning process. More... | |
| void | SetInputFiles (const StringList &filenames) override |
| Define the list of files to scan. This does not ADD to an internal list, but it replaces the whole list of files. More... | |
| void | Scan () override |
| Start the scanning process. Calling Scan() will invalidate previous scans, forgetting all about files and tags from files that have been scanned previously. More... | |
| DICOMDatasetAccessingImageFrameList | GetFrameInfoList () const override |
| Retrieve a result list for file-by-file tag access. More... | |
| DICOMTagCache::Pointer | GetScanCache () const override |
| Retrieve Pointer to the complete cache of the scan. More... | |
| virtual DICOMDatasetFinding | GetTagValue (DICOMImageFrameInfo *frame, const DICOMTag &tag) const |
| Directly retrieve the tag value for a given frame and tag. More... | |
 Public Member Functions inherited from mitk::DICOMTagScanner | |
| mitkClassMacroItkParent (DICOMTagScanner, itk::Object) | |
Static Public Member Functions | |
| static Pointer | New () |
Protected Member Functions | |
| DICOMGDCMTagScanner () | |
| ~DICOMGDCMTagScanner () override | |
| Protected Member Functions inherited from mitk::DICOMTagScanner | |
| void | PushLocale () const |
| Remember current locale on stack, activate "C" locale. "C" locale is required for correct parsing of numbers by itk::ImageSeriesReader. More... | |
| void | PopLocale () const |
| Activate last remembered locale from locale stack "C" locale is required for correct parsing of numbers by itk::ImageSeriesReader. More... | |
| DICOMTagScanner () | |
| ~DICOMTagScanner () override | |
Protected Attributes | |
| std::set< DICOMTag > | m_ScannedTags |
| StringList | m_InputFilenames |
| DICOMGDCMTagCache::Pointer | m_Cache |
| std::shared_ptr< gdcm::Scanner > | m_GDCMScanner |
Additional Inherited Members | |
| Static Protected Member Functions inherited from mitk::DICOMTagScanner | |
| static std::string | GetActiveLocale () |
| Return active C locale. More... | |
Detailed Description
Encapsulates the tag scanning process for a set of DICOM files.
Formerly integrated as a part of DICOMITKSeriesGDCMReader, the tag scanning part has been factored out into this DICOMGDCMTagScanner class in order to allow a single scan for multiple reader alternatives. This helps much in the selection process of e.g. DICOMFileReaderSelector.
The class works similar to gdcm::Scanner, just with the MITK set of classes:
- add a number of DICOM tags that should be read
- set a list of files that should be scanned for named tags
- call Scan()
- retrieve the scan results
- via GetFrameInfoList() or
- via GetTagValue()
When used in a process where multiple classes will access the scan results, care should be taken that all the tags and files of interest are communicated to DICOMGDCMTagScanner before requesting the results!
- Remarks
- This scanner does only support the scanning for simple value tag. If you need to scann for sequence items or non-top-level elements, this scanner will not be sufficient. See i.a. DICOMDCMTKTagScanner for these cases.
Definition at line 48 of file mitkDICOMGDCMTagScanner.h.
Constructor & Destructor Documentation
◆ DICOMGDCMTagScanner()
|
protected |
◆ ~DICOMGDCMTagScanner()
|
overrideprotected |
Member Function Documentation
◆ AddTag()
|
overridevirtual |
Add this tag to the scanning process.
Implements mitk::DICOMTagScanner.
◆ AddTagPath()
|
overridevirtual |
Add this tag path to the scanning process.
Implements mitk::DICOMTagScanner.
◆ AddTagPaths()
|
overridevirtual |
Add a list of tag paths to the scanning process.
Implements mitk::DICOMTagScanner.
◆ AddTags()
|
overridevirtual |
Add a list of tags to the scanning process.
Implements mitk::DICOMTagScanner.
◆ Clone()
| Pointer mitk::DICOMGDCMTagScanner::Clone | ( | ) | const |
◆ GetFrameInfoList()
|
overridevirtual |
Retrieve a result list for file-by-file tag access.
Implements mitk::DICOMTagScanner.
◆ GetScanCache()
|
overridevirtual |
Retrieve Pointer to the complete cache of the scan.
Implements mitk::DICOMTagScanner.
◆ GetTagValue()
|
virtual |
Directly retrieve the tag value for a given frame and tag.
- Precondition
- Scan() must have been called before calling this function.
◆ mitkClassMacro()
| mitk::DICOMGDCMTagScanner::mitkClassMacro | ( | DICOMGDCMTagScanner | , |
| DICOMTagScanner | |||
| ) |
◆ New()
|
static |
◆ Scan()
|
overridevirtual |
Start the scanning process. Calling Scan() will invalidate previous scans, forgetting all about files and tags from files that have been scanned previously.
Implements mitk::DICOMTagScanner.
◆ SetInputFiles()
|
overridevirtual |
Define the list of files to scan. This does not ADD to an internal list, but it replaces the whole list of files.
Implements mitk::DICOMTagScanner.
Member Data Documentation
◆ m_Cache
|
protected |
Definition at line 111 of file mitkDICOMGDCMTagScanner.h.
◆ m_GDCMScanner
|
protected |
Definition at line 112 of file mitkDICOMGDCMTagScanner.h.
◆ m_InputFilenames
|
protected |
Definition at line 110 of file mitkDICOMGDCMTagScanner.h.
◆ m_ScannedTags
|
protected |
Definition at line 109 of file mitkDICOMGDCMTagScanner.h.
The documentation for this class was generated from the following file:
