cxVNNclAlgorithm.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 CXVNNCLALGORITHM_H_
#define CXVNNCLALGORITHM_H_

//TODO remove, should be defined in oul instead
#define __CL_ENABLE_EXCEPTIONS //telling the opencl c++ wrapper to throw exceptions

#include "cxUSFrameData.h"
#include "OpenCLManager.hpp"
#include "RuntimeMeasurementManager.hpp"

namespace cx
{
class VNNclAlgorithm
{
public:
        VNNclAlgorithm();
        ~VNNclAlgorithm();

        typedef struct __frameBlock_t
        {
                unsigned char* data;
                size_t length;
        } frameBlock_t;

        virtual bool initCL(QString kernelFile,
                            int nMaxPlanes,
                            int nPlanes,
                            int method,
                            int planeMethod,
                            int nStarts,
                            float brightnessWeight,
                            float newnessWeight);
        virtual cl::Program buildCLProgram(std::string program_src, std::string kernelPath,
                                          int nMaxPlanes,
                                          int nPlanes,
                                          int method,
                                          int planeMethod,
                                          int nStarts,
                                          float brightnessWeight,
                                          float newnessWeight);
        virtual bool reconstruct(ProcessedUSInputDataPtr input,
                                      vtkImageDataPtr outputData,
                                      float radius,
                                      int nClosePlanes);

        virtual bool initializeFrameBlocks(frameBlock_t* framePointers,
                                           int numBlocks,
                                           ProcessedUSInputDataPtr inputFrames);
        virtual void freeFrameBlocks(frameBlock_t* framePointers,
                                     int numBlock);


        virtual void fillPlaneMatrices(float *planeMatrices,
                                       ProcessedUSInputDataPtr input);

        void setProfiling(bool on);
        double getTotalExecutionTime();
        double getKernelExecutionTime();

private:
        void setKernelArguments(
                        cl::Kernel kernel,
                        int volume_xsize,
                int volume_ysize,
                int volume_zsize,
                float volume_xspacing,
                float volume_yspacing,
                float volume_zspacing,
                int in_xsize,
                int in_ysize,
                float in_xspacing,
                float in_yspacing,
                std::vector<cl::Buffer>& blocks,
                cl::Buffer out_volume,
                cl::Buffer plane_matrices,
                cl::Buffer mask,
                size_t plane_eqs_size,
                size_t close_planes_size,
                float radius);
        size_t calculateSpaceNeededForClosePlanes(cl::Kernel kernel, cl::Device device, size_t local_work_size, size_t nPlanes_numberOfInputImages, int nClosePlanes);
        bool isUsingTooMuchMemory(size_t outputVolumeSize, size_t inputBlocksLength, cl_ulong globalMemUse);
        void measureAndExecuteKernel(cl::CommandQueue queue, cl::Kernel kernel, size_t global_work_size, size_t local_work_size, std::string measurementName);
        void measureAndReadBuffer(cl::CommandQueue queue, cl::Buffer outputBuffer, size_t outputVolumeSize, void *outputData, std::string measurementName);

        void startProfiling(std::string name, cl::CommandQueue queue);
        void stopProfiling(std::string name, cl::CommandQueue queue);

        cl::Kernel mKernel;
        oul::ContextPtr mOulContex;
        oul::RuntimeMeasurementsManagerPtr mRuntime;
        std::set<std::string> mMeasurementNames;
        std::string mKernelMeasurementName;

};

typedef boost::shared_ptr<VNNclAlgorithm> VNNclAlgorithmPtr;

} /* namespace cx */
#endif /* CXVNNCLALGORITHM_H_ */