cxUsReconstructionService.h

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

#ifndef CXUSRECONSTRUCTIONSERVICE_H
#define CXUSRECONSTRUCTIONSERVICE_H

#include "org_custusx_usreconstruction_Export.h"

#include <boost/shared_ptr.hpp>
#include <set>
#include <vector>
#include <QObject>
#include "cxForwardDeclarations.h"
#include "cxReconstructCore.h"

#define UsReconstructionService_iid "cx::UsReconstructionService"

namespace cx
{
struct USReconstructInputData;
class XmlOptionFile;
class OutputVolumeParams;
class ReconstructionMethodService;

typedef boost::shared_ptr<class TimedBaseAlgorithm> TimedAlgorithmPtr;
typedef boost::shared_ptr<class CompositeTimedAlgorithm> CompositeTimedAlgorithmPtr;
typedef boost::shared_ptr<class ReconstructionManager> ReconstructionManagerPtr;
typedef boost::shared_ptr<class ReconstructCore> ReconstructCorePtr;
typedef boost::shared_ptr<class ReconstructParams> ReconstructParamsPtr;
typedef boost::shared_ptr<class ReconstructPreprocessor> ReconstructPreprocessorPtr;
typedef boost::shared_ptr<class ThreadedTimedReconstructer> ThreadedTimedReconstructerPtr;
typedef boost::shared_ptr<class ThreadedTimedReconstructPreprocessor> ThreadedTimedReconstructPreprocessorPtr;
typedef boost::shared_ptr<class ThreadedTimedReconstructCore> ThreadedTimedReconstructCorePtr;

typedef boost::shared_ptr<class ReconstructionExecuter> ReconstructionExecuterPtr;

typedef boost::shared_ptr<class UsReconstructionService> UsReconstructionServicePtr;

class org_custusx_usreconstruction_EXPORT UsReconstructionService : public QObject
{
        Q_OBJECT
public:

        virtual void selectData(QString filename, QString calFilesPath = "") = 0; 
        virtual void selectData(USReconstructInputData data) = 0; 

        virtual QString getSelectedFilename() const = 0; 
        virtual USReconstructInputData getSelectedFileData() = 0; 
//      virtual ReconstructParamsPtr getParams() = 0; ///< Return control parameters that can be adjusted by the GUI or similar prior to reconstruction
        virtual PropertyPtr getParam(QString uid) = 0; 
        virtual std::vector<PropertyPtr> getAlgoOptions() = 0; 
        virtual XmlOptionFile getSettings() = 0; 
        virtual OutputVolumeParams getOutputVolumeParams() const = 0; 

        virtual void setOutputVolumeParams(const OutputVolumeParams& par) = 0; 
//      virtual void setOutputRelativePath(QString path) = 0; ///< Set location of output relative to base
//      virtual void setOutputBasePath(QString path) = 0; ///< Set base location of output

        virtual void startReconstruction() = 0;
        virtual std::set<cx::TimedAlgorithmPtr> getThreadedReconstruction() = 0; 

        virtual ReconstructionMethodService* createAlgorithm() = 0;

        virtual ReconstructCore::InputParams createCoreParameters() = 0;

        virtual bool isNull() = 0;
        static UsReconstructionServicePtr getNullObject();

public slots:
        virtual void newDataOnDisk(QString mhdFilename) = 0;

signals:
        void paramsChanged();
        void algorithmChanged();
        void inputDataSelected(QString mhdFileName);
        void reconstructAboutToStart();
        void reconstructStarted();
        void reconstructFinished();

        void newInputDataAvailable(QString mhdFileName);
        void newInputDataPath(QString path);
};

} //cx
Q_DECLARE_INTERFACE(cx::UsReconstructionService, UsReconstructionService_iid)

#endif // CXUSRECONSTRUCTIONSERVICE_H