ttkMergeTreeDistanceMatrix.cpp

Go to the documentation of this file.

#include <ttkMergeTreeDistanceMatrix.h>
#include <ttkMergeTreeUtils.h>
#include <ttkUtils.h>
 
#include <vtkDataObject.h> // For port information
#include <vtkObjectFactory.h> // for new macro
 
#include <vtkDoubleArray.h>
#include <vtkInformation.h>
#include <vtkStringArray.h>
#include <vtkTable.h>
 
using namespace ttk;
using namespace ftm;
 
// A VTK macro that enables the instantiation of this class via ::New()
// You do not have to modify this
vtkStandardNewMacro(ttkMergeTreeDistanceMatrix);

ttkMergeTreeDistanceMatrix::ttkMergeTreeDistanceMatrix() {
  this->SetNumberOfInputPorts(2);
  this->SetNumberOfOutputPorts(1);
}
 
ttkMergeTreeDistanceMatrix::~ttkMergeTreeDistanceMatrix() = default;

int ttkMergeTreeDistanceMatrix::FillInputPortInformation(int port,
                                                         vtkInformation *info) {
  if(port == 0 || port == 1) {
    info->Set(vtkAlgorithm::INPUT_REQUIRED_DATA_TYPE(), "vtkMultiBlockDataSet");
    if(port == 1)
      info->Set(vtkAlgorithm::INPUT_IS_OPTIONAL(), 1);
  } else
    return 0;
 
  return 1;
}

int ttkMergeTreeDistanceMatrix::FillOutputPortInformation(
  int port, vtkInformation *info) {
  if(port == 0)
    info->Set(vtkDataObject::DATA_TYPE_NAME(), "vtkTable");
  else
    return 0;
 
  return 1;
}

template <class dataType>
int ttkMergeTreeDistanceMatrix::run(
  vtkInformationVector *outputVector,
  std::vector<vtkSmartPointer<vtkMultiBlockDataSet>> &inputTrees,
  std::vector<vtkSmartPointer<vtkMultiBlockDataSet>> &inputTrees2) {
 
  // Construct trees
  const int numInputs = inputTrees.size();
  std::vector<MergeTree<dataType>> intermediateTrees, intermediateTrees2;
  bool const useSecondPairsType
    = (mixtureCoefficient_ == 0); // only for PD support
  isPersistenceDiagram_ = constructTrees(
    inputTrees, intermediateTrees, useSecondPairsType, DiagramPairTypes);
  if(not isPersistenceDiagram_
     or (mixtureCoefficient_ != 0 and mixtureCoefficient_ != 1)) {
    auto &inputTrees2ToUse
      = (not isPersistenceDiagram_ ? inputTrees2 : inputTrees);
    constructTrees(inputTrees2ToUse, intermediateTrees2, !useSecondPairsType,
                   DiagramPairTypes);
  }
 
  // Verify parameters
  if(not UseFieldDataParameters) {
    if(Backend == 0) {
      branchDecomposition_ = true;
      normalizedWasserstein_ = true;
      keepSubtree_ = false;
      baseModule_ = 0;
    } else if(Backend == 1) {
      branchDecomposition_ = false;
      normalizedWasserstein_ = false;
      keepSubtree_ = true;
      baseModule_ = 0;
    } else if(Backend == 3) {
      branchDecomposition_ = true;
      normalizedWasserstein_ = false;
      keepSubtree_ = true;
      baseModule_ = 1;
    } else if(Backend == 4) {
      branchDecomposition_ = true;
      normalizedWasserstein_ = false;
      keepSubtree_ = true;
      baseModule_ = 2;
    } else {
      baseModule_ = 0;
    }
  }
  if(baseModule_ == 0) {
    if(isPersistenceDiagram_) {
      branchDecomposition_ = true;
    }
    if(not branchDecomposition_) {
      if(normalizedWasserstein_)
        printMsg("NormalizedWasserstein is set to false since branch "
                 "decomposition is not asked.");
      normalizedWasserstein_ = false;
    }
    if(normalizedWasserstein_)
      printMsg("Computation with normalized Wasserstein.");
    else
      printMsg("Computation without normalized Wasserstein.");
    epsilonTree2_ = epsilonTree1_;
    epsilon2Tree2_ = epsilon2Tree1_;
    epsilon3Tree2_ = epsilon3Tree1_;
    printMsg("BranchDecomposition: " + std::to_string(branchDecomposition_));
    printMsg("NormalizedWasserstein: "
             + std::to_string(normalizedWasserstein_));
    printMsg("KeepSubtree: " + std::to_string(keepSubtree_));
  }
  if(baseModule_ == 1) {
    printMsg("Using Branch Mapping Distance.");
    std::string metric;
    if(branchMetric_ == 0)
      metric = "Wasserstein Distance first degree";
    else if(branchMetric_ == 1)
      metric = "Wasserstein Distance second degree";
    else if(branchMetric_ == 2)
      metric = "Persistence difference";
    else if(branchMetric_ == 3)
      metric = "Shifting cost";
    else
      return 1;
    printMsg("BranchMetric: " + metric);
  }
  if(baseModule_ == 2) {
    printMsg("Using Path Mapping Distance.");
    std::string metric;
    if(pathMetric_ == 0)
      metric = "Persistence difference";
    else
      return 1;
    printMsg("PathMetric: " + metric);
  }
 
  // --- Call base
  std::vector<std::vector<double>> treesDistMat(
    numInputs, std::vector<double>(numInputs));
  if(baseModule_ == 0)
    execute<dataType>(intermediateTrees, intermediateTrees2, treesDistMat);
  else
    execute<dataType>(intermediateTrees, treesDistMat);
 
  // --- Create output
  auto treesDistTable = vtkTable::GetData(outputVector);
 
  // zero-padd column name to keep Row Data columns ordered
  const auto zeroPad
    = [](std::string &colName, const size_t numberCols, const size_t colIdx) {
        std::string const max{std::to_string(numberCols - 1)};
        std::string const cur{std::to_string(colIdx)};
        std::string const zer(max.size() - cur.size(), '0');
        colName.append(zer).append(cur);
      };
 
  // copy trees distance matrix to output
  vtkNew<vtkIntArray> treeIds{};
  treeIds->SetName("treeID");
  treeIds->SetNumberOfTuples(numInputs);
  for(size_t i = 0; i < treesDistMat.size(); ++i) {
    treeIds->SetTuple1(i, i);
 
    std::string name{"Tree"};
    zeroPad(name, treesDistMat.size(), i);
    vtkNew<vtkDoubleArray> col{};
    col->SetNumberOfTuples(numInputs);
    col->SetName(name.c_str());
    for(size_t j = 0; j < treesDistMat[i].size(); ++j) {
      col->SetTuple1(j, treesDistMat[i][j]);
    }
    treesDistTable->AddColumn(col);
  }
 
  treesDistTable->AddColumn(treeIds);
 
  // aggregate input field data
  vtkNew<vtkFieldData> allFieldData{}, allFieldDataCopy{};
  for(unsigned int i = 0; i < inputTrees.size(); ++i) {
    for(unsigned int j = 0; j < inputTrees[i]->GetNumberOfBlocks(); ++j) {
      auto fd = inputTrees[i]->GetBlock(j)->GetFieldData();
      for(int k = 0; k < fd->GetNumberOfArrays(); ++k) {
        auto array = fd->GetAbstractArray(k);
        auto dataArray = vtkDataArray::SafeDownCast(array);
        auto stringArray = vtkStringArray::SafeDownCast(array);
        if(dataArray or stringArray)
          allFieldData->AddArray(array);
      }
    }
  }
  allFieldDataCopy->DeepCopy(allFieldData); // to not modify original field data
 
  for(int k = 0; k < allFieldDataCopy->GetNumberOfArrays(); ++k) {
    auto array = allFieldDataCopy->GetAbstractArray(k);
    array->SetNumberOfTuples(inputTrees.size());
    auto dataArray = vtkDataArray::SafeDownCast(array);
    auto stringArray = vtkStringArray::SafeDownCast(array);
    auto name = array->GetName();
    for(unsigned int i = 0; i < inputTrees.size(); ++i) {
      bool foundArray = false;
      for(unsigned int j = 0; j < inputTrees[i]->GetNumberOfBlocks(); ++j) {
        auto inputArray
          = inputTrees[i]->GetBlock(j)->GetFieldData()->GetAbstractArray(name);
        if(inputArray) {
          array->SetTuple(i, 0, inputArray);
          foundArray = true;
        } else if(not foundArray) {
          if(dataArray) {
            const double val = std::nan("");
            dataArray->SetTuple(i, &val);
          } else if(stringArray) {
            stringArray->SetValue(i, "");
          }
        }
      }
    }
    treesDistTable->AddColumn(array);
  }
 
  return 1;
}
 
int ttkMergeTreeDistanceMatrix::RequestData(
  vtkInformation *ttkNotUsed(request),
  vtkInformationVector **inputVector,
  vtkInformationVector *outputVector) {
  // --- Get input object from input vector
  auto blocks = vtkMultiBlockDataSet::GetData(inputVector[0], 0);
  auto blocks2 = vtkMultiBlockDataSet::GetData(inputVector[1], 0);
 
  // --- Load blocks
  std::vector<vtkSmartPointer<vtkMultiBlockDataSet>> inputTrees, inputTrees2;
  loadBlocks(inputTrees, blocks);
  loadBlocks(inputTrees2, blocks2);
 
  // --- Load field data parameters
  if(UseFieldDataParameters) {
    printMsg("Load parameters from field data.");
    std::vector<std::string> paramNames;
    getParamNames(paramNames);
    for(auto paramName : paramNames) {
      auto array = blocks->GetFieldData()->GetArray(paramName.c_str());
      if(array) {
        double const value = array->GetTuple1(0);
        setParamValueFromName(paramName, value);
        printMsg(" - " + paramName + " = " + std::to_string(value));
      } else
        printMsg(" - " + paramName + " was not found in the field data.");
    }
  }
 
  return run<float>(outputVector, inputTrees, inputTrees2);
}