Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::DICOMGDCMTagCache Class Reference

Tag cache implementation used by the DICOMGDCMTagScanner. More...

#include <mitkDICOMGDCMTagCache.h>

Inheritance diagram for mitk::DICOMGDCMTagCache:
Collaboration diagram for mitk::DICOMGDCMTagCache:

Public Member Functions

 mitkClassMacro (DICOMGDCMTagCache, DICOMTagCache)
 
Pointer Clone () const
 
DICOMDatasetFinding GetTagValue (DICOMImageFrameInfo *frame, const DICOMTag &tag) const override
 Retrieve a tag value for a specific frame and tag. More...
 
FindingsListType GetTagValue (DICOMImageFrameInfo *frame, const DICOMTagPath &path) const override
 Retrieve tag values for a specific frame and tag path. More...
 
DICOMDatasetAccessingImageFrameList GetFrameInfoList () const override
 Retrieve the list of frame info objects from the scan result. More...
 
void InitCache (const std::set< DICOMTag > &scannedTags, const std::shared_ptr< gdcm::Scanner > &scanner, const StringList &inputFiles)
 Initialize the cache with scan results from a gdcm::Scanner. More...
 
const gdcm::Scanner & GetScanner () const
 Get a const reference to the underlying gdcm::Scanner. More...
 
- Public Member Functions inherited from mitk::DICOMTagCache
 mitkClassMacroItkParent (DICOMTagCache, itk::Object)
 
virtual void SetInputFiles (const StringList &filenames)
 Define the list of files that were scanned to populate the cache. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 DICOMGDCMTagCache ()
 
 ~DICOMGDCMTagCache () override
 
- Protected Member Functions inherited from mitk::DICOMTagCache
 DICOMTagCache ()
 
 DICOMTagCache (const DICOMTagCache &)
 
 ~DICOMTagCache () override
 

Protected Attributes

std::set< DICOMTag > m_ScannedTags
 
std::shared_ptr< gdcm::Scanner > m_Scanner
 
DICOMDatasetAccessingImageFrameList m_ScanResult
 
- Protected Attributes inherited from mitk::DICOMTagCache
StringList m_InputFilenames
 

Additional Inherited Members

- Public Types inherited from mitk::DICOMTagCache
typedef std::list< DICOMDatasetFinding > FindingsListType
 A list of DICOMDatasetFinding instances. More...
 

Detailed Description

Tag cache implementation used by the DICOMGDCMTagScanner.

Definition at line 30 of file mitkDICOMGDCMTagCache.h.

Constructor & Destructor Documentation

◆ DICOMGDCMTagCache()

mitk::DICOMGDCMTagCache::DICOMGDCMTagCache ( )
protected

◆ ~DICOMGDCMTagCache()

mitk::DICOMGDCMTagCache::~DICOMGDCMTagCache ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::DICOMGDCMTagCache::Clone ( ) const

◆ GetFrameInfoList()

DICOMDatasetAccessingImageFrameList mitk::DICOMGDCMTagCache::GetFrameInfoList ( ) const
overridevirtual

Retrieve the list of frame info objects from the scan result.

Returns
A list of DICOMDatasetAccessingImageFrameInfo smart pointers.

Implements mitk::DICOMTagCache.

◆ GetScanner()

const gdcm::Scanner& mitk::DICOMGDCMTagCache::GetScanner ( ) const

Get a const reference to the underlying gdcm::Scanner.

Returns
Const reference to the GDCM scanner.

◆ GetTagValue() [1/2]

DICOMDatasetFinding mitk::DICOMGDCMTagCache::GetTagValue ( DICOMImageFrameInfo *  frame,
const DICOMTag &  tag 
) const
overridevirtual

Retrieve a tag value for a specific frame and tag.

Parameters
[in]frameThe image frame to query.
[in]tagThe DICOM tag to retrieve.
Returns
A DICOMDatasetFinding with the tag value if found.
Exceptions
std::invalid_argumentif the frame or tag was not part of the scan.

Implements mitk::DICOMTagCache.

◆ GetTagValue() [2/2]

FindingsListType mitk::DICOMGDCMTagCache::GetTagValue ( DICOMImageFrameInfo *  frame,
const DICOMTagPath &  path 
) const
overridevirtual

Retrieve tag values for a specific frame and tag path.

Only supports explicit single-element paths (direct tag lookups).

Parameters
[in]frameThe image frame to query.
[in]pathThe DICOM tag path to retrieve.
Returns
A list of findings matching the given path.

Implements mitk::DICOMTagCache.

◆ InitCache()

void mitk::DICOMGDCMTagCache::InitCache ( const std::set< DICOMTag > &  scannedTags,
const std::shared_ptr< gdcm::Scanner > &  scanner,
const StringList &  inputFiles 
)

Initialize the cache with scan results from a gdcm::Scanner.

Parameters
[in]scannedTagsThe set of tags that were scanned.
[in]scannerShared pointer to the gdcm::Scanner containing the results.
[in]inputFilesThe list of input file paths that were scanned.

◆ mitkClassMacro()

mitk::DICOMGDCMTagCache::mitkClassMacro ( DICOMGDCMTagCache  ,
DICOMTagCache   
)

◆ New()

static Pointer mitk::DICOMGDCMTagCache::New ( )
static

Member Data Documentation

◆ m_ScannedTags

std::set<DICOMTag> mitk::DICOMGDCMTagCache::m_ScannedTags
protected

Definition at line 83 of file mitkDICOMGDCMTagCache.h.

◆ m_Scanner

std::shared_ptr<gdcm::Scanner> mitk::DICOMGDCMTagCache::m_Scanner
protected

Definition at line 85 of file mitkDICOMGDCMTagCache.h.

◆ m_ScanResult

DICOMDatasetAccessingImageFrameList mitk::DICOMGDCMTagCache::m_ScanResult
protected

Definition at line 87 of file mitkDICOMGDCMTagCache.h.


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