mitkContourModelLiveWireInteractor.cpp

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.

============================================================================*/

#include "mitkContourModelLiveWireInteractor.h"

#include "mitkInteractionPositionEvent.h"
#include "mitkToolManager.h"

#include "mitkBaseRenderer.h"
#include "mitkRenderingManager.h"

#include <mitkInteractionConst.h>

#include "mitkIOUtil.h"

mitk::ContourModelLiveWireInteractor::ContourModelLiveWireInteractor() : ContourModelInteractor()
{
  m_LiveWireFilter = mitk::ImageLiveWireContourModelFilter::New();

  m_NextActiveVertexDown.Fill(0);
  m_NextActiveVertexUp.Fill(0);
}

mitk::ContourModelLiveWireInteractor::~ContourModelLiveWireInteractor()
{
}

void mitk::ContourModelLiveWireInteractor::ConnectActionsAndFunctions()
{
  CONNECT_CONDITION("checkisOverPoint", OnCheckPointClick);
  CONNECT_CONDITION("mouseMove", IsHovering);

  CONNECT_FUNCTION("movePoint", OnMovePoint);
  CONNECT_FUNCTION("deletePoint", OnDeletePoint);
  CONNECT_FUNCTION("finish", OnFinishEditing);
}

bool mitk::ContourModelLiveWireInteractor::OnCheckPointClick(const InteractionEvent *interactionEvent)
{
  const auto *positionEvent = dynamic_cast<const InteractionPositionEvent *>(interactionEvent);

  if (!positionEvent)
    return false;

  int timestep = positionEvent->GetSender()->GetTimeStep();

  auto *contour = dynamic_cast<mitk::ContourModel *>(this->GetDataNode()->GetData());
  if (contour == nullptr)
  {
    MITK_ERROR << "Invalid Contour";
    return false;
  }

  contour->Deselect();

  // Check distance to any vertex.
  // Transition YES if click close to a vertex
  mitk::Point3D click = positionEvent->GetPositionInWorld();

  if (contour->SelectVertexAt(click, 1.5, timestep))
  {
    contour->SetSelectedVertexAsControlPoint(false);
    m_ContourLeft = mitk::ContourModel::New();
    // get coordinates of next active vertex downwards from selected vertex
    int downIndex = this->SplitContourFromSelectedVertex(contour, m_ContourLeft, false, timestep);

    m_NextActiveVertexDownIter = contour->IteratorBegin() + downIndex;
    m_NextActiveVertexDown = (*m_NextActiveVertexDownIter)->Coordinates;

    m_ContourRight = mitk::ContourModel::New();

    // get coordinates of next active vertex upwards from selected vertex
    int upIndex = this->SplitContourFromSelectedVertex(contour, m_ContourRight, true, timestep);

    m_NextActiveVertexUpIter = contour->IteratorBegin() + upIndex;
    m_NextActiveVertexUp = (*m_NextActiveVertexUpIter)->Coordinates;

    // clear previous void positions
    this->m_LiveWireFilter->ClearRepulsivePoints();

    // set the current contour as void positions in the cost map
    // start with down side
    auto iter = contour->IteratorBegin(timestep);
    for (; iter != m_NextActiveVertexDownIter; iter++)
    {
      itk::Index<2> idx;
      this->m_WorkingSlice->GetGeometry()->WorldToIndex((*iter)->Coordinates, idx);
      this->m_LiveWireFilter->AddRepulsivePoint(idx);
    }

    // continue with upper side
    iter = m_NextActiveVertexUpIter + 1;
    for (; iter != contour->IteratorEnd(timestep); iter++)
    {
      itk::Index<2> idx;
      this->m_WorkingSlice->GetGeometry()->WorldToIndex((*iter)->Coordinates, idx);
      this->m_LiveWireFilter->AddRepulsivePoint(idx);
    }

    // clear container with void points between neighboring control points
    m_ContourBeingModified.clear();

    // let us have the selected point as a control point
    contour->SetSelectedVertexAsControlPoint(true);

    // finally, return true to pass this condition
    return true;
  }
  else
  {
    // do not pass condition
    return false;
  }

  mitk::RenderingManager::GetInstance()->RequestUpdate(positionEvent->GetSender()->GetRenderWindow());
  return true;
}

