Medical Imaging Interaction Toolkit  2023.12.99-101158b3
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 &) const override
 Return a DICOMDatasetFinding instance of the tag. The return contains (if valid) the raw value of the tag as a string. More...
 
FindingsListType GetTagValueAsString (const DICOMTagPath &path) const override
 Return a list of DICOMDatasetFindings of the passed tag path. The return contains (if valid) the raw value of the tag as a string. More...
 
std::string GetFilenameIfAvailable () const override
 Return a filename if possible. If DICOM is not read from file but from somewhere else (network, database), we might not have files. 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
 
- 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< DICOMDatasetFindingFindingsListType
 
- Public Attributes inherited from mitk::DICOMImageFrameInfo
const std::string Filename
 absolute filename More...
 
const unsigned int FrameNo
 frame number, 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 a filename if possible. If DICOM is not read from file but from somewhere else (network, database), we might not have files.

Implements mitk::DICOMDatasetAccess.

◆ GetTagValueAsString() [1/2]

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

Return a DICOMDatasetFinding instance of the tag. The return contains (if valid) the raw value of the tag as a string.

Parameters
tagTag which value should be retrieved.

Implements mitk::DICOMDatasetAccess.

◆ GetTagValueAsString() [2/2]

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

Return a list of DICOMDatasetFindings of the passed tag path. The return contains (if valid) the raw value of the tag as a string.

Parameters
pathTag path which value should be retrieved.

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 54 of file mitkDICOMGDCMImageFrameInfo.h.


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