cxDummyTool.cpp

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/

#include <boost/cstdint.hpp>
#include "cxDummyTool.h"

#include <vtkPolyData.h>
#include <vtkAppendPolyData.h>
#include <vtkConeSource.h>
#include <vtkCylinderSource.h>
#include <QTimer>
#include <QTime>
#include <vtkPlane.h>
#include <vtkClipPolyData.h>

#include "cxTimeKeeper.h"
#include "cxMathUtils.h"

namespace cx
{

ProbeDefinition DummyToolTestUtilities::createProbeDefinition(ProbeDefinition::TYPE type, double depth, double width, Eigen::Array2i frameSize)
{
        ProbeDefinition retval;
        retval.setType(type);
        Eigen::Array2i extent = frameSize - 1;
        retval.setSector(0, depth, width, 0);

        Vector3D imageSpacing(width/extent[0], depth/extent[1], 1.0);
        retval.setOrigin_p(Vector3D(frameSize[0]/2,0,0));
        retval.setSpacing(imageSpacing);
        retval.setClipRect_p(DoubleBoundingBox3D(0, extent[0], 0, extent[1], 0, 0));
        retval.setSize(QSize(frameSize[0], frameSize[1]));

        return retval;
}

ProbeDefinition DummyToolTestUtilities::createProbeDefinitionLinear(double depth, double width, Eigen::Array2i frameSize)
{
        return createProbeDefinition(ProbeDefinition::tLINEAR, depth, width, frameSize);
}

DummyToolPtr DummyToolTestUtilities::createDummyTool(ProbeDefinition probeDefinition)
{
        DummyToolPtr retval(new DummyTool());
        retval->setProbeSector(probeDefinition);
        retval->setVisible(true);
        retval->startTracking(30);
        return retval;
}


int DummyTool::mTransformCount = 0;




DummyTool::DummyTool(const QString& uid) :
        ToolImpl(uid),
        mVisible(false),
        mTransformSaveFileName("DummyToolsAreToDumbToSaveThemselves"),
        mTimer(new QTimer()),
        mThread(NULL)
{
        qRegisterMetaType<Transform3D>("Transform3D");
        mUid = uid;
        mName = uid;

        DoubleBoundingBox3D bb(Vector3D(0,0,0), Vector3D(512,512,256));
        setToolPositionMovementBB(bb);
        mPolyData = this->createPolyData(150, 15, 4, 2);

        connect(mTimer.get(), SIGNAL(timeout()),this, SLOT(sendTransform()));
}

DummyTool::~DummyTool()
{
        this->stopThread();
}

std::set<Tool::Type> DummyTool::getTypes() const
{
        return mTypes;
}

void DummyTool::setToolPositionMovementBB(const DoubleBoundingBox3D& bb)
{
        setToolPositionMovement(createToolPositionMovement(bb));
}

std::vector<Transform3D> DummyTool::getToolPositionMovement()
{
        return mTransforms;
}

void DummyTool::setToolPositionMovement(const std::vector<Transform3D>& positions)
{
        mTransforms = positions;
}

void DummyTool::setType(Tool::Type type)
{
        mTypes.clear();
        mTypes.insert(type);
}

vtkPolyDataPtr DummyTool::getGraphicsPolyData() const
{
        return mPolyData;
}
void DummyTool::setTransformSaveFile(const QString& filename)
{
        mTransformSaveFileName = filename;
}

bool DummyTool::getVisible() const
{
        return mVisible;
}
QString DummyTool::getUid() const
{
        return mUid;
}
QString DummyTool::getName() const
{
        return mName;
}
void DummyTool::startTracking(int interval)
{
        mThread = new DummyToolThread(interval);
        connect(mThread, SIGNAL(ping()), this, SLOT(sendTransform()));
        mThread->start();


//      mTimer->start(interval);
//std::cout << "start tracking" << std::endl;
        mVisible = true;

        emit toolVisible(mVisible);
}
bool DummyTool::isCalibrated() const
{
        return true;
}

void DummyTool::stopThread()
{
        if (!mThread)
        {
                return;
        }
        disconnect(mThread, SIGNAL(ping()), this, SLOT(sendTransform()));

        mThread->quit();
        mThread->wait(2000); // forever or until dead thread

        if (mThread->isRunning())
        {
                mThread->terminate();
                mThread->wait(); // forever or until dead thread
        }
        mThread = NULL;
}

void DummyTool::stopTracking()
{
        this->stopThread();

//      std::cout << "stop tracking" << std::endl;

        mVisible = false;
        emit toolVisible(mVisible);
}

void DummyTool::setVisible(bool val)
{
        mVisible = val;
        emit toolVisible(mVisible);
}
void DummyTool::sendTransform()
{       
        set_prMt(*getNextTransform());
//      std::cout << "DummyTool::sendTransform(): " <<  this->get_prMt().coord(Vector3D(0,0,0)) << std::endl;
}

vtkPolyDataPtr DummyTool::createPolyData(double h1, double h2, double r1, double r2)
{

//      double r1 = 10;
//      double r2 = 3;
//      double h1 = 140;
//      double h2 =  10;

        vtkAppendPolyDataPtr assembly = vtkAppendPolyDataPtr::New(); 

        vtkPlanePtr plane = vtkPlanePtr::New();
        plane->SetNormal(0,0,-1);
        plane->SetOrigin(0,0,-h2);

        vtkConeSourcePtr cone1 = vtkConeSourcePtr::New();
        double h1_extension = h1*r2 / (r1-r2); 
        double h1_mod = h1+h1_extension;
        cone1->SetResolution(50);
        cone1->SetRadius(r1);
        cone1->SetHeight(h1_mod);
        cone1->SetDirection(0,0,1);
        double center1 = -h1/2-h2+h1_extension/2;
        cone1->SetCenter(Vector3D(0,0,center1).begin());

        vtkClipPolyDataPtr clipper1 = vtkClipPolyDataPtr::New();
        clipper1->SetInputConnection(cone1->GetOutputPort());
        clipper1->SetClipFunction(plane);    

        vtkConeSourcePtr cone2 = vtkConeSourcePtr::New();
        cone2->SetResolution(25);
        cone2->SetRadius(r2);
        cone2->SetHeight(h2);
        cone2->SetDirection(0,0,1);
        double center2 = -h2/2;
        cone2->SetCenter(Vector3D(0,0,center2).begin());

        assembly->AddInputConnection(clipper1->GetOutputPort());
        assembly->AddInputConnection(cone2->GetOutputPort());
//    mPolyData = assembly->GetOutput();
        assembly->Update();
        return assembly->GetOutput();
}

void DummyTool::createLinearMovement(std::vector<Transform3D>* retval, Transform3D* T_in, const Transform3D& R, const Vector3D& a, const Vector3D& b, double step) const
{
        Vector3D u = (b-a).normal();
        unsigned N = roundAwayFromZero((b-a).length()/step);
        Transform3D& T = *T_in;

        for (unsigned i=0; i<N; ++i)
        {
                Transform3D T_delta = createTransformTranslate(u*step);
                T = T_delta * T;
                retval->push_back(T * R);
        }
}

std::vector<Transform3D> DummyTool::createToolPositionMovement(const DoubleBoundingBox3D& bb) const
{
//      std::cout<<"createToolPositionMovement:"<<bb<<std::endl;
        std::vector<Transform3D> retval;

        Vector3D range = bb.range();
        // define four points. Traverse them and then back to the starting point.
        Vector3D a = bb.center() + Vector3D(range[0]/2, 0, 0);
        Vector3D b = bb.center();
        Vector3D c = b + Vector3D(0, -range[0]*0.1, 0);
        Vector3D d = c + Vector3D(0, 0, range[2]/2);

//    Vector3D a = bb.corner(0,0,0);
//    Vector3D b = bb.corner(1,0,0);
//    Vector3D c = bb.corner(1,1,0);
//    Vector3D d = bb.corner(1,1,1);

//    std::cout << "a" << a << std::endl;
//    std::cout << "b" << b << std::endl;
//    std::cout << "c" << c << std::endl;
//    std::cout << "d" << d << std::endl;

        int steps = 200;
        double step = *std::max_element(range.begin(), range.end()) / steps;

        Transform3D r0 = createTransformRotateX(M_PI)*createTransformRotateZ(-M_PI*0.5);
        Transform3D R = createTransformRotateZ(-M_PI*0.25)*createTransformRotateX(-M_PI*0.25) * r0;
        Transform3D T = createTransformTranslate(a);  

        createLinearMovement(&retval, &T, R, a, b, step);    

        for (unsigned i=0; i<50; ++i)
        {
                Transform3D r_delta = createTransformRotateZ(-M_PI*0.01);
                R = r_delta * R;
                retval.push_back(T * R);
        }

        createLinearMovement(&retval, &T, R, b, c, step);    

        for (unsigned i=0; i<50; ++i)
        {
                Transform3D r_delta = createTransformRotateZ(-M_PI*0.01);
                R = r_delta * R;
                retval.push_back(T * R);
        }

        createLinearMovement(&retval, &T, R, c, d, step);    
        createLinearMovement(&retval, &T, R, d, a, step);    

        for (unsigned i=0; i<20; ++i)
        {
                Transform3D r_delta = createTransformRotateZ(-M_PI/20);
                R = r_delta * R;
                retval.push_back(T * R);
        }

        return retval;
}

std::vector<Transform3D> DummyTool::createToolPositionMovementTranslationOnly(const DoubleBoundingBox3D& bb) const
{
        std::vector<Transform3D> retval;

        Vector3D range = bb.range();
        // define four points. Traverse them and then back to the starting point.
//    Vector3D a = bb.center() + Vector3D(range[0]/2, range[0]/10, range[0]/10);
//    Vector3D b = bb.center();
//    Vector3D c = b + Vector3D(-range[0]*0.1, -range[0]*0.1, -range[0]*0.1);
//    Vector3D d = c + Vector3D(range[0]*0.1, range[0]*0.1, range[2]/3);
        Vector3D a = bb.center() + Vector3D( range[0]*0.4,  range[1]*0.4,  range[2]*0.4);
        Vector3D b = bb.center();
        Vector3D c = bb.center() + Vector3D(-range[0]*0.4, -range[1]*0.1, -range[2]*0.1);
        Vector3D d = bb.center() + Vector3D( range[0]*0.0,  range[1]*0.1,  range[2]*0.3);

        int steps = 200;
        double step = *std::max_element(range.begin(), range.end()) / steps;

        Transform3D r0 = createTransformRotateX(M_PI)*createTransformRotateZ(-M_PI*0.5);
        Transform3D R = createTransformRotateZ(-M_PI*0.25)*createTransformRotateX(-M_PI*0.25) * r0;
        Transform3D T = createTransformTranslate(a);

        createLinearMovement(&retval, &T, R, a, b, step);
        createLinearMovement(&retval, &T, R, b, c, step);
        createLinearMovement(&retval, &T, R, c, d, step);
        createLinearMovement(&retval, &T, R, d, a, step);

        return retval;
}


Transform3D* DummyTool::getNextTransform()
{
        if(mTransformCount >= int(mTransforms.size()))
                mTransformCount = 0;

        return &mTransforms.at(mTransformCount++);
}

void DummyTool::set_prMt(const Transform3D& prMt)
{
        double timestamp = this->getTimestamp();
        ToolImpl::set_prMt(prMt, timestamp);
}

Transform3D DummyTool::getCalibration_sMt() const
{
        return createTransformTranslate(Vector3D(5,5,20));
}


}//namespace cx