mitkDICOMSegmentationPropertyHelper.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 mitkDICOMSegmentationPropertyHelper_h
#define mitkDICOMSegmentationPropertyHelper_h
 
#include <mitkDICOMTag.h>
#include <mitkExceptionMacro.h>
#include <mitkLabel.h>
#include <mitkLabelSetImage.h>
 
#include <MitkMultilabelExports.h>
 
#include <string>
#include <vector>
 
namespace mitk
{
  class IPropertyProvider;
 
  class MITKMULTILABEL_EXPORT DICOMSegStrictModeException : public mitk::Exception
  {
  public:
    mitkExceptionClassMacro(DICOMSegStrictModeException, mitk::Exception);
  };
 
  class MITKMULTILABEL_EXPORT DICOMSegmentationPropertyHelper
  {
  public:
    struct MissingItem
    {
      enum class Scope
      {
        Segmentation,
        Group,
        Label
      };
 
      Scope scope;
      std::string identifier;
      std::string description;
    };
 
    struct CompletionOptions
    {
      bool synthesizeMissingIdentity = false;
 
      bool deriveGeometryFromSegmentation = false;
    };
 
    static std::vector<MissingItem> Validate(const MultiLabelSegmentation* seg);
 
    static std::vector<MissingItem> Complete(MultiLabelSegmentation* seg,
                                             const CompletionOptions& options);
 
    static void InheritPatientFromSource(MultiLabelSegmentation* seg,
                                         const IPropertyProvider* source,
                                         bool overwrite = true);
 
    static void InheritStudyFromSource(MultiLabelSegmentation* seg,
                                       const IPropertyProvider* source,
                                       bool overwrite = true);
 
    static void InheritFrameOfReferenceFromSource(MultiLabelSegmentation* seg,
                                                  const IPropertyProvider* source,
                                                  bool overwrite = true);
 
    static std::size_t MigrateLegacyReferenceFilesToRelation(MultiLabelSegmentation* seg);
 
    static std::string MintSyntheticUID(const std::string& kind);
 
    // Placeholder constants used by Complete's synthesis path. Exposed so
    // tests, downstream tooling, and consumers reading a MITK-written SEG
    // can distinguish placeholders from real-world data by string match
    // against one canonical source.
    static const std::string& UnknownPatientName();
    static const std::string& UnknownPatientID();
    static const std::string& UnknownStudyID();
    static const std::string& UnknownContentCreatorName();
  };
}
 
#endif