Medical Imaging Interaction Toolkit  2018.4.99-f51274ea
Medical Imaging Interaction Toolkit
mitk::DICOMDatasetSorter Class Referenceabstract

The sorting/splitting building-block of DICOMITKSeriesGDCMReader. More...

#include <mitkDICOMDatasetSorter.h>

Inheritance diagram for mitk::DICOMDatasetSorter:
Collaboration diagram for mitk::DICOMDatasetSorter:

Public Member Functions

 mitkClassMacroItkParent (DICOMDatasetSorter, itk::LightObject)
 
virtual DICOMTagList GetTagsOfInterest ()=0
 Return the tags of interest (to facilitate scanning) More...
 
void SetInput (DICOMDatasetList filenames)
 Input for sorting. More...
 
const DICOMDatasetListGetInput () const
 Input for sorting. More...
 
virtual void Sort ()=0
 Sort input datasets into one or multiple outputs. More...
 
unsigned int GetNumberOfOutputs () const
 Output of the sorting process. More...
 
const DICOMDatasetListGetOutput (unsigned int index) const
 Output of the sorting process. More...
 
DICOMDatasetListGetOutput (unsigned int index)
 Output of the sorting process. More...
 
virtual void PrintConfiguration (std::ostream &os, const std::string &indent="") const =0
 Print configuration details into stream. More...
 
virtual bool operator== (const DICOMDatasetSorter &other) const =0
 

Protected Member Functions

 DICOMDatasetSorter ()
 
 ~DICOMDatasetSorter () override
 
 DICOMDatasetSorter (const DICOMDatasetSorter &other)
 
DICOMDatasetSorteroperator= (const DICOMDatasetSorter &other)
 
void ClearOutputs ()
 
void SetNumberOfOutputs (unsigned int numberOfOutputs)
 
void SetOutput (unsigned int index, const DICOMDatasetList &output)
 

Detailed Description

The sorting/splitting building-block of DICOMITKSeriesGDCMReader.

This class describes the interface of the sorting/splitting process described as part of DICOMITKSeriesGDCMReader::AnalyzeInputFiles() (see Loading strategy).

The prodecure is simple:

  • take a list of input datasets (DICOMDatasetAccess)
  • sort them (to be defined by sub-classes, based on specific tags)
  • return the sorting result as outputs (the single input might be distributed into multiple outputs)

The simplest and most generic form of sorting is implemented in sub-class DICOMTagBasedSorter.

Definition at line 40 of file mitkDICOMDatasetSorter.h.

Constructor & Destructor Documentation

◆ DICOMDatasetSorter() [1/2]

mitk::DICOMDatasetSorter::DICOMDatasetSorter ( )
protected

Definition at line 16 of file mitkDICOMDatasetSorter.cpp.

References ~DICOMDatasetSorter().

Referenced by ~DICOMDatasetSorter().

◆ ~DICOMDatasetSorter()

mitk::DICOMDatasetSorter::~DICOMDatasetSorter ( )
overrideprotected

Definition at line 22 of file mitkDICOMDatasetSorter.cpp.

References DICOMDatasetSorter().

Referenced by DICOMDatasetSorter().

◆ DICOMDatasetSorter() [2/2]

mitk::DICOMDatasetSorter::DICOMDatasetSorter ( const DICOMDatasetSorter other)
protected

Definition at line 27 of file mitkDICOMDatasetSorter.cpp.

References operator=().

Member Function Documentation

◆ ClearOutputs()

void mitk::DICOMDatasetSorter::ClearOutputs ( )
protected

Definition at line 68 of file mitkDICOMDatasetSorter.cpp.

References SetNumberOfOutputs().

Referenced by GetNumberOfOutputs().

◆ GetInput()

◆ GetNumberOfOutputs()

unsigned int mitk::DICOMDatasetSorter::GetNumberOfOutputs ( ) const

Output of the sorting process.

Definition at line 61 of file mitkDICOMDatasetSorter.cpp.

References ClearOutputs().

Referenced by GetInput().

◆ GetOutput() [1/2]

const mitk::DICOMDatasetList & mitk::DICOMDatasetSorter::GetOutput ( unsigned int  index) const

Output of the sorting process.

Definition at line 98 of file mitkDICOMDatasetSorter.cpp.

Referenced by SetOutput().

◆ GetOutput() [2/2]

mitk::DICOMDatasetList & mitk::DICOMDatasetSorter::GetOutput ( unsigned int  index)

Output of the sorting process.

Definition at line 105 of file mitkDICOMDatasetSorter.cpp.

◆ GetTagsOfInterest()

virtual DICOMTagList mitk::DICOMDatasetSorter::GetTagsOfInterest ( )
pure virtual

Return the tags of interest (to facilitate scanning)

Implemented in mitk::DICOMTagBasedSorter, mitk::EquiDistantBlocksSorter, mitk::NormalDirectionConsistencySorter, and mitk::DICOMFilenameSorter.

◆ mitkClassMacroItkParent()

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

◆ operator=()

◆ operator==()

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

◆ PrintConfiguration()

virtual void mitk::DICOMDatasetSorter::PrintConfiguration ( std::ostream &  os,
const std::string &  indent = "" 
) const
pure virtual

◆ SetInput()

void mitk::DICOMDatasetSorter::SetInput ( DICOMDatasetList  filenames)

Input for sorting.

Definition at line 47 of file mitkDICOMDatasetSorter.cpp.

References GetInput().

Referenced by operator=().

◆ SetNumberOfOutputs()

void mitk::DICOMDatasetSorter::SetNumberOfOutputs ( unsigned int  numberOfOutputs)
protected

◆ SetOutput()

void mitk::DICOMDatasetSorter::SetOutput ( unsigned int  index,
const DICOMDatasetList output 
)
protected

◆ Sort()

virtual void mitk::DICOMDatasetSorter::Sort ( )
pure virtual

Sort input datasets into one or multiple outputs.

Implemented in mitk::DICOMTagBasedSorter, mitk::EquiDistantBlocksSorter, mitk::NormalDirectionConsistencySorter, and mitk::DICOMFilenameSorter.


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