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)
DICOMTagList	GetTagsOfInterest () const override
	Tags used for comparison. More...
bool	IsLeftBeforeRight (const mitk::DICOMDatasetAccess *left, const mitk::DICOMDatasetAccess *right) const override
	Answer the sorting question. More...
double	NumericDistance (const mitk::DICOMDatasetAccess *from, const mitk::DICOMDatasetAccess *to) const override
	Calculate a distance between two datasets. This answers the question of consecutive datasets. More...
void	Print (std::ostream &os) const override
	brief describe this class in given stream. More...
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 secondary criteria). More...
DICOMSortCriterion::ConstPointer	GetSecondaryCriterion () const
	The fallback criterion. More...

Protected Member Functions
	DICOMSortByTag (const DICOMTag &tag, DICOMSortCriterion::Pointer secondaryCriterion=nullptr)
	~DICOMSortByTag () override
	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)
	~DICOMSortCriterion () override
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 referred to the secondary criterion, see DICOMSortByTag::NextLevelIsLeftBeforeRight().

Definition at line 33 of file mitkDICOMSortByTag.h.

Constructor & Destructor Documentation

DICOMSortByTag() [1/2]

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

protected

~DICOMSortByTag()

mitk::DICOMSortByTag::~DICOMSortByTag ( )

overrideprotected

DICOMSortByTag() [2/2]

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

protected

Member Function Documentation

GetTagsOfInterest()

DICOMTagList mitk::DICOMSortByTag::GetTagsOfInterest ( ) const

overridevirtual

Tags used for comparison.

Implements mitk::DICOMSortCriterion.

IsLeftBeforeRight()

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

overridevirtual

Answer the sorting question.

Implements mitk::DICOMSortCriterion.

mitkClassMacro()

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

mitkNewMacro1Param()

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

mitkNewMacro2Param()

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

NumericCompare()

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

protected

NumericDistance()

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

overridevirtual

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

Implements mitk::DICOMSortCriterion.

operator=()

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

protected

operator==()

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

overridevirtual

Implements mitk::DICOMSortCriterion.

Print()

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

overridevirtual

brief describe this class in given stream.

Implements mitk::DICOMSortCriterion.

StringCompare()

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

protected

---

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

• mitkDICOMSortByTag.h