mitk::DICOMTagPath Class Reference

Class is used to identify (nested) attributes in a DICOM dataset. In contrast to the class DICOMTag, which only specifies one specific tag, the tag path can identify nested attributes (like items in a DICOM sequence). In addition you may also specify wildcards for the selection index or complete elements of the path. More...

#include <mitkDICOMTagPath.h>

Collaboration diagram for mitk::DICOMTagPath:

Classes
struct	NodeInfo

Public Types
typedef int	ItemSelectionIndex
typedef std::vector< NodeInfo >	NodeInfoVectorType
typedef NodeInfoVectorType::size_type	PathIndexType

Public Member Functions
bool	IsEmpty () const
bool	IsExplicit () const
bool	HasItemSelectionWildcardsOnly () const
PathIndexType	Size () const
PathIndexType	AddNode (const NodeInfo &newNode)
const NodeInfo &	GetNode (const PathIndexType &index) const
NodeInfo &	GetNode (const PathIndexType &index)
NodeInfo &	GetFirstNode ()
const NodeInfo &	GetFirstNode () const
NodeInfo &	GetLastNode ()
const NodeInfo &	GetLastNode () const
const NodeInfoVectorType &	GetNodes () const
std::string	ToStr () const
DICOMTagPath &	FromStr (const std::string &pathStr)
bool	operator== (const DICOMTagPath &path) const
bool	operator< (const DICOMTagPath &right) const
bool	Equals (const DICOMTagPath &path) const
DICOMTagPath &	operator= (const DICOMTagPath &path)
DICOMTagPath &	AddAnyElement ()
DICOMTagPath &	AddElement (unsigned int group, unsigned int element)
DICOMTagPath &	AddAnySelection (unsigned int group, unsigned int element)
DICOMTagPath &	AddSelection (unsigned int group, unsigned int element, ItemSelectionIndex index)
	DICOMTagPath ()
	DICOMTagPath (const DICOMTagPath &path)
	DICOMTagPath (const DICOMTag &tag)
	DICOMTagPath (unsigned int group, unsigned int element)
	~DICOMTagPath ()
virtual void	Reset ()

Static Protected Member Functions
static bool	DICOMTagPathesMatch (const DICOMTagPath &left, const DICOMTagPath &right)

Protected Attributes
NodeInfoVectorType	m_NodeInfos

Detailed Description

Class is used to identify (nested) attributes in a DICOM dataset. In contrast to the class DICOMTag, which only specifies one specific tag, the tag path can identify nested attributes (like items in a DICOM sequence). In addition you may also specify wildcards for the selection index or complete elements of the path.

Remarks

If you want to keep the DICOMTagPath compatible to the dcmtk search path format, you may not use element wild cards (this IsExplicit() or HasItemSelectionWildcardsOnly() must return true).

Definition at line 38 of file mitkDICOMTagPath.h.

Member Typedef Documentation

typedef int mitk::DICOMTagPath::ItemSelectionIndex

Definition at line 41 of file mitkDICOMTagPath.h.

typedef std::vector<NodeInfo> mitk::DICOMTagPath::NodeInfoVectorType

Definition at line 65 of file mitkDICOMTagPath.h.

typedef NodeInfoVectorType::size_type mitk::DICOMTagPath::PathIndexType

Definition at line 66 of file mitkDICOMTagPath.h.

Constructor & Destructor Documentation

mitk::DICOMTagPath::DICOMTagPath

(

)

Definition at line 365 of file mitkDICOMTagPath.cpp.

References Reset().

Referenced by mitk::PropertyNameToDICOMTagPath().

mitk::DICOMTagPath::DICOMTagPath

(

const DICOMTagPath &

path

)

Definition at line 371 of file mitkDICOMTagPath.cpp.

mitk::DICOMTagPath::DICOMTagPath

(

const DICOMTag &

tag

)

Definition at line 377 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::Element, and m_NodeInfos.

mitk::DICOMTagPath::DICOMTagPath ( unsigned int  group, unsigned int  element  )

explicit

Definition at line 382 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

mitk::DICOMTagPath::~DICOMTagPath

(

)

Definition at line 388 of file mitkDICOMTagPath.cpp.

Member Function Documentation

DICOMTagPath & mitk::DICOMTagPath::AddAnyElement

(

)

Definition at line 292 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::AnyElement, and m_NodeInfos.

Referenced by mitk::PropertyNameToDICOMTagPath().

DICOMTagPath & mitk::DICOMTagPath::AddAnySelection	(	unsigned int	group,
		unsigned int	element
	)

Definition at line 306 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::AnySelection, and m_NodeInfos.

Referenced by mitk::GetDefaultDICOMTagsOfInterest(), and mitk::PropertyNameToDICOMTagPath().