void mitk::ContourModelLiveWireInteractor::SetEditingContourModelNode(mitk::DataNode *_arg)
{
  if (this->m_EditingContourNode != _arg)
  {
    this->m_EditingContourNode = _arg;
  }
}

void mitk::ContourModelLiveWireInteractor::SetWorkingImage(mitk::Image *_arg)
{
  if (this->m_WorkingSlice != _arg)
  {
    this->m_WorkingSlice = _arg;
    this->m_LiveWireFilter->SetInput(this->m_WorkingSlice);
  }
}

void mitk::ContourModelLiveWireInteractor::OnDeletePoint(StateMachineAction *, InteractionEvent *interactionEvent)
{
  int timestep = interactionEvent->GetSender()->GetTimeStep();

  auto *contour = dynamic_cast<mitk::ContourModel *>(this->GetDataNode()->GetData());
  if (contour == nullptr)
  {
    MITK_ERROR << "Invalid Contour!";
    return;
  }

  if (contour->GetSelectedVertex())
  {
    mitk::ContourModel::Pointer newContour = mitk::ContourModel::New();
    newContour->Expand(contour->GetTimeSteps());

    newContour->Concatenate(m_ContourLeft, timestep);

    // recompute contour between neighbored two active control points
    this->m_LiveWireFilter->SetStartPoint(this->m_NextActiveVertexDown);
    this->m_LiveWireFilter->SetEndPoint(this->m_NextActiveVertexUp);
    // this->m_LiveWireFilter->ClearRepulsivePoints();
    this->m_LiveWireFilter->Update();

    mitk::ContourModel *liveWireContour = this->m_LiveWireFilter->GetOutput();
    assert(liveWireContour);

    if (liveWireContour->IsEmpty(timestep))
      return;

    liveWireContour->RemoveVertexAt(0, timestep);
    liveWireContour->RemoveVertexAt(liveWireContour->GetNumberOfVertices(timestep) - 1, timestep);

    // insert new live wire computed points
    newContour->Concatenate(liveWireContour, timestep);

    // insert right side of original contour
    newContour->Concatenate(this->m_ContourRight, timestep);

    newContour->SetClosed(contour->IsClosed(timestep), timestep);

    // instead of leaving a single point, delete all points
    if (newContour->GetNumberOfVertices(timestep) <= 2)
    {
      newContour->Clear(timestep);
    }

    this->GetDataNode()->SetData(newContour);

    mitk::RenderingManager::GetInstance()->RequestUpdate(interactionEvent->GetSender()->GetRenderWindow());
  }
}

