cxInteractiveCropper.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.
=========================================================================*/

/*
 * cxInteractiveCropper.cpp
 *
 *  \date Aug 24, 2010
 *      \author christiana
 */
#include "cxInteractiveCropper.h"

#include "cxView.h"

#include <vector>
#include <vtkTransform.h>
#include <vtkAbstractVolumeMapper.h>
#include <vtkVolumeMapper.h>
#include <vtkRenderWindow.h>
#include <vtkRenderer.h>
#include <vtkImageData.h>
#include <vtkCommand.h>
#include <vtkBoxWidget2.h>
#include <vtkBoxWidget.h>
#include "cxTypeConversions.h"
#include "cxBoundingBox3D.h"
#include "cxImage.h"
#include "cxTransform3D.h"
#include "cxVolumetricRep.h"

#include "cxActiveImageProxy.h"
#include "cxActiveData.h"

namespace cx
{

class CropBoxCallback: public vtkCommand
{
public:
        CropBoxCallback() : mCropper(NULL)
        {
        }
        static CropBoxCallback* New()
        {
                return new CropBoxCallback;
        }
        void SetCropper(InteractiveCropper* cropper)
        {
                mCropper = cropper;
        }
        virtual void Execute(vtkObject* caller, unsigned long, void*)
        {
                DoubleBoundingBox3D bb_new = mCropper->getBoxWidgetSize();
                mCropper->setCroppingRegion(bb_new);
        }
        InteractiveCropper* mCropper;
};

class CropBoxEnableCallback: public vtkCommand
{
public:
        CropBoxEnableCallback() : mCropper(NULL), mValue(false)
        {
        }
        static CropBoxEnableCallback* New()
        {
                return new CropBoxEnableCallback;
        }
        void SetCropper(bool val, InteractiveCropper* cropper)
        {
                mValue = val;
                mCropper = cropper;
        }
        virtual void Execute(vtkObject* caller, unsigned long, void*)
        {
                DoubleBoundingBox3D bb_new = mCropper->getBoxWidgetSize();
                mCropper->boxWasShown(mValue);
        }
        bool mValue;
        InteractiveCropper* mCropper;
};

//---------------------------------------------------------
//---------------------------------------------------------
//---------------------------------------------------------


InteractiveCropper::InteractiveCropper(ActiveDataPtr activeData) :
        mActiveData(activeData)
{
        mActiveImageProxy = ActiveImageProxy::New(mActiveData);
        connect(mActiveImageProxy.get(), &ActiveImageProxy::activeImageChanged, this, &InteractiveCropper::imageChangedSlot);
        connect(mActiveImageProxy.get(), SIGNAL(cropBoxChanged()), this, SLOT(imageCropChangedSlot()));
}

void InteractiveCropper::initialize()
{
        if (mBoxWidget) // already initialized
                return;

        mBoxWidget = vtkBoxWidgetPtr::New();
        mBoxWidget->RotationEnabledOff();

        double bb_hard[6] =
        { -1, 1, -1, 1, -1, 1 };
        mBoxWidget->PlaceWidget(bb_hard);

        mCropBoxCallback = CropBoxCallbackPtr::New();
        mCropBoxCallback->SetCropper(this);
        mCropBoxEnableCallback = CropBoxEnableCallbackPtr::New();
        mCropBoxEnableCallback->SetCropper(true, this);
        mCropBoxDisableCallback = CropBoxEnableCallbackPtr::New();
        mCropBoxDisableCallback->SetCropper(false, this);

        mBoxWidget->SetInteractor(mView->getRenderWindow()->GetInteractor());

        mBoxWidget->SetEnabled(false);
}

void InteractiveCropper::setView(ViewPtr view)
{
        mView = view;
        this->updateBoxWidgetInteractor();
}

void InteractiveCropper::updateBoxWidgetInteractor()
{
        if (!mView)
                return;

        this->initialize();

        if (this->getUseCropping())
        {
                mBoxWidget->SetInteractor(mView->getRenderWindow()->GetInteractor());
                mBoxWidget->AddObserver(vtkCommand::InteractionEvent, mCropBoxCallback);
                mBoxWidget->AddObserver(vtkCommand::EnableEvent, mCropBoxEnableCallback);
                mBoxWidget->AddObserver(vtkCommand::DisableEvent, mCropBoxDisableCallback);
        }
        else
        {
                mBoxWidget->RemoveObserver(vtkCommand::InteractionEvent);
                mBoxWidget->RemoveObserver(vtkCommand::EnableEvent);
                mBoxWidget->RemoveObserver(vtkCommand::DisableEvent);
        }
}

void InteractiveCropper::showBoxWidget(bool on)
{
        if (!mImage)
                return;
        if (!mBoxWidget)
                return;
        if (this->getShowBoxWidget() == on)
                return;

        //Turn on cropping if not on to save user from pressing two boxes
        if (!mImage->getCropping() && on)
                this->useCropping(true);

        mBoxWidget->SetEnabled(on);
        emit changed();
}

DoubleBoundingBox3D InteractiveCropper::getBoundingBox()
{
        if (!mImage || !mBoxWidget)
                return DoubleBoundingBox3D(0,0,0,0,0,0);
        return mImage->getCroppingBox();
}

void InteractiveCropper::setBoundingBox(const DoubleBoundingBox3D& bb_d)
{
        this->setCroppingRegion(bb_d);
        this->setBoxWidgetSize(bb_d);
}

void InteractiveCropper::useCropping(bool on)
{
        if (this->getUseCropping() == on)
                return;

        if (!mImage)
                return;

        mImage->setCropping(on);
}

void InteractiveCropper::imageCropChangedSlot()
{
        if (!mImage)
                return;

        DoubleBoundingBox3D bb_d = this->getBoundingBox();
        this->setBoxWidgetSize(bb_d);
        this->updateBoxWidgetInteractor();

        if (!mImage->getCropping())
                this->showBoxWidget(false);

        emit changed();
}

void InteractiveCropper::resetBoundingBox()
{
        emit changed();
}

void InteractiveCropper::imageChangedSlot()
{
//      mImage = mPatientModelService->getActiveImage();
        mImage = mActiveData->getActive<Image>();

        this->imageCropChangedSlot();
        emit changed();
}

bool InteractiveCropper::getUseCropping()
{
        if (!mImage)
                return false;
        return mImage->getCropping();
}

bool InteractiveCropper::getShowBoxWidget() const
{
        if (!mBoxWidget)
                return false;
        return mBoxWidget->GetEnabled();
}

std::vector<int> InteractiveCropper::getDimensions()
{
        std::vector<int> dimensions;
        if(!mImage)
                return dimensions;

        double spacing_x = 1;
        double spacing_y = 1;
        double spacing_z = 1;
        mImage->getBaseVtkImageData()->GetSpacing(spacing_x, spacing_y, spacing_z);

        DoubleBoundingBox3D bb = getBoxWidgetSize();
        int dim_x = (bb.begin()[1] - bb.begin()[0])/spacing_x + 1; //adding 1 because of some rounding errors, is there a better way to do this?
        int dim_y = (bb.begin()[3] - bb.begin()[2])/spacing_y + 1;
        int dim_z = (bb.begin()[5] - bb.begin()[4])/spacing_z + 1;
        dimensions.push_back(dim_x);
        dimensions.push_back(dim_y);
        dimensions.push_back(dim_z);

        return dimensions;
}

void InteractiveCropper::setBoxWidgetSize(const DoubleBoundingBox3D& bb_d)
{
        if (!mImage || !mBoxWidget)
                return;

        double bb_hard[6] =
        { -0.5, 0.5, -0.5, 0.5, -0.5, 0.5 };
        DoubleBoundingBox3D bb_unit(bb_hard);
        Transform3D M = createTransformNormalize(bb_unit, bb_d);
        Transform3D rMd = mImage->get_rMd();
        M = rMd * M;

        vtkTransformPtr transform = vtkTransformPtr::New();
        transform->SetMatrix(M.getVtkMatrix());
        mBoxWidget->SetTransform(transform);
}

DoubleBoundingBox3D InteractiveCropper::getBoxWidgetSize()
{
        if (!mImage || !mBoxWidget)
        {
                return DoubleBoundingBox3D::zero();
        }

        double bb_hard[6] =
        { -0.5, 0.5, -0.5, 0.5, -0.5, 0.5 };
        DoubleBoundingBox3D bb_unit(bb_hard);

        vtkTransformPtr transform = vtkTransformPtr::New();
        mBoxWidget->GetTransform(transform);
        Transform3D M(transform->GetMatrix());

        Transform3D rMd = mImage->get_rMd();
        M = rMd.inv() * M;

        DoubleBoundingBox3D bb_new_r = cx::transform(M, bb_unit);

        return bb_new_r;
}

void InteractiveCropper::setCroppingRegion(DoubleBoundingBox3D bb_d)
{
        if (!mImage)
                return;
        mImage->setCroppingBox(bb_d);
        emit changed();
}

void InteractiveCropper::boxWasShown(bool val)
{
        emit changed();
}

DoubleBoundingBox3D InteractiveCropper::getMaxBoundingBox()
{
        if (!mImage)
                return DoubleBoundingBox3D::zero();
        return mImage->boundingBox();
}

} // namespace cx