DICOMTagPath & mitk::DICOMTagPath::AddElement	(	unsigned int	group,
		unsigned int	element
	)

Definition at line 299 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::Element, and m_NodeInfos.

Referenced by DcmPathToTagPath(), and mitk::PropertyNameToDICOMTagPath().

DICOMTagPath::PathIndexType mitk::DICOMTagPath::AddNode

(

const NodeInfo &

newNode

)

Adds a new node to the end of the path.

Parameters

[in]

newNode

Reference to the node that should be added.

Returns

Returns the index of the newly added node.

Definition at line 135 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

Referenced by DcmPathToTagPath().

DICOMTagPath & mitk::DICOMTagPath::AddSelection	(	unsigned int	group,
		unsigned int	element,
		ItemSelectionIndex	index
	)

Definition at line 313 of file mitkDICOMTagPath.cpp.

References m_NodeInfos, and mitk::DICOMTagPath::NodeInfo::SequenceSelection.

Referenced by mitk::PropertyNameToDICOMTagPath().

bool mitk::DICOMTagPath::DICOMTagPathesMatch ( const DICOMTagPath &  left, const DICOMTagPath &  right  )

staticprotected

Definition at line 399 of file mitkDICOMTagPath.cpp.

References GetNodes().

Referenced by Equals().

bool mitk::DICOMTagPath::Equals

(

const DICOMTagPath &

path

)

const

Checks if to DICOMTagPathes are specify the same node. Hence all wildcards will be processed.
E.G.: "item1/child1/grandChild2" == ".//item1//grandChild2" is true.

Remarks

If you want to check if to pathes are "truely" equal and not only equal in terms of pointing to the same node, use the member function Equals()

Definition at line 275 of file mitkDICOMTagPath.cpp.

References DICOMTagPathesMatch().

Referenced by mitk::GetPropertyByDICOMTagPath(), and mitk::DICOMGenericImageFrameInfo::GetTagValueAsString().

DICOMTagPath & mitk::DICOMTagPath::FromStr

(

const std::string &

pathStr

)

Definition at line 321 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::AnyElement, mitk::DICOMTagPath::NodeInfo::AnySelection, mitk::DICOMTagPath::NodeInfo::Element, info(), m_NodeInfos, mitk::DICOMTagPath::NodeInfo::selection, mitk::DICOMTagPath::NodeInfo::SequenceSelection, mitk::DICOMTagPath::NodeInfo::tag, and mitk::DICOMTagPath::NodeInfo::type.

NodeInfo& mitk::DICOMTagPath::GetFirstNode

(

)

Function returns the node info of the first path node within the DICOMTagPath.

Precondition

DICOMTagPath must not be empty.

Returns

Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Referenced by mitk::DICOMGDCMTagScanner::AddTagPath(), mitk::DICOMGDCMTagCache::GetTagValue(), and mitk::DICOMGDCMImageFrameInfo::GetTagValueAsString().

const DICOMTagPath::NodeInfo & mitk::DICOMTagPath::GetFirstNode

(

)

const

Function returns the node info of the first path node within the DICOMTagPath.

Precondition

DICOMTagPath must not be empty.

Returns

Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 167 of file mitkDICOMTagPath.cpp.

References GetNode().

DICOMTagPath::NodeInfo & mitk::DICOMTagPath::GetLastNode

(

)

Function returns the node info of the last path node within the DICOMTagPath.

Precondition

DICOMTagPath must not be empty.

Returns

Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 181 of file mitkDICOMTagPath.cpp.

References GetNode(), and Size().

Referenced by mitk::DICOMTagsOfInterestService::AddTagOfInterest(), and DcmPathToTagPath().

const DICOMTagPath::NodeInfo & mitk::DICOMTagPath::GetLastNode

(

)

const

Function returns the node info of the last path node within the DICOMTagPath.

Precondition

DICOMTagPath must not be empty.

Returns

Info of the first path node. If the path is empty, an InvalidPathNode exception will be thrown.

Definition at line 174 of file mitkDICOMTagPath.cpp.

References GetNode(), and Size().

const DICOMTagPath::NodeInfo & mitk::DICOMTagPath::GetNode

(

const PathIndexType &

index

)

const

Function returns the node info of a path node specified by the index within the DICOMTagPath.

Precondition

Passed index must not be out of bound.

Parameters

[in]

index

Index of the node whose info should be retrieved.

Returns

Info of the specified path node. If the index is out of bound an InvalidPathNode exception will be thrown.

Definition at line 143 of file mitkDICOMTagPath.cpp.

References m_NodeInfos, mitkThrow, Size(), and ToStr().

Referenced by GetFirstNode(), and GetLastNode().

DICOMTagPath::NodeInfo & mitk::DICOMTagPath::GetNode

(

const PathIndexType &

index

)

Function returns the node info of a path node specified by the index within the DICOMTagPath.

Precondition

Passed index must not be out of bound.

Parameters

[in]

index

Index of the node whose info should be retrieved.

Returns

Info of the specified path node. If the index is out of bound an InvalidPathNode exception will be thrown.

Definition at line 155 of file mitkDICOMTagPath.cpp.

References m_NodeInfos, mitkThrow, Size(), and ToStr().

const DICOMTagPath::NodeInfoVectorType & mitk::DICOMTagPath::GetNodes

(

)

const

Definition at line 188 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

Referenced by DICOMTagPathesMatch(), mitk::DICOMTagPathToPersistenceKeyRegEx(), mitk::DICOMTagPathToPersistenceKeyTemplate(), mitk::DICOMTagPathToPersistenceNameTemplate(), mitk::DICOMTagPathToPropertyName(), and mitk::DICOMTagPathToPropertyRegEx().

bool mitk::DICOMTagPath::HasItemSelectionWildcardsOnly

(

)

const

Returns if the path has any nodes with item selection wild cards ([*]).

Definition at line 116 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::AnyElement, mitk::DICOMTagPath::NodeInfo::AnySelection, and m_NodeInfos.

Referenced by mitk::DICOMTagPathToDCMTKSearchPath().

bool mitk::DICOMTagPath::IsEmpty

(

)

const

Returns if the DICOMTagPath is empty.

Definition at line 97 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

Referenced by mitk::GetPropertyByDICOMTagPath().

bool mitk::DICOMTagPath::IsExplicit

(

)

const

Returns if the path is explicit (has no wildcards).

Definition at line 104 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::AnyElement, mitk::DICOMTagPath::NodeInfo::AnySelection, and m_NodeInfos.

Referenced by mitk::DICOMTagsOfInterestService::AddTagOfInterest(), mitk::DICOMGDCMTagScanner::AddTagPath(), mitk::DICOMTagPathToDCMTKSearchPath(), mitk::DICOMGDCMTagCache::GetTagValue(), mitk::DICOMGDCMImageFrameInfo::GetTagValueAsString(), and mitk::DICOMGenericImageFrameInfo::SetTagValue().

bool mitk::DICOMTagPath::operator<

(

const DICOMTagPath &

right

)

const

Operation equals like comparing the ToStr() results with operator <.

Definition at line 249 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

DICOMTagPath & mitk::DICOMTagPath::operator=

(

const DICOMTagPath &

path

)

Definition at line 282 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

bool mitk::DICOMTagPath::operator==

(

const DICOMTagPath &

path

)

const

Compares two DICOMTagPaths for real equality. So its a string compare of their string conversion

Definition at line 242 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

void mitk::DICOMTagPath::Reset ( )

virtual

Definition at line 392 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

Referenced by DICOMTagPath().

DICOMTagPath::PathIndexType mitk::DICOMTagPath::Size

(

)

const

Number of path nodes the DICOMTagPath contains.

Definition at line 128 of file mitkDICOMTagPath.cpp.

References m_NodeInfos.

Referenced by mitk::DICOMTagsOfInterestService::AddTagOfInterest(), mitk::DICOMGDCMTagScanner::AddTagPath(), DcmPathToTagPath(), GetLastNode(), GetNode(), mitk::DICOMGDCMTagCache::GetTagValue(), mitk::DICOMGDCMImageFrameInfo::GetTagValueAsString(), and ToStr().

std::string mitk::DICOMTagPath::ToStr

(

)

const

Definition at line 195 of file mitkDICOMTagPath.cpp.

References mitk::DICOMTagPath::NodeInfo::AnyElement, mitk::DICOMTagPath::NodeInfo::AnySelection, mitk::DICOMTagPath::NodeInfo::Invalid, m_NodeInfos, mitk::DICOMTagPath::NodeInfo::SequenceSelection, and Size().

Referenced by mitk::DICOMGDCMTagScanner::AddTagPath(), mitk::DICOMTagPathToDCMTKSearchPath(), GetNode(), mitk::operator<<(), and mitk::DICOMGenericImageFrameInfo::SetTagValue().

Member Data Documentation

NodeInfoVectorType mitk::DICOMTagPath::m_NodeInfos

protected

Definition at line 154 of file mitkDICOMTagPath.h.

Referenced by AddAnyElement(), AddAnySelection(), AddElement(), AddNode(), AddSelection(), DICOMTagPath(), FromStr(), GetNode(), GetNodes(), HasItemSelectionWildcardsOnly(), IsEmpty(), IsExplicit(), operator<(), operator=(), operator==(), Reset(), Size(), and ToStr().

---

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

• mitkDICOMTagPath.h
• mitkDICOMTagPath.cpp