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

The dataset access implementation for DICOMITKSeriesGDCMReader, based on GDCM. More...

#include <mitkDICOMGDCMImageFrameInfo.h>

Inheritance diagram for mitk::DICOMGDCMImageFrameInfo:
Collaboration diagram for mitk::DICOMGDCMImageFrameInfo:

Public Member Functions

 mitkClassMacro (DICOMGDCMImageFrameInfo, DICOMDatasetAccessingImageFrameInfo)
 
 mitkNewMacro1Param (DICOMGDCMImageFrameInfo, const std::string &)
 
 mitkNewMacro2Param (DICOMGDCMImageFrameInfo, const std::string &, unsigned int)
 
 mitkNewMacro1Param (DICOMGDCMImageFrameInfo, const DICOMImageFrameInfo::Pointer &)
 
 mitkNewMacro2Param (DICOMGDCMImageFrameInfo, const DICOMImageFrameInfo::Pointer &, gdcm::Scanner::TagToValue const &)
 
 ~DICOMGDCMImageFrameInfo () override
 
DICOMDatasetFinding GetTagValueAsString (const DICOMTag &tag) const override
 Retrieve a tag value as a string from the GDCM scanner results. More...
 
FindingsListType GetTagValueAsString (const DICOMTagPath &path) const override
 Retrieve tag values as strings for a DICOM tag path from the GDCM scanner. More...
 
std::string GetFilenameIfAvailable () const override
 Return the filename of this frame. More...
 
- Public Member Functions inherited from mitk::DICOMDatasetAccessingImageFrameInfo
 mitkClassMacro (DICOMDatasetAccessingImageFrameInfo, DICOMImageFrameInfo)
 
- Public Member Functions inherited from mitk::DICOMImageFrameInfo
 mitkClassMacroItkParent (DICOMImageFrameInfo, itk::LightObject)
 
 mitkNewMacro1Param (DICOMImageFrameInfo, const std::string &)
 
 mitkNewMacro2Param (DICOMImageFrameInfo, const std::string &, unsigned int)
 
bool operator== (const DICOMImageFrameInfo &other) const
 Equality comparison based on filename and frame number. More...
 
- Public Member Functions inherited from mitk::DICOMDatasetAccess
virtual ~DICOMDatasetAccess ()
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::DICOMImageFrameInfo
static Pointer New ()
 

Protected Member Functions

 DICOMGDCMImageFrameInfo (const DICOMImageFrameInfo::Pointer &frameinfo)
 
 DICOMGDCMImageFrameInfo (const DICOMImageFrameInfo::Pointer &frameinfo, gdcm::Scanner::TagToValue const &tagToValueMapping)
 
 DICOMGDCMImageFrameInfo (const std::string &filename="", unsigned int frameNo=0)
 
- Protected Member Functions inherited from mitk::DICOMDatasetAccessingImageFrameInfo
 DICOMDatasetAccessingImageFrameInfo (const std::string &filename="", unsigned int frameNo=0)
 
 ~DICOMDatasetAccessingImageFrameInfo () override
 
- Protected Member Functions inherited from mitk::DICOMImageFrameInfo
 DICOMImageFrameInfo (const std::string &filename="", unsigned int frameNo=0)
 

Protected Attributes

const gdcm::Scanner::TagToValue m_TagForValue
 

Additional Inherited Members

- Public Types inherited from mitk::DICOMDatasetAccess
typedef std::list< DICOMDatasetFinding > FindingsListType
 A list of DICOMDatasetFinding instances. More...
 
- Public Attributes inherited from mitk::DICOMImageFrameInfo
const std::string Filename
 Absolute filename of the DICOM file. More...
 
const unsigned int FrameNo
 Frame number within the file, starting with 0. More...
 

Detailed Description

The dataset access implementation for DICOMITKSeriesGDCMReader, based on GDCM.

