Medical Imaging Interaction Toolkit  2018.4.99-3e3f1a6e
Medical Imaging Interaction Toolkit
mitk::DICOMDCMTKTagScanner Class Reference

Encapsulates the tag scanning process for a set of DICOM files. More...

#include <mitkDICOMDCMTKTagScanner.h>

Inheritance diagram for mitk::DICOMDCMTKTagScanner:
Collaboration diagram for mitk::DICOMDCMTKTagScanner:

Public Member Functions

 mitkClassMacro (DICOMDCMTKTagScanner, 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 pathes 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...
 
- Public Member Functions inherited from mitk::DICOMTagScanner
 mitkClassMacroItkParent (DICOMTagScanner, itk::Object)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 DICOMDCMTKTagScanner ()
 
 ~DICOMDCMTKTagScanner () 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< DICOMTagPathm_ScannedTags
 
StringList m_InputFilenames
 
DICOMGenericTagCache::Pointer m_Cache
 

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.

For the scanning process it uses DCMTK functionality.

Definition at line 31 of file mitkDICOMDCMTKTagScanner.h.

Constructor & Destructor Documentation

◆ DICOMDCMTKTagScanner()

mitk::DICOMDCMTKTagScanner::DICOMDCMTKTagScanner ( )
protected

Definition at line 19 of file mitkDICOMDCMTKTagScanner.cpp.

◆ ~DICOMDCMTKTagScanner()

mitk::DICOMDCMTKTagScanner::~DICOMDCMTKTagScanner ( )
overrideprotected

Definition at line 23 of file mitkDICOMDCMTKTagScanner.cpp.

Member Function Documentation

◆ AddTag()

void mitk::DICOMDCMTKTagScanner::AddTag ( const DICOMTag tag)
overridevirtual

Add this tag to the scanning process.

Implements mitk::DICOMTagScanner.

Definition at line 27 of file mitkDICOMDCMTKTagScanner.cpp.

References m_ScannedTags.

Referenced by AddTags().

◆ AddTagPath()

void mitk::DICOMDCMTKTagScanner::AddTagPath ( const DICOMTagPath tag)
overridevirtual

Add this tag path to the scanning process.

Implements mitk::DICOMTagScanner.

Definition at line 40 of file mitkDICOMDCMTKTagScanner.cpp.

References m_ScannedTags.

Referenced by AddTagPaths().

◆ AddTagPaths()

void mitk::DICOMDCMTKTagScanner::AddTagPaths ( const DICOMTagPathList tags)
overridevirtual

Add a list of tag pathes to the scanning process.

Implements mitk::DICOMTagScanner.

Definition at line 45 of file mitkDICOMDCMTKTagScanner.cpp.

References AddTagPath().

◆ AddTags()

void mitk::DICOMDCMTKTagScanner::AddTags ( const DICOMTagList tags)
overridevirtual

Add a list of tags to the scanning process.

Implements mitk::DICOMTagScanner.

Definition at line 32 of file mitkDICOMDCMTKTagScanner.cpp.

References AddTag().

◆ Clone()

Pointer mitk::DICOMDCMTKTagScanner::Clone ( ) const

◆ GetFrameInfoList()

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

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

Implements mitk::DICOMTagScanner.

Definition at line 177 of file mitkDICOMDCMTKTagScanner.cpp.

References m_Cache.

◆ GetScanCache()

mitk::DICOMTagCache::Pointer mitk::DICOMDCMTKTagScanner::GetScanCache ( ) const
overridevirtual

Retrieve Pointer to the complete cache of the scan.

Implements mitk::DICOMTagScanner.

Definition at line 172 of file mitkDICOMDCMTKTagScanner.cpp.

References m_Cache.

◆ mitkClassMacro()

mitk::DICOMDCMTKTagScanner::mitkClassMacro ( DICOMDCMTKTagScanner  ,
DICOMTagScanner   
)

◆ New()

◆ Scan()

void mitk::DICOMDCMTKTagScanner::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.

Definition at line 101 of file mitkDICOMDCMTKTagScanner.cpp.

References DcmPathToTagPath(), mitk::DICOMTagPathToDCMTKSearchPath(), info(), m_Cache, m_InputFilenames, m_ScannedTags, MITK_ERROR, mitk::DICOMGenericImageFrameInfo::New(), mitk::DICOMGenericTagCache::New(), mitk::DICOMTagScanner::PopLocale(), and mitk::DICOMTagScanner::PushLocale().

◆ SetInputFiles()

void mitk::DICOMDCMTKTagScanner::SetInputFiles ( const StringList filenames)
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.

Definition at line 53 of file mitkDICOMDCMTKTagScanner.cpp.

References m_InputFilenames.

Member Data Documentation

◆ m_Cache

DICOMGenericTagCache::Pointer mitk::DICOMDCMTKTagScanner::m_Cache
protected

Definition at line 88 of file mitkDICOMDCMTKTagScanner.h.

Referenced by GetFrameInfoList(), GetScanCache(), and Scan().

◆ m_InputFilenames

StringList mitk::DICOMDCMTKTagScanner::m_InputFilenames
protected

Definition at line 87 of file mitkDICOMDCMTKTagScanner.h.

Referenced by Scan(), and SetInputFiles().

◆ m_ScannedTags

std::set<DICOMTagPath> mitk::DICOMDCMTKTagScanner::m_ScannedTags
protected

Definition at line 86 of file mitkDICOMDCMTKTagScanner.h.

Referenced by AddTag(), AddTagPath(), and Scan().


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