mitkEquiDistantBlocksSorter.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkEquiDistantBlocksSorter_h
#define mitkEquiDistantBlocksSorter_h
 
#include "mitkDICOMDatasetSorter.h"
#include "mitkDICOMSortCriterion.h"
#include "mitkGantryTiltInformation.h"
 
#include "mitkVector.h"
 
namespace mitk
{
 
class MITKDICOM_EXPORT EquiDistantBlocksSorter : public DICOMDatasetSorter
{
  public:
 
    mitkClassMacro( EquiDistantBlocksSorter, DICOMDatasetSorter );
 
    itkNewMacro( EquiDistantBlocksSorter );
 
    DICOMTagList GetTagsOfInterest() override;
 
    void Sort() override;
 
    void SetAcceptTilt(bool accept);
    bool GetAcceptTilt() const;
 
    void SetToleratedOriginOffsetToAdaptive(double fractionOfInterSliceDistanct = 0.3);
    void SetToleratedOriginOffset(double millimeters = 0.005);
 
    double GetToleratedOriginOffset() const;
    bool IsToleratedOriginOffsetAbsolute() const;
 
    void SetAcceptTwoSlicesGroups(bool accept);
    bool GetAcceptTwoSlicesGroups() const;
 
    void PrintConfiguration(std::ostream& os, const std::string& indent = "") const override;
 
    bool operator==(const DICOMDatasetSorter& other) const override;
 
  protected:
 
    class SliceGroupingAnalysisResult
    {
      public:
 
        SliceGroupingAnalysisResult();
 
        const DICOMDatasetList& GetBlockDatasets() const;
 
        void SetFirstFilenameOfBlock(const std::string& filename);
        std::string GetFirstFilenameOfBlock() const;
        void SetLastFilenameOfBlock(const std::string& filename);
        std::string GetLastFilenameOfBlock() const;
 
        const DICOMDatasetList& GetUnsortedDatasets() const;
 
        IOVolumeSplitReason::ConstPointer GetSplitReason() const;
        IOVolumeSplitReason::Pointer GetSplitReason();
 
        bool ContainsGantryTilt();
 
        const GantryTiltInformation& GetTiltInfo() const;
 
        void AddFileToSortedBlock(DICOMDatasetAccess* dataset);
 
        void AddFileToUnsortedBlock(DICOMDatasetAccess* dataset);
        void AddFilesToUnsortedBlock(const DICOMDatasetList& datasets);
 
        void FlagGantryTilt(const GantryTiltInformation& tiltInfo);
 
        void UndoPrematureGrouping();
 
      protected:
 
        DICOMDatasetList m_GroupedFiles;
        DICOMDatasetList m_UnsortedFiles;
 
        IOVolumeSplitReason::Pointer m_SplitReason;
 
        GantryTiltInformation m_TiltInfo;
        std::string m_FirstFilenameOfBlock;
        std::string m_LastFilenameOfBlock;
    };
 
    std::shared_ptr<SliceGroupingAnalysisResult>
    AnalyzeFileForITKImageSeriesReaderSpacingAssumption(const DICOMDatasetList& files, bool groupsOfSimilarImages);
 
    std::string
    ConstCharStarToString(const char* s);
 
    EquiDistantBlocksSorter();
    ~EquiDistantBlocksSorter() override;
 
    EquiDistantBlocksSorter(const EquiDistantBlocksSorter& other);
    EquiDistantBlocksSorter& operator=(const EquiDistantBlocksSorter& other);
 
    bool m_AcceptTilt;
 
    typedef std::vector<std::shared_ptr<SliceGroupingAnalysisResult> > ResultsList;
    ResultsList m_SliceGroupingResults;
 
    double m_ToleratedOriginOffset;
    bool m_ToleratedOriginOffsetIsAbsolute;
 
    bool m_AcceptTwoSlicesGroups;
};
 
}
 
#endif