Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::DICOMSortCriterion Class Referenceabstract

A tag based sorting criterion for use in DICOMTagBasedSorter. More...

#include <mitkDICOMSortCriterion.h>

Inheritance diagram for mitk::DICOMSortCriterion:
Collaboration diagram for mitk::DICOMSortCriterion:

Public Member Functions

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

Protected Member Functions

 DICOMSortCriterion (DICOMSortCriterion::Pointer secondaryCriterion)
 
 ~DICOMSortCriterion () override
 
bool NextLevelIsLeftBeforeRight (const mitk::DICOMDatasetAccess *left, const mitk::DICOMDatasetAccess *right) const
 
 DICOMSortCriterion (const DICOMSortCriterion &other)
 
DICOMSortCriterionoperator= (const DICOMSortCriterion &other)
 

Protected Attributes

DICOMSortCriterion::Pointer m_SecondaryCriterion
 

Detailed Description

A tag based sorting criterion for use in DICOMTagBasedSorter.

This class is used within std::sort (see DICOMTagBasedSorter::Sort()) and has to answer a simple question by implementing IsLeftBeforeRight(). Each time IsLeftBeforeRight() is called, the method should return whether the left dataset should be sorted before the right dataset.

Because there are identical tags values quite oftenly, a DICOMSortCriterion will always hold a secondary DICOMSortCriterion. In cases of equal tag values, the decision is refered to the secondary criterion.

Definition at line 37 of file mitkDICOMSortCriterion.h.

Constructor & Destructor Documentation

◆ DICOMSortCriterion() [1/2]

mitk::DICOMSortCriterion::DICOMSortCriterion ( DICOMSortCriterion::Pointer  secondaryCriterion)
protected

◆ ~DICOMSortCriterion()

mitk::DICOMSortCriterion::~DICOMSortCriterion ( )
overrideprotected

◆ DICOMSortCriterion() [2/2]

mitk::DICOMSortCriterion::DICOMSortCriterion ( const DICOMSortCriterion other)
explicitprotected

Member Function Documentation

◆ GetAllTagsOfInterest()

DICOMTagList mitk::DICOMSortCriterion::GetAllTagsOfInterest ( ) const

Tags used for comparison (includes seconary criteria).

◆ GetSecondaryCriterion()

DICOMSortCriterion::ConstPointer mitk::DICOMSortCriterion::GetSecondaryCriterion ( ) const

The fallback criterion.

◆ GetTagsOfInterest()

virtual DICOMTagList mitk::DICOMSortCriterion::GetTagsOfInterest ( ) const
pure virtual

Tags used for comparison.

Implemented in mitk::DICOMSortByTag, and mitk::SortByImagePositionPatient.

◆ IsLeftBeforeRight()

virtual bool mitk::DICOMSortCriterion::IsLeftBeforeRight ( const mitk::DICOMDatasetAccess left,
const mitk::DICOMDatasetAccess right 
) const
pure virtual

Answer the sorting question.

Implemented in mitk::DICOMSortByTag, and mitk::SortByImagePositionPatient.

◆ mitkClassMacroItkParent()

mitk::DICOMSortCriterion::mitkClassMacroItkParent ( DICOMSortCriterion  ,
itk::LightObject   
)

◆ NextLevelIsLeftBeforeRight()

bool mitk::DICOMSortCriterion::NextLevelIsLeftBeforeRight ( const mitk::DICOMDatasetAccess left,
const mitk::DICOMDatasetAccess right 
) const
protected

◆ NumericDistance()

virtual double mitk::DICOMSortCriterion::NumericDistance ( const mitk::DICOMDatasetAccess from,
const mitk::DICOMDatasetAccess to 
) const
pure virtual

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

Implemented in mitk::DICOMSortByTag, and mitk::SortByImagePositionPatient.

◆ operator=()

DICOMSortCriterion& mitk::DICOMSortCriterion::operator= ( const DICOMSortCriterion other)
protected

◆ operator==()

virtual bool mitk::DICOMSortCriterion::operator== ( const DICOMSortCriterion other) const
pure virtual

◆ Print()

virtual void mitk::DICOMSortCriterion::Print ( std::ostream &  os) const
pure virtual

brief describe this class in given stream.

Implemented in mitk::DICOMSortByTag, and mitk::SortByImagePositionPatient.

Member Data Documentation

◆ m_SecondaryCriterion

DICOMSortCriterion::Pointer mitk::DICOMSortCriterion::m_SecondaryCriterion
protected

Definition at line 73 of file mitkDICOMSortCriterion.h.


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