This class combines a DICOMImageFrameInfo object with the scanning results from gdcm::Scanner. The scanning results will be used to implement the tag access methods of DICOMDatasetAccess.

Definition at line 30 of file mitkDICOMGDCMImageFrameInfo.h.

Constructor & Destructor Documentation

◆ ~DICOMGDCMImageFrameInfo()

mitk::DICOMGDCMImageFrameInfo::~DICOMGDCMImageFrameInfo ( )
override

◆ DICOMGDCMImageFrameInfo() [1/3]

mitk::DICOMGDCMImageFrameInfo::DICOMGDCMImageFrameInfo ( const DICOMImageFrameInfo::Pointer &  frameinfo)
explicitprotected

◆ DICOMGDCMImageFrameInfo() [2/3]

mitk::DICOMGDCMImageFrameInfo::DICOMGDCMImageFrameInfo ( const DICOMImageFrameInfo::Pointer &  frameinfo,
gdcm::Scanner::TagToValue const &  tagToValueMapping 
)
protected

◆ DICOMGDCMImageFrameInfo() [3/3]

mitk::DICOMGDCMImageFrameInfo::DICOMGDCMImageFrameInfo ( const std::string &  filename = "",
unsigned int  frameNo = 0 
)
protected

Member Function Documentation

◆ GetFilenameIfAvailable()

std::string mitk::DICOMGDCMImageFrameInfo::GetFilenameIfAvailable ( ) const
overridevirtual

Return the filename of this frame.

Returns
The absolute filename of this DICOM frame.

Implements mitk::DICOMDatasetAccess.

◆ GetTagValueAsString() [1/2]

DICOMDatasetFinding mitk::DICOMGDCMImageFrameInfo::GetTagValueAsString ( const DICOMTag &  tag) const
overridevirtual

Retrieve a tag value as a string from the GDCM scanner results.

Parameters
[in]tagThe DICOM tag to query.
Returns
A DICOMDatasetFinding with the value if found.

Implements mitk::DICOMDatasetAccess.

◆ GetTagValueAsString() [2/2]

FindingsListType mitk::DICOMGDCMImageFrameInfo::GetTagValueAsString ( const DICOMTagPath &  path) const
overridevirtual

Retrieve tag values as strings for a DICOM tag path from the GDCM scanner.

Parameters
[in]pathThe tag path to query.
Returns
A list of findings matching the path.

Implements mitk::DICOMDatasetAccess.

◆ mitkClassMacro()

mitk::DICOMGDCMImageFrameInfo::mitkClassMacro ( DICOMGDCMImageFrameInfo  ,
DICOMDatasetAccessingImageFrameInfo   
)

◆ mitkNewMacro1Param() [1/2]

mitk::DICOMGDCMImageFrameInfo::mitkNewMacro1Param ( DICOMGDCMImageFrameInfo  ,
const DICOMImageFrameInfo::Pointer &   
)

◆ mitkNewMacro1Param() [2/2]

mitk::DICOMGDCMImageFrameInfo::mitkNewMacro1Param ( DICOMGDCMImageFrameInfo  ,
const std::string &   
)

◆ mitkNewMacro2Param() [1/2]

mitk::DICOMGDCMImageFrameInfo::mitkNewMacro2Param ( DICOMGDCMImageFrameInfo  ,
const DICOMImageFrameInfo::Pointer &  ,
gdcm::Scanner::TagToValue const &   
)

◆ mitkNewMacro2Param() [2/2]

mitk::DICOMGDCMImageFrameInfo::mitkNewMacro2Param ( DICOMGDCMImageFrameInfo  ,
const std::string &  ,
unsigned int   
)

◆ New()

static Pointer mitk::DICOMGDCMImageFrameInfo::New ( )
static

Member Data Documentation

◆ m_TagForValue

const gdcm::Scanner::TagToValue mitk::DICOMGDCMImageFrameInfo::m_TagForValue
protected

Definition at line 68 of file mitkDICOMGDCMImageFrameInfo.h.


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