Method AddToolUse

Modules/Multilabel/src/mitkLabel.cpp:523–562

}

void mitk::Label::AddToolUse(AlgorithmType algoType, const std::string& algoName)
{
  if (algoName.empty()) // nothing to record; leave the existing provenance untouched
    return;

  // Keep the provenance string parseable: TOOL_SEPARATOR ("|") and PREFIX_SEPARATOR (": ") are
  // reserved. Throwing here would be too late (this runs at the writeback choke point, after pixels
  // are committed, and the throw would skip undo registration), so instead neutralize the separator
  // characters and warn. Tool authors are pointed at this constraint in Tool::GetName().
  std::string sanitized = algoName;
  std::replace(sanitized.begin(), sanitized.end(), '|', '#');
  std::replace(sanitized.begin(), sanitized.end(), ':', '#');
  if (sanitized != algoName)
    MITK_WARN << "Label::AddToolUse: tool name \"" << algoName << "\" contains reserved separator "
                 "characters ('|' or ':'); recorded as \"" << sanitized << "\" to keep the provenance "
                 "string parseable.";

  std::string currentName = this->GetAlgorithmName(); // MITK prefix only for internally-created names
  // An empty stored name (e.g. a legacy persisted empty algorithm_name property, which the native-JSON
  // reader restores verbatim via SetProperty) is equivalent to "no name recorded": normalize it to the
  // bare prefix so the first tool is appended as "MITK Segmentation: <tool>" rather than "|<tool>".
  if (currentName.empty())
    currentName = DEFAULT_ALGORITHM_NAME;

  // A name equal to just the prefix means no dedicated tool has been recorded yet (the construction-
  // default state), so the first tool's name is appended after the prefix separator.
  const bool noToolRecorded = (currentName == DEFAULT_ALGORITHM_NAME);

  // The first contribution to a still-Undefined label defines its type. Any type already present
  // (a genuine MANUAL loaded from a DICOM SEG, or a prior tool's type) is real provenance: preserve
  // it, and mix to SEMIAUTOMATIC when a later tool of a different type contributes.
  const auto currentType = this->GetAlgorithmType();
  if (currentType == AlgorithmType::Undefined)
    this->SetAlgorithmType(algoType);
  else if (currentType != algoType)
    this->SetAlgorithmType(AlgorithmType::SEMIAUTOMATIC); // mixed tool types

  if (!ToolAlreadyRecorded(currentName, sanitized)) // keep the prefix, append the dedicated tool
    this->SetAlgorithmName(currentName + (noToolRecorded ? PREFIX_SEPARATOR : TOOL_SEPARATOR) + sanitized);
}

void mitk::Label::MergeToolUses(const Label* other)
{