Medical Imaging Interaction Toolkit  2023.12.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 &) 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...
 
void SetTagValue (const DICOMTagPath &path, const std::string &value)
 
- 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 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
 
- 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

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

Definition at line 26 of file mitkDICOMGenericImageFrameInfo.h.

Member Typedef Documentation

◆ ValueMapType

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

Definition at line 52 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 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::DICOMGenericImageFrameInfo::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::DICOMGenericImageFrameInfo::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::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 
)

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

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 53 of file mitkDICOMGenericImageFrameInfo.h.

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