Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::DICOMGenericImageFrameInfo Class Reference

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

#include <mitkDICOMGenericImageFrameInfo.h>

Inheritance diagram for mitk::DICOMGenericImageFrameInfo:
Collaboration diagram for mitk::DICOMGenericImageFrameInfo:

Public Member Functions

 mitkClassMacro (DICOMGenericImageFrameInfo, DICOMDatasetAccessingImageFrameInfo)
 
 mitkNewMacro1Param (DICOMGenericImageFrameInfo, const std::string &)
 
 mitkNewMacro2Param (DICOMGenericImageFrameInfo, const std::string &, unsigned int)
 
 mitkNewMacro1Param (DICOMGenericImageFrameInfo, const DICOMImageFrameInfo::Pointer &)
 
virtual ~DICOMGenericImageFrameInfo ()
 
virtual DICOMDatasetFinding GetTagValueAsString (const DICOMTag &) const override
 Return a DICOMDatasetFinding instance of the tag. The return containes (if valid) the raw value of the tag as a string. More...
 
virtual FindingsListType GetTagValueAsString (const DICOMTagPath &path) const override
 Return a list of DICOMDatasetFindings of the passed tag path. The return containes (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) static Pointer New()
 
 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 ()
 

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)
 
virtual ~DICOMDatasetAccessingImageFrameInfo ()
 
- 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< 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

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

Definition at line 30 of file mitkDICOMGenericImageFrameInfo.h.

Member Typedef Documentation

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

Definition at line 56 of file mitkDICOMGenericImageFrameInfo.h.

Constructor & Destructor Documentation

mitk::DICOMGenericImageFrameInfo::~DICOMGenericImageFrameInfo ( )
virtual

Definition at line 33 of file mitkDICOMGenericImageFrameInfo.cpp.

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

Definition at line 27 of file mitkDICOMGenericImageFrameInfo.cpp.

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

Definition at line 21 of file mitkDICOMGenericImageFrameInfo.cpp.

Member Function Documentation

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.

Definition at line 84 of file mitkDICOMGenericImageFrameInfo.cpp.

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

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

Parameters
tagTag which value should be retreived.

Implements mitk::DICOMDatasetAccess.

Definition at line 39 of file mitkDICOMGenericImageFrameInfo.cpp.

References mitk::DICOMDatasetFinding::isValid, mitk::DICOMDatasetFinding::path, and mitk::DICOMDatasetFinding::value.

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

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

Parameters
pathTag path which value should be retreived.

Implements mitk::DICOMDatasetAccess.

Definition at line 56 of file mitkDICOMGenericImageFrameInfo.cpp.

References mitk::DICOMTagPath::Equals().

mitk::DICOMGenericImageFrameInfo::mitkClassMacro ( DICOMGenericImageFrameInfo  ,
DICOMDatasetAccessingImageFrameInfo   
)
mitk::DICOMGenericImageFrameInfo::mitkNewMacro1Param ( DICOMGenericImageFrameInfo  ,
const std::string &   
)
mitk::DICOMGenericImageFrameInfo::mitkNewMacro1Param ( DICOMGenericImageFrameInfo  ,
const DICOMImageFrameInfo::Pointer &   
)
mitk::DICOMGenericImageFrameInfo::mitkNewMacro2Param ( DICOMGenericImageFrameInfo  ,
const std::string &  ,
unsigned  int 
)
static Pointer mitk::DICOMGenericImageFrameInfo::New ( )
static
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 allowd.
Postcondition
The passed value is set for the passed path.

Definition at line 72 of file mitkDICOMGenericImageFrameInfo.cpp.

References mitk::DICOMTagPath::IsExplicit(), mitkThrow, and mitk::DICOMTagPath::ToStr().

Member Data Documentation

ValueMapType mitk::DICOMGenericImageFrameInfo::m_Values
protected

Definition at line 57 of file mitkDICOMGenericImageFrameInfo.h.


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