Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
mitk::DICOMGenericImageFrameInfo Class Reference
MITK Modules » The DICOM Module

A generic storage class for image frame info with data access. More...

#include <mitkDICOMGenericImageFrameInfo.h>

Inheritance diagram for mitk::DICOMGenericImageFrameInfo:
Inheritance graph
[legend]
Collaboration diagram for mitk::DICOMGenericImageFrameInfo:
Collaboration graph
[legend]

Public Member Functions

 mitkClassMacro (DICOMGenericImageFrameInfo, DICOMDatasetAccessingImageFrameInfo)
 
 mitkNewMacro1Param (DICOMGenericImageFrameInfo, const std::string &)
 
 mitkNewMacro2Param (DICOMGenericImageFrameInfo, const std::string &, unsigned int)
 
 mitkNewMacro1Param (DICOMGenericImageFrameInfo, const DICOMImageFrameInfo::Pointer &)
 
 ~DICOMGenericImageFrameInfo () override
 
DICOMDatasetFinding GetTagValueAsString (const DICOMTag &tag) const override
 Retrieve a tag value as a string for a single DICOM tag. More...
 
FindingsListType GetTagValueAsString (const DICOMTagPath &path) const override
 Retrieve tag values as strings for a DICOM tag path. More...
 
std::string GetFilenameIfAvailable () const override
 Return the filename of this frame if available. More...
 
void SetTagValue (const DICOMTagPath &path, const std::string &value)
 Set the value for a given tag path. 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 Types

typedef std::map< DICOMTagPath, std::string > ValueMapType
 

Protected Member Functions

 DICOMGenericImageFrameInfo (const DICOMImageFrameInfo::Pointer &frameinfo)
 
 DICOMGenericImageFrameInfo (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

ValueMapType m_Values
 

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

A generic storage class for image frame info with data access.

This class stores DICOM tag values in an internal map structure and provides access via the DICOMDatasetAccess interface. It is used by DICOMGenericTagCache and DICOMDCMTKTagScanner as a flexible, library-independent frame info container.

See also
DICOMDatasetAccessingImageFrameInfo, DICOMGenericTagCache, DICOMGDCMImageFrameInfo

Definition at line 32 of file mitkDICOMGenericImageFrameInfo.h.

Member Typedef Documentation

◆ ValueMapType

typedef std::map<DICOMTagPath, std::string> mitk::DICOMGenericImageFrameInfo::ValueMapType
protected

Definition at line 77 of file mitkDICOMGenericImageFrameInfo.h.

Constructor & Destructor Documentation

◆ ~DICOMGenericImageFrameInfo()

mitk::DICOMGenericImageFrameInfo::~DICOMGenericImageFrameInfo ( )
override

◆ DICOMGenericImageFrameInfo() [1/2]

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

◆ DICOMGenericImageFrameInfo() [2/2]

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

Member Function Documentation

◆ GetFilenameIfAvailable()

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

Return the filename of this frame if available.

Returns
The filename or an empty string.

Implements mitk::DICOMDatasetAccess.

◆ GetTagValueAsString() [1/2]

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

Retrieve a tag value as a string for a single DICOM tag.

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

Implements mitk::DICOMDatasetAccess.

◆ GetTagValueAsString() [2/2]

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

Retrieve tag values as strings for a DICOM tag path.

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

Implements mitk::DICOMDatasetAccess.

◆ mitkClassMacro()

mitk::DICOMGenericImageFrameInfo::mitkClassMacro ( DICOMGenericImageFrameInfo  ,
DICOMDatasetAccessingImageFrameInfo   
)

◆ mitkNewMacro1Param() [1/2]

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

◆ mitkNewMacro1Param() [2/2]

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

◆ mitkNewMacro2Param()

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

◆ New()

static Pointer mitk::DICOMGenericImageFrameInfo::New ( )
static

◆ SetTagValue()

void mitk::DICOMGenericImageFrameInfo::SetTagValue ( const DICOMTagPath &  path,
const std::string &  value 
)

Set the value for a given tag path.

If the tag path is already set, it will be overwritten with the new value.

Parameters
[in]pathThe tag path to set. Must be explicit (no wildcards).
[in]valueThe string value to store.
Precondition
Path must be explicit. No wildcards are allowed.
Postcondition
The passed value is set for the passed path.

Member Data Documentation

◆ m_Values

ValueMapType mitk::DICOMGenericImageFrameInfo::m_Values
protected

Definition at line 78 of file mitkDICOMGenericImageFrameInfo.h.

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