mitk::DICOMTagCache Class Reference

Abstract base class for caching DICOM tag values scanned from files. More...

#include <mitkDICOMTagCache.h>

Inheritance diagram for mitk::DICOMTagCache:

Collaboration diagram for mitk::DICOMTagCache:

Public Types
typedef std::list< DICOMDatasetFinding >	FindingsListType
	A list of DICOMDatasetFinding instances. More...

Public Member Functions
	mitkClassMacroItkParent (DICOMTagCache, itk::Object)
virtual void	SetInputFiles (const StringList &filenames)
	Define the list of files that were scanned to populate the cache. More...
virtual DICOMDatasetFinding	GetTagValue (DICOMImageFrameInfo *frame, const DICOMTag &tag) const =0
	Retrieve a tag value for a specific frame and tag. More...
virtual FindingsListType	GetTagValue (DICOMImageFrameInfo *frame, const DICOMTagPath &path) const =0
	Retrieve tag values for a specific frame and tag path. More...
virtual DICOMDatasetAccessingImageFrameList	GetFrameInfoList () const =0
	Retrieve a result list for file-by-file tag access. More...

Protected Member Functions
	DICOMTagCache ()
	DICOMTagCache (const DICOMTagCache &)
	~DICOMTagCache () override

Protected Attributes
StringList	m_InputFilenames

Detailed Description

Abstract base class for caching DICOM tag values scanned from files.

A DICOMTagCache stores the results of a tag scanning process and provides fast access to tag values for individual frames. Concrete implementations include DICOMGDCMTagCache (GDCM-based) and DICOMGenericTagCache (generic storage).

See also

DICOMTagScanner, DICOMGDCMTagCache, DICOMGenericTagCache

Definition at line 39 of file mitkDICOMTagCache.h.

Member Typedef Documentation

FindingsListType

typedef std::list<DICOMDatasetFinding> mitk::DICOMTagCache::FindingsListType

A list of DICOMDatasetFinding instances.

Definition at line 45 of file mitkDICOMTagCache.h.

Constructor & Destructor Documentation

DICOMTagCache() [1/2]

mitk::DICOMTagCache::DICOMTagCache ( )

protected

DICOMTagCache() [2/2]

mitk::DICOMTagCache::DICOMTagCache ( const DICOMTagCache &  )

protected

~DICOMTagCache()

mitk::DICOMTagCache::~DICOMTagCache ( )

overrideprotected

Member Function Documentation

GetFrameInfoList()

virtual DICOMDatasetAccessingImageFrameList mitk::DICOMTagCache::GetFrameInfoList ( ) const

pure virtual

Retrieve a result list for file-by-file tag access.

Returns

A list of DICOMDatasetAccessingImageFrameInfo instances, one per scanned file.

Implemented in mitk::DICOMGenericTagCache, and mitk::DICOMGDCMTagCache.

GetTagValue() [1/2]

virtual DICOMDatasetFinding mitk::DICOMTagCache::GetTagValue ( DICOMImageFrameInfo *  frame, const DICOMTag &  tag  ) const

pure virtual

Retrieve a tag value for a specific frame and tag.

Parameters

[in]	frame	The image frame to query.
[in]	tag	The DICOM tag to retrieve.

Returns

A DICOMDatasetFinding with the tag value if found.

Implemented in mitk::DICOMGenericTagCache, and mitk::DICOMGDCMTagCache.

GetTagValue() [2/2]

virtual FindingsListType mitk::DICOMTagCache::GetTagValue ( DICOMImageFrameInfo *  frame, const DICOMTagPath &  path  ) const

pure virtual

Retrieve tag values for a specific frame and tag path.

Parameters

[in]	frame	The image frame to query.
[in]	path	The DICOM tag path to retrieve.

Returns

A list of findings matching the given path.

Implemented in mitk::DICOMGenericTagCache, and mitk::DICOMGDCMTagCache.

mitkClassMacroItkParent()

mitk::DICOMTagCache::mitkClassMacroItkParent	(	DICOMTagCache	,
		itk::Object
	)

SetInputFiles()

virtual void mitk::DICOMTagCache::SetInputFiles ( const StringList &  filenames )

virtual

Define the list of files that were scanned to populate the cache.

Parameters

[in]

filenames

The list of absolute file paths.

Member Data Documentation

m_InputFilenames

StringList mitk::DICOMTagCache::m_InputFilenames

protected

Definition at line 77 of file mitkDICOMTagCache.h.

---

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

• mitkDICOMTagCache.h