mitk::DICOMSortByTag Class Reference

Compare two datasets by the value of a single tag (for use in DICOMTagBasedSorter). More...

#include <mitkDICOMSortByTag.h>

Inheritance diagram for mitk::DICOMSortByTag:

Collaboration diagram for mitk::DICOMSortByTag:

Public Member Functions
	mitkClassMacro (DICOMSortByTag, DICOMSortCriterion)
	mitkNewMacro1Param (DICOMSortByTag, const DICOMTag &)
	mitkNewMacro2Param (DICOMSortByTag, const DICOMTag &, DICOMSortCriterion::Pointer)
virtual DICOMTagList	GetTagsOfInterest () const override
	Tags used for comparison. More...
virtual bool	IsLeftBeforeRight (const mitk::DICOMDatasetAccess *left, const mitk::DICOMDatasetAccess *right) const override
	Answer the sorting question. More...
virtual double	NumericDistance (const mitk::DICOMDatasetAccess *from, const mitk::DICOMDatasetAccess *to) const override
	Calculate a distance between two datasets. This ansers the question of consecutive datasets. More...
virtual void	Print (std::ostream &os) const override
	brief describe this class in given stream. More...
virtual bool	operator== (const DICOMSortCriterion &other) const override
Public Member Functions inherited from mitk::DICOMSortCriterion
	mitkClassMacroItkParent (DICOMSortCriterion, itk::LightObject)
DICOMTagList	GetAllTagsOfInterest () const
	Tags used for comparison (includes seconary criteria). More...
DICOMSortCriterion::ConstPointer	GetSecondaryCriterion () const
	The fallback criterion. More...

Protected Member Functions
	DICOMSortByTag (const DICOMTag &tag, DICOMSortCriterion::Pointer secondaryCriterion=nullptr)
virtual	~DICOMSortByTag ()
	DICOMSortByTag (const DICOMSortByTag &other)
DICOMSortByTag &	operator= (const DICOMSortByTag &other)
bool	StringCompare (const mitk::DICOMDatasetAccess *left, const mitk::DICOMDatasetAccess *right, const DICOMTag &tag) const
bool	NumericCompare (const mitk::DICOMDatasetAccess *left, const mitk::DICOMDatasetAccess *right, const DICOMTag &tag) const
Protected Member Functions inherited from mitk::DICOMSortCriterion
	DICOMSortCriterion (DICOMSortCriterion::Pointer secondaryCriterion)
virtual	~DICOMSortCriterion ()
bool	NextLevelIsLeftBeforeRight (const mitk::DICOMDatasetAccess *left, const mitk::DICOMDatasetAccess *right) const
	DICOMSortCriterion (const DICOMSortCriterion &other)
DICOMSortCriterion &	operator= (const DICOMSortCriterion &other)

Additional Inherited Members
Protected Attributes inherited from mitk::DICOMSortCriterion
DICOMSortCriterion::Pointer	m_SecondaryCriterion

Detailed Description

Compare two datasets by the value of a single tag (for use in DICOMTagBasedSorter).

The class will compare the tag values by

1. numerical value if possible (i.e. both datasets have a value that is numerical)
2. alphabetical order otherwise

If the comparison results in equalness, it is refered to the secondary criterion, see DICOMSortByTag::NextLevelIsLeftBeforeRight().

Definition at line 37 of file mitkDICOMSortByTag.h.

Constructor & Destructor Documentation

mitk::DICOMSortByTag::DICOMSortByTag ( const DICOMTag &  tag, DICOMSortCriterion::Pointer  secondaryCriterion = nullptr  )

protected

Definition at line 22 of file mitkDICOMSortByTag.cpp.

mitk::DICOMSortByTag::~DICOMSortByTag ( )

protectedvirtual

Definition at line 29 of file mitkDICOMSortByTag.cpp.

mitk::DICOMSortByTag::DICOMSortByTag ( const DICOMSortByTag &  other )

protected

Definition at line 34 of file mitkDICOMSortByTag.cpp.

Member Function Documentation

mitk::DICOMTagList mitk::DICOMSortByTag::GetTagsOfInterest ( ) const

overridevirtual

Tags used for comparison.

Implements mitk::DICOMSortCriterion.

Definition at line 82 of file mitkDICOMSortByTag.cpp.

bool mitk::DICOMSortByTag::IsLeftBeforeRight ( const mitk::DICOMDatasetAccess *  left, const mitk::DICOMDatasetAccess *  right  ) const

overridevirtual

Answer the sorting question.

Implements mitk::DICOMSortCriterion.

Definition at line 91 of file mitkDICOMSortByTag.cpp.

mitk::DICOMSortByTag::mitkClassMacro	(	DICOMSortByTag	,
		DICOMSortCriterion
	)

mitk::DICOMSortByTag::mitkNewMacro1Param	(	DICOMSortByTag	,
		const DICOMTag &
	)

mitk::DICOMSortByTag::mitkNewMacro2Param	(	DICOMSortByTag	,
		const DICOMTag &	,
		DICOMSortCriterion::Pointer
	)

bool mitk::DICOMSortByTag::NumericCompare ( const mitk::DICOMDatasetAccess *  left, const mitk::DICOMDatasetAccess *  right, const DICOMTag &  tag  ) const

protected

Definition at line 119 of file mitkDICOMSortByTag.cpp.

References mitk::DICOMDatasetAccess::GetTagValueAsString(), and mitk::DICOMDatasetFinding::value.

double mitk::DICOMSortByTag::NumericDistance ( const mitk::DICOMDatasetAccess *  from, const mitk::DICOMDatasetAccess *  to  ) const

overridevirtual

Calculate a distance between two datasets. This ansers the question of consecutive datasets.

Implements mitk::DICOMSortCriterion.

Definition at line 155 of file mitkDICOMSortByTag.cpp.

References mitk::DICOMDatasetAccess::GetTagValueAsString(), MITK_WARN, and mitk::DICOMDatasetFinding::value.

mitk::DICOMSortByTag & mitk::DICOMSortByTag::operator= ( const DICOMSortByTag &  other )

protected

Definition at line 42 of file mitkDICOMSortByTag.cpp.

References mitk::DICOMSortCriterion::operator=().

bool mitk::DICOMSortByTag::operator== ( const DICOMSortCriterion &  other ) const

overridevirtual

Implements mitk::DICOMSortCriterion.

Definition at line 54 of file mitkDICOMSortByTag.cpp.

void mitk::DICOMSortByTag::Print ( std::ostream &  os ) const

overridevirtual

brief describe this class in given stream.

Implements mitk::DICOMSortCriterion.

Definition at line 74 of file mitkDICOMSortByTag.cpp.

bool mitk::DICOMSortByTag::StringCompare ( const mitk::DICOMDatasetAccess *  left, const mitk::DICOMDatasetAccess *  right, const DICOMTag &  tag  ) const

protected

Definition at line 98 of file mitkDICOMSortByTag.cpp.

References mitk::DICOMDatasetAccess::GetTagValueAsString(), and mitk::DICOMDatasetFinding::value.

---

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

• mitkDICOMSortByTag.h
• mitkDICOMSortByTag.cpp