void mitk::ContourModelLiveWireInteractor::OnMovePoint(StateMachineAction *, InteractionEvent *interactionEvent)
{
  const auto *positionEvent = dynamic_cast<const InteractionPositionEvent *>(interactionEvent);
  if (!positionEvent)
    return;

  int timestep = positionEvent->GetSender()->GetTimeStep();
  mitk::Point3D currentPosition = positionEvent->GetPositionInWorld();

  auto *contour = dynamic_cast<mitk::ContourModel *>(this->GetDataNode()->GetData());
  if (contour == nullptr)
  {
    MITK_ERROR << "invalid contour";
    return;
  }

  mitk::ContourModel::Pointer editingContour = mitk::ContourModel::New();
  editingContour->Expand(contour->GetTimeSteps());

  // recompute left live wire, i.e. the contour between previous active vertex and selected vertex
  this->m_LiveWireFilter->SetStartPoint(this->m_NextActiveVertexDown);
  this->m_LiveWireFilter->SetEndPoint(currentPosition);

  // remove void positions between previous active vertex and next active vertex.
  if (!m_ContourBeingModified.empty())
  {
    std::vector<itk::Index<2>>::const_iterator iter = m_ContourBeingModified.begin();
    for (; iter != m_ContourBeingModified.end(); iter++)
    {
      this->m_LiveWireFilter->RemoveRepulsivePoint((*iter));
    }
  }

  // update to get the left livewire. Remember that the points in the rest of the contour are already
  // set as void positions in the filter
  this->m_LiveWireFilter->Update();

  mitk::ContourModel::Pointer leftLiveWire = this->m_LiveWireFilter->GetOutput();
  assert(leftLiveWire);

  if (!leftLiveWire->IsEmpty(timestep))
    leftLiveWire->RemoveVertexAt(0, timestep);

  editingContour->Concatenate(leftLiveWire, timestep);

  // the new index of the selected vertex
  unsigned int selectedVertexIndex =
    this->m_ContourLeft->GetNumberOfVertices(timestep) + leftLiveWire->GetNumberOfVertices(timestep) - 1;

  // at this point the container has to be empty
  m_ContourBeingModified.clear();

  // add points from left live wire contour
  auto iter = leftLiveWire->IteratorBegin(timestep);
  for (; iter != leftLiveWire->IteratorEnd(timestep); iter++)
  {
    itk::Index<2> idx;
    this->m_WorkingSlice->GetGeometry()->WorldToIndex((*iter)->Coordinates, idx);
    this->m_LiveWireFilter->AddRepulsivePoint(idx);

    // add indices
    m_ContourBeingModified.push_back(idx);
  }

  // recompute right live wire, i.e. the contour between selected vertex and next active vertex
  this->m_LiveWireFilter->SetStartPoint(currentPosition);
  this->m_LiveWireFilter->SetEndPoint(m_NextActiveVertexUp);

  // update filter with all contour points set as void but the right live wire portion to be calculated now
  this->m_LiveWireFilter->Update();

  mitk::ContourModel::Pointer rightLiveWire = this->m_LiveWireFilter->GetOutput();
  assert(rightLiveWire);

  // reject strange paths
  if (abs(rightLiveWire->GetNumberOfVertices(timestep) - leftLiveWire->GetNumberOfVertices(timestep)) > 50)
  {
    return;
  }

  if (!leftLiveWire->IsEmpty(timestep))
    leftLiveWire->SetControlVertexAt(leftLiveWire->GetNumberOfVertices() - 1, timestep);

  if (!rightLiveWire->IsEmpty(timestep))
    rightLiveWire->RemoveVertexAt(0, timestep);

  editingContour->Concatenate(rightLiveWire, timestep);

  m_EditingContourNode->SetData(editingContour);

  mitk::ContourModel::Pointer newContour = mitk::ContourModel::New();
  newContour->Expand(contour->GetTimeSteps());

  // concatenate left original contour
  newContour->Concatenate(this->m_ContourLeft, timestep);

  newContour->Concatenate(editingContour, timestep, true);

  // set last inserted vertex as selected
  newContour->SelectVertexAt(selectedVertexIndex, timestep);

  // set as control point
  newContour->SetSelectedVertexAsControlPoint(true);

  // concatenate right original contour
  newContour->Concatenate(this->m_ContourRight, timestep);

  newContour->SetClosed(contour->IsClosed(timestep), timestep);
  this->GetDataNode()->SetData(newContour);

  mitk::RenderingManager::GetInstance()->RequestUpdate(positionEvent->GetSender()->GetRenderWindow());
}

bool mitk::ContourModelLiveWireInteractor::IsHovering(const InteractionEvent *interactionEvent)
{
  const auto *positionEvent = dynamic_cast<const InteractionPositionEvent *>(interactionEvent);
  if (!positionEvent)
    return false;

  int timestep = positionEvent->GetSender()->GetTimeStep();

  auto *contour = dynamic_cast<mitk::ContourModel *>(this->GetDataNode()->GetData());

  mitk::Point3D currentPosition = positionEvent->GetPositionInWorld();

  bool isHover = false;
  this->GetDataNode()->GetBoolProperty("contour.hovering", isHover, positionEvent->GetSender());
  if (contour->IsNearContour(currentPosition, 1.5, timestep))
  {
    if (isHover == false)
    {
      this->GetDataNode()->SetBoolProperty("contour.hovering", true);
      mitk::RenderingManager::GetInstance()->RequestUpdate(positionEvent->GetSender()->GetRenderWindow());
    }
  }
  else
  {
    if (isHover == true)
    {
      this->GetDataNode()->SetBoolProperty("contour.hovering", false);
      mitk::RenderingManager::GetInstance()->RequestUpdate(positionEvent->GetSender()->GetRenderWindow());
    }
  }
  return false;
}

int mitk::ContourModelLiveWireInteractor::SplitContourFromSelectedVertex(mitk::ContourModel *srcContour,
                                                                         mitk::ContourModel *destContour,
                                                                         bool fromSelectedUpwards,
                                                                         int timestep)
{
  auto end = srcContour->IteratorEnd();
  auto begin = srcContour->IteratorBegin();

  // search next active control point to left and rigth and set as start and end point for filter
  auto itSelected = begin;

  // move iterator to position
  while ((*itSelected) != srcContour->GetSelectedVertex())
  {
    itSelected++;
  }

  // CASE search upwards for next control point
  if (fromSelectedUpwards)
  {
    auto itUp = itSelected;

    if (itUp != end)
    {
      itUp++; // step once up otherwise the loop breaks immediately
    }

    while (itUp != end && !((*itUp)->IsControlPoint))
    {
      itUp++;
    }

    auto it = itUp;

    if (itSelected != begin)
    {
      // copy the rest of the original contour
      while (it != end)
      {
        destContour->AddVertex((*it)->Coordinates, (*it)->IsControlPoint, timestep);
        it++;
      }
    }
    // else do not copy the contour

    // return the offset of iterator at one before next-vertex-upwards
    if (itUp != begin)
    {
      return std::distance(begin, itUp) - 1;
    }
    else
    {
      return std::distance(begin, itUp);
    }
  }
  else // CASE search downwards for next control point
  {
    auto itDown = itSelected;
    auto it = srcContour->IteratorBegin();

    if (itSelected != begin)
    {
      if (itDown != begin)
      {
        itDown--; // step once down otherwise the the loop breaks immediately
      }

      while (itDown != begin && !((*itDown)->IsControlPoint))
      {
        itDown--;
      }

      if (it != end) // if not empty
      {
        // always add the first vertex
        destContour->AddVertex((*it)->Coordinates, (*it)->IsControlPoint, timestep);
        it++;
      }
      // copy from begin to itDown
      while (it <= itDown)
      {
        destContour->AddVertex((*it)->Coordinates, (*it)->IsControlPoint, timestep);
        it++;
      }
    }
    else
    {
      // if selected vertex is the first element search from end of contour downwards
      itDown = end;
      itDown--;
      while (!((*itDown)->IsControlPoint) && itDown != begin)
      {
        itDown--;
      }

      // move one forward as we don't want the first control point
      it++;
      // move iterator to second control point
      while ((it != end) && !((*it)->IsControlPoint))
      {
        it++;
      }
      // copy from begin to itDown
      while (it <= itDown)
      {
        // copy the contour from second control point to itDown
        destContour->AddVertex((*it)->Coordinates, (*it)->IsControlPoint, timestep);
        it++;
      }
    }
    /*
        //add vertex at itDown - it's not considered during while loop
        if( it != begin && it != end)
        {
          //destContour->AddVertex( (*it)->Coordinates, (*it)->IsControlPoint, timestep);
        }
    */
    // return the offset of iterator at one after next-vertex-downwards
    if (itDown != end)
    {
      return std::distance(begin, itDown); // + 1;//index of next vertex
    }
    else
    {
      return std::distance(begin, itDown) - 1;
    }
  }
}

void mitk::ContourModelLiveWireInteractor::OnFinishEditing(StateMachineAction *, InteractionEvent *interactionEvent)
{
  int timestep = interactionEvent->GetSender()->GetTimeStep();

  auto *editingContour = dynamic_cast<mitk::ContourModel *>(this->m_EditingContourNode->GetData());

  editingContour->Clear(timestep);

  mitk::RenderingManager::GetInstance()->RequestUpdate(interactionEvent->GetSender()->GetRenderWindow());
}