mitkLabelSuggestionHelper.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 mitkLabelSuggestionHelper_h
#define mitkLabelSuggestionHelper_h
 
#include <MitkMultilabelExports.h>
 
#include <mitkLabel.h>
#include <mitkLabelSetImage.h>
 
#include <nlohmann/json.hpp>
 
#include <string>
#include <string_view>
#include <vector>
#include <optional>
 
namespace mitk
{
  class MITKMULTILABEL_EXPORT LabelSuggestionHelper : public itk::Object
  {
  public:
    mitkClassMacroItkParent(LabelSuggestionHelper, itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    static constexpr const char* PROPERTY_MAX_INSTANCE_OCCURRENCE = "_max_instance_occurrence";
 
    using ConstLabelVectorType = MultiLabelSegmentation::ConstLabelVectorType;
 
    struct Preferences
    {
      std::string externalLabelSuggestionFile = "";
      std::string standardLabelSuggestionResource = "MitkCore:mitk_classic";
      bool replaceStandardSuggestions = true; 
      bool enforceSuggestions = false; 
      bool suggestionOnce = true;
    };
 
    // Get all relevant preferences and consider command-line arguments overrides.
    static Preferences GetSuggestionPreferences();
 
    static std::map<std::string, nlohmann::json> GetAllAvailableBuiltInSuggestions();
 
    std::optional<nlohmann::json> GetStandardSuggesitions();
 
    void LoadStandardSuggestions();
 
    bool ParseSuggestions(const std::string& filePath, bool replaceExisting = true);
 
    bool ParseSuggestions(const nlohmann::json& jsonSuggestions, bool replaceExisting = true);
 
    ConstLabelVectorType GetValidSuggestionsForNewLabels(const MultiLabelSegmentation* segmentation = nullptr) const;
 
    ConstLabelVectorType GetValidSuggestionsForRenamingLabels(const MultiLabelSegmentation* segmentation,
                                                   const std::string_view labelName) const;
 
    bool IsNewInstanceAllowed(const MultiLabelSegmentation* segmentation, const std::string_view labelName) const;
 
    ConstLabelVectorType GetAllSuggestions() const;
 
    void ClearSuggestions();
 
    void AddSuggestion(Label::Pointer label);
 
  protected:
    LabelSuggestionHelper();
    ~LabelSuggestionHelper();
    LabelSuggestionHelper(const LabelSuggestionHelper&) = delete;
    LabelSuggestionHelper& operator= (const LabelSuggestionHelper&) = delete;
 
  private:
    std::optional<unsigned int> GetMaxInstanceOccurrence(const std::string_view labelname) const;
 
    static ConstLabelVectorType FilterSuggestions(const ConstLabelVectorType& suggestions,
                                                   const MultiLabelSegmentation* segmentation,
                                                   const std::optional<std::string_view> labelName = std::nullopt);
 
    ConstLabelVectorType m_Suggestions;
  };
 
} // namespace mitk
 
#endif // mitkLabelSuggestionHelper_h