gadgetron_client.h

Go to the documentation of this file.

/*
SyneRBI Synergistic Image Reconstruction Framework (SIRF)
Copyright 2015 - 2019 Rutherford Appleton Laboratory STFC

This is software developed for the Collaborative Computational
Project in Synergistic Reconstruction for Biomedical Imaging (formerly CCP PETMR)
(http://www.ccpsynerbi.ac.uk/).

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This file contains code snippets from
Gadgetron/apps/clients/gadgetron_ismrmrd_client/gadgetron_ismrmrd_client.cpp
by Michael S. Hansen

GADGETRON SOFTWARE LICENSE V1.0, NOVEMBER 2011

PERMISSION IS HEREBY GRANTED, FREE OF CHARGE, TO ANY PERSON OBTAINING
A COPY OF THIS SOFTWARE AND ASSOCIATED DOCUMENTATION FILES (THE
"SOFTWARE"), TO DEAL IN THE SOFTWARE WITHOUT RESTRICTION, INCLUDING
WITHOUT LIMITATION THE RIGHTS TO USE, COPY, MODIFY, MERGE, PUBLISH,
DISTRIBUTE, SUBLICENSE, AND/OR SELL COPIES OF THE SOFTWARE, AND TO
PERMIT PERSONS TO WHOM THE SOFTWARE IS FURNISHED TO DO SO, SUBJECT TO
THE FOLLOWING CONDITIONS:

THE ABOVE COPYRIGHT NOTICE, THIS PERMISSION NOTICE, AND THE LIMITATION
OF LIABILITY BELOW SHALL BE INCLUDED IN ALL COPIES OR REDISTRIBUTIONS
OF SUBSTANTIAL PORTIONS OF THE SOFTWARE.

SOFTWARE IS BEING DEVELOPED IN PART AT THE NATIONAL HEART, LUNG, AND BLOOD
INSTITUTE, NATIONAL INSTITUTES OF HEALTH BY AN EMPLOYEE OF THE FEDERAL
GOVERNMENT IN THE COURSE OF HIS OFFICIAL DUTIES. PURSUANT TO TITLE 17,
SECTION 105 OF THE UNITED STATES CODE, THIS SOFTWARE IS NOT SUBJECT TO
COPYRIGHT PROTECTION AND IS IN THE PUBLIC DOMAIN. EXCEPT AS CONTAINED IN
THIS NOTICE, THE NAME OF THE AUTHORS, THE NATIONAL HEART, LUNG, AND BLOOD
INSTITUTE (NHLBI), OR THE NATIONAL INSTITUTES OF HEALTH (NIH) MAY NOT
BE USED TO ENDORSE OR PROMOTE PRODUCTS DERIVED FROM THIS SOFTWARE WITHOUT
SPECIFIC PRIOR WRITTEN PERMISSION FROM THE NHLBI OR THE NIH.THE SOFTWARE IS
PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef GADGETRON_CLIENT
#define GADGETRON_CLIENT

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <chrono>
#include <condition_variable>
#include <exception>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <map>
#include <memory>
#include <thread>

#include <boost/asio.hpp>
#include <boost/thread/thread.hpp>

#include <ismrmrd/dataset.h>
#include <ismrmrd/ismrmrd.h>
#include <ismrmrd/meta.h>

#include "sirf/Gadgetron/cgadgetron_shared_ptr.h"
#include "sirf/Gadgetron/gadgetron_data_containers.h"

enum GadgetronMessageID {
    GADGET_MESSAGE_INT_ID_MIN = 0,
    GADGET_MESSAGE_CONFIG_FILE = 1,
    GADGET_MESSAGE_CONFIG_SCRIPT = 2,
    GADGET_MESSAGE_PARAMETER_SCRIPT = 3,
    GADGET_MESSAGE_CLOSE = 4,
    GADGET_MESSAGE_TEXT = 5,
    GADGET_MESSAGE_INT_ID_MAX = 999,
    GADGET_MESSAGE_EXT_ID_MIN = 1000,
    GADGET_MESSAGE_ISMRMRD_ACQUISITION = 1008,
    GADGET_MESSAGE_CLOUD_JOB = 1013,
    GADGET_MESSAGE_GADGETCLOUD_JOB = 1014,
    GADGET_MESSAGE_DICOM_WITHNAME = 1018,
    GADGET_MESSAGE_DEPENDENCY_QUERY = 1019,
    GADGET_MESSAGE_ISMRMRD_IMAGE = 1022,
    GADGET_MESSAGE_RECONDATA = 1023,
    GADGET_MESSAGE_EXT_ID_MAX = 4096
};

#define MAX_BLOBS_LOG_10    6

namespace sirf {

    struct GadgetMessageIdentifier {
        uint16_t id;
    };

    struct GadgetMessageConfigurationFile {
        char configuration_file[1024];
    };

    struct GadgetMessageScript {
        uint32_t script_length;
    };

    class GadgetronClientException : public std::exception {
    public:
        GadgetronClientException(std::string msg) : msg_(msg) {}
        virtual ~GadgetronClientException() throw() {}
        virtual const char* what() const throw()
        {
            return msg_.c_str();
        }
    protected:
        std::string msg_;
    };

    class GadgetronClientMessageReader {
    public:
        virtual ~GadgetronClientMessageReader() {}
        virtual void read(boost::asio::ip::tcp::socket* s) = 0;
    };

    class GadgetronClientAcquisitionMessageCollector :
        public GadgetronClientMessageReader {
    public:
        GadgetronClientAcquisitionMessageCollector
            (gadgetron::shared_ptr<MRAcquisitionData> ptr_acqs) : ptr_acqs_(ptr_acqs) {}
        virtual ~GadgetronClientAcquisitionMessageCollector() {}

        virtual void read(boost::asio::ip::tcp::socket* stream);

    private:
        gadgetron::shared_ptr<MRAcquisitionData> ptr_acqs_;
    };

    class GadgetronClientImageMessageCollector :
        public GadgetronClientMessageReader {
    public:
        GadgetronClientImageMessageCollector
            (gadgetron::shared_ptr<GadgetronImageData> ptr_images) : ptr_images_(ptr_images) {}
        virtual ~GadgetronClientImageMessageCollector() {}

        template <typename T>
        void read_data_attributes
            (ISMRMRD::Image<T>* ptr, const ISMRMRD::ImageHeader& h, void** ptr_ptr,
            boost::asio::ip::tcp::socket* stream)
        {
            ISMRMRD::Image < T >* ptr_im = new ISMRMRD::Image < T > ;
            *ptr_ptr = (void*)ptr_im;
            ISMRMRD::Image<T>& im = *ptr_im;
            im.setHead(h);
            //im.setImageType(ISMRMRD::ISMRMRD_IMTYPE_MAGNITUDE);

            //Read meta attributes
            typedef unsigned long long size_t_type;
            size_t_type meta_attrib_length;
            boost::asio::read
                (*stream, boost::asio::buffer(&meta_attrib_length, sizeof(size_t_type)));
            if (meta_attrib_length > 0) {
                std::string meta_attrib(meta_attrib_length, 0);
                boost::asio::read(*stream, boost::asio::buffer(const_cast < char* >
                    (meta_attrib.c_str()), meta_attrib_length));
                im.setAttributeString(meta_attrib);
            }
            //Read image data
            boost::asio::read
                (*stream, boost::asio::buffer(im.getDataPtr(), im.getDataSize()));
        }

        virtual void read(boost::asio::ip::tcp::socket* stream);

    private:
        gadgetron::shared_ptr<GadgetronImageData> ptr_images_;
    };

    class GadgetronClientBlobMessageReader
        : public GadgetronClientMessageReader {
    public:
        GadgetronClientBlobMessageReader(std::string fileprefix, std::string filesuffix)
            : number_of_calls_(0)
            , file_prefix(fileprefix)
            , file_suffix(filesuffix)
        {
        }

        virtual ~GadgetronClientBlobMessageReader() {}

        virtual void read(boost::asio::ip::tcp::socket* socket)
        {
            // MUST READ 32-bits
            uint32_t nbytes;
            boost::asio::read(*socket, boost::asio::buffer(&nbytes, sizeof(uint32_t)));

            std::vector<char> data(nbytes, 0);
            boost::asio::read(*socket, boost::asio::buffer(&data[0], nbytes));

            unsigned long long fileNameLen;
            boost::asio::read(*socket, boost::asio::buffer(&fileNameLen, sizeof(unsigned long long)));

            std::string filenameBuf(fileNameLen, 0);
            boost::asio::read(*socket, boost::asio::buffer(const_cast<char*>
                (filenameBuf.c_str()), fileNameLen));

            typedef unsigned long long size_t_type;

            size_t_type meta_attrib_length;
            boost::asio::read(*socket, boost::asio::buffer(&meta_attrib_length, sizeof(size_t_type)));

            std::string meta_attrib;
            if (meta_attrib_length > 0) {
                std::string meta_attrib_socket(meta_attrib_length, 0);
                boost::asio::read(*socket, boost::asio::buffer(const_cast<char*>(meta_attrib_socket.c_str()), meta_attrib_length));
                meta_attrib = meta_attrib_socket;
            }

            std::stringstream filename;
            std::string filename_attrib;

            // Create the filename: (prefix_%06.suffix)
            filename << file_prefix << "_";
            filename << std::setfill('0') << std::setw(MAX_BLOBS_LOG_10) << number_of_calls_;
            filename_attrib = filename.str();
            filename << "." << file_suffix;
            filename_attrib.append("_attrib.xml");

            std::cout << "Writing image " << filename.str() << std::endl;

            std::ofstream outfile;
            outfile.open(filename.str().c_str(), std::ios::out | std::ios::binary);

            std::ofstream outfile_attrib;
            if (meta_attrib_length > 0) {
                outfile_attrib.open(filename_attrib.c_str(), std::ios::out | std::ios::binary);
            }

            if (outfile.good()) {
                /* write 'size' bytes starting at 'data's pointer */
                outfile.write(&data[0], nbytes);
                outfile.close();
                if (meta_attrib_length > 0) {
                    outfile_attrib.write(meta_attrib.c_str(), meta_attrib.length());
                    outfile_attrib.close();
                }
                number_of_calls_++;
            }
            else {
                throw GadgetronClientException("Unable to write blob to output file\n");
            }
        }

    protected:
        size_t number_of_calls_;
        std::string file_prefix;
        std::string file_suffix;
    };

    class GadgetronClientConnector {
    public:
        GadgetronClientConnector() : socket_(0), timeout_ms_(2000)
        {}
        virtual ~GadgetronClientConnector()
        {
            if (socket_) {
                socket_->close();
                delete socket_;
            }
        }

        void set_timeout(unsigned int t)
        {
            timeout_ms_ = t;
        }

        void read_task();

        void wait()
        {
            reader_thread_.join();
        }

        void connect(std::string hostname, std::string port);

        void send_gadgetron_close();

        void send_gadgetron_configuration_file(std::string config_xml_name);

        void send_gadgetron_configuration_script(std::string xml_string);

        void  send_gadgetron_parameters(std::string xml_string);

        void send_ismrmrd_acquisition(ISMRMRD::Acquisition& acq);

        template<typename T>
        void send_ismrmrd_image(ISMRMRD::Image<T>* ptr_im)
        {
            ISMRMRD::Image<T>& im = *ptr_im;
            if (!socket_)
                throw GadgetronClientException("Invalid socket.");

            GadgetMessageIdentifier id;
            id.id = GADGET_MESSAGE_ISMRMRD_IMAGE;

            boost::asio::write
                (*socket_, boost::asio::buffer(&id, sizeof(GadgetMessageIdentifier)));
            boost::asio::write
                (*socket_,
                boost::asio::buffer(&im.getHead(), sizeof(ISMRMRD::ImageHeader)));

            size_t meta_attrib_length = im.getAttributeStringLength();
            std::string meta_attrib(meta_attrib_length + 1, 0);
            im.getAttributeString(meta_attrib);

            boost::asio::write
                (*socket_, boost::asio::buffer(&meta_attrib_length, sizeof(size_t)));
            boost::asio::write
                (*socket_, boost::asio::buffer(meta_attrib.c_str(), meta_attrib_length));

            boost::asio::write
                (*socket_, boost::asio::buffer(im.getDataPtr(), im.getDataSize()));
        }

        void send_wrapped_image(const ImageWrap& iw)
        {
            IMAGE_PROCESSING_SWITCH(iw.type(), send_ismrmrd_image, iw.ptr_image());
        }

        void register_reader
            (unsigned short slot, gadgetron::shared_ptr<GadgetronClientMessageReader> r)
        {
            readers_[slot] = r;
        }

    protected:
        typedef
            std::map < unsigned short, gadgetron::shared_ptr<GadgetronClientMessageReader> >
            maptype;

        GadgetronClientMessageReader* find_reader(unsigned short r);

        boost::asio::io_service io_service;
        boost::asio::ip::tcp::socket* socket_;
        boost::thread reader_thread_;
        maptype readers_;
        unsigned int timeout_ms_;
    };

}

#endif