gadget_lib.h

Go to the documentation of this file.

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

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.

*/

#ifndef GADGETS_LIBRARY
#define GADGETS_LIBRARY

#include <map>
//#include <boost/algorithm/string.hpp>

#include "sirf/common/iequals.h"

namespace sirf {

    class aGadget {
    public:
        virtual void set_property(const char* prop, const char* value) = 0;
        virtual std::string value_of(const char* prop) = 0;
        virtual std::string vxml(const std::string& label) const = 0;
        std::string xml(const std::string& label = "") const
        {
            return vxml(label);
        }
    };

    class Gadget : public aGadget {
    public:
        Gadget(std::string name, std::string dll, std::string cl) :
            gadget_(name), dll_(dll)
        {
            class_ = cl;
            //add_property("pass_on_undesired_data", "true");
        }
        virtual void set_property(const char* prop, const char* value)
        {
            par_[prop] = value;
        }
        virtual std::string value_of(const char* prop)
        {
            return par_[prop];
        }
        void add_property(const char* prop, const char* value)
        {
            par_[prop] = value;
        }
        virtual std::string vxml(const std::string& label) const
        {
            std::string xml_script("<gadget>\n");
            if (label.size() > 1)
                xml_script += " <name>" + label + ':' + gadget_ + "</name>\n";
            else
                xml_script += " <name>" + gadget_ + "</name>\n";
            xml_script += " <dll>" + dll_ + "</dll>\n";
            xml_script += " <classname>" + class_ + "</classname>\n";
#if defined(_MSC_VER) && _MSC_VER < 1900
            std::map<std::string, std::string>::const_iterator it;
#else
            typename std::map<std::string, std::string>::const_iterator it;
#endif
            for (it = par_.begin(); it != par_.end(); ++it) {
                xml_script += " <property>\n";
                xml_script += "  <name>" + it->first + "</name>\n"; \
                    xml_script += "  <value>" + it->second + "</value>\n"; \
                    xml_script += " </property>\n";
            }
            xml_script += "</gadget>\n";
            return xml_script;
        }
    protected:
        std::string gadget_;
        std::string dll_;
        std::string class_;
        std::map<std::string, std::string> par_;
    };

    class IsmrmrdAcqMsgReader : public aGadget {
    public:
        static const char* class_name()
        {
            return "GadgetIsmrmrdAcquisitionMessageReader";
        }
        virtual void set_property(const char* prop, const char* value) {}
        virtual std::string value_of(const char* prop)
        {
            return std::string("");
        }
        virtual std::string vxml(const std::string& label) const {
            std::string xml_script("<reader>\n");
            xml_script += " <slot>1008</slot>\n";
            xml_script += " <dll>gadgetron_mricore</dll>\n";
            xml_script +=
                " <classname>GadgetIsmrmrdAcquisitionMessageReader</classname>\n";
            xml_script += "</reader>\n";
            return xml_script;
        }
    };

    class IsmrmrdAcqMsgWriter : public aGadget {
    public:
        static const char* class_name()
        {
            return "GadgetIsmrmrdAcquisitionMessageWriter";
        }
        virtual void set_property(const char* prop, const char* value) {}
        virtual std::string value_of(const char* prop)
        {
            return std::string("");
        }
        virtual std::string vxml(const std::string& label) const {
            std::string xml_script("<writer>\n");
            xml_script += " <slot>1008</slot>\n";
            xml_script += " <dll>gadgetron_mricore</dll>\n";
            xml_script +=
                " <classname>GadgetIsmrmrdAcquisitionMessageWriter</classname>\n";
            xml_script += "</writer>\n";
            return xml_script;
        }
    };

    class IsmrmrdImgMsgReader : public aGadget {
    public:
        static const char* class_name()
        {
            return "MRIImageReader";
        }
        virtual void set_property(const char* prop, const char* value) {}
        virtual std::string value_of(const char* prop)
        {
            return std::string("");
        }
        virtual std::string vxml(const std::string& label) const {
            std::string xml_script("<reader>\n");
            xml_script += " <slot>1022</slot>\n";
            xml_script += " <dll>gadgetron_mricore</dll>\n";
            xml_script +=
                " <classname>MRIImageReader</classname>\n";
            xml_script += "</reader>\n";
            return xml_script;
        }
    };

    class ImageMessageWriter : public aGadget {

    };
    //class IsmrmrdImgMsgWriter : public aGadget {
    class IsmrmrdImgMsgWriter : public ImageMessageWriter {
    public:
        static const char* class_name()
        {
            return "MRIImageWriter";
        }
        virtual void set_property(const char* prop, const char* value) {}
        virtual std::string value_of(const char* prop)
        {
            return std::string("");
        }
        virtual std::string vxml(const std::string& label) const {
            std::string xml_script("<writer>\n");
            xml_script += " <slot>1022</slot>\n";
            xml_script += " <dll>gadgetron_mricore</dll>\n";
            xml_script += " <classname>MRIImageWriter</classname>\n";
            xml_script += "</writer>\n";
            return xml_script;
        }
    };

    class DicomImageMessageWriter : public ImageMessageWriter {
    public:
        static const char* class_name()
        {
            return "DicomImageWriter";
        }
        virtual void set_property(const char* prop, const char* value) {}
        virtual std::string value_of(const char* prop)
        {
            return std::string("");
        }
        virtual std::string vxml(const std::string& label) const {
            std::string xml_script("<writer>\n");
            xml_script += " <slot>1018</slot>\n";
            xml_script += " <dll>gadgetron_dicom</dll>\n";
            xml_script += " <classname>DicomImageWriter</classname>\n";
            xml_script += "</writer>\n";
            return xml_script;
        }
    };

    class NoiseAdjustGadget : public Gadget {
    public:
        NoiseAdjustGadget() :
            Gadget("NoiseAdjust", "gadgetron_mricore", "NoiseAdjustGadget")
        {}
        static const char* class_name()
        {
            return "NoiseAdjustGadget";
        }
    };

    class PCACoilGadget : public Gadget {
    public:
        PCACoilGadget() :
            Gadget("PCACoil", "gadgetron_mricore", "PCACoilGadget")
        {}
        static const char* class_name()
        {
            return "PCACoilGadget";
        }
    };

    class CoilReductionGadget : public Gadget {
    public:
        CoilReductionGadget() :
            Gadget("CoilReduction", "gadgetron_mricore", "CoilReductionGadget")
        {
            add_property("coil_mask", "");
            add_property("coils_out", "128");
        }
        static const char* class_name()
        {
            return "CoilReductionGadget";
        }
    };

    class AsymmetricEchoAdjustROGadget : public Gadget {
    public:
        AsymmetricEchoAdjustROGadget() :
            Gadget("AsymmetricEcho", "gadgetron_mricore",
            "AsymmetricEchoAdjustROGadget")
        {}
        static const char* class_name()
        {
            return "AsymmetricEchoAdjustROGadget";
        }
    };

    class RemoveROOversamplingGadget : public Gadget {
    public:
        RemoveROOversamplingGadget() :
            Gadget("RemoveROOversampling", "gadgetron_mricore",
            "RemoveROOversamplingGadget")
        {}
        static const char* class_name()
        {
            return "RemoveROOversamplingGadget";
        }
    };

    class AcquisitionAccumulateTriggerGadget : public Gadget {
    public:
        AcquisitionAccumulateTriggerGadget() :
            Gadget("AccTrig", "gadgetron_mricore", "AcquisitionAccumulateTriggerGadget")
        {
            add_property("trigger_dimension", "repetition");
            add_property("sorting_dimension", "slice");
        }
        static const char* class_name()
        {
            return "AcquisitionAccumulateTriggerGadget";
        }
    };

    class BucketToBufferGadget : public Gadget {
    public:
        BucketToBufferGadget() :
            Gadget("Buff", "gadgetron_mricore", "BucketToBufferGadget")
        {
            add_property("N_dimension", "");
            add_property("S_dimension", "");
            add_property("split_slices", "true");
            add_property("ignore_segment", "true");
            add_property("verbose", "true");
        }
        static const char* class_name()
        {
            return "BucketToBufferGadget";
        }
    };

    class GenericReconCartesianReferencePrepGadget : public Gadget {
    public:
        GenericReconCartesianReferencePrepGadget() :
            Gadget("PrepRef", "gadgetron_mricore",
            "GenericReconCartesianReferencePrepGadget")
        {
            add_property("debug_folder", "");
            add_property("perform_timing", "true");
            add_property("verbose", "true");
            add_property("average_all_ref_N", "true");
            add_property("average_all_ref_S", "true");
            add_property("prepare_ref_always", "true");
        }
        static const char* class_name()
        {
            return "GenericReconCartesianReferencePrepGadget";
        }
    };

    class SimpleReconGadget : public Gadget {
    public:
        SimpleReconGadget() :
            Gadget("SimpleRecon", "gadgetron_mricore", "SimpleReconGadget")
        {}
        static const char* class_name()
        {
            return "SimpleReconGadget";
        }
    };

    class GenericReconCartesianFFTGadget : public Gadget {
    public:
        GenericReconCartesianFFTGadget() :
            Gadget("Recon", "gadgetron_mricore", "GenericReconCartesianFFTGadget")
        {
            add_property("image_series","0");
            add_property("coil_map_algorithm","Inati");
            add_property("debug_folder","");
            add_property("perform_timing","true");
            add_property("verbose","true");
        }
        static const char* class_name()
        {
            return "GenericReconCartesianFFTGadget";
        }
    };

    class GenericReconCartesianGrappaGadget : public Gadget {
    public:
        GenericReconCartesianGrappaGadget() :
            Gadget("CartesianGrappa", "gadgetron_mricore",
            "GenericReconCartesianGrappaGadget")
        {
            add_property("image_series", "0");
            add_property("coil_map_algorithm", "Inati");
            add_property("downstream_coil_compression", "true");
            add_property("downstream_coil_compression_thres", "0.01");
            add_property("downstream_coil_compression_num_modesKept", "0");
            add_property("send_out_gfactor", "true");
            add_property("debug_folder", "");
            add_property("perform_timing", "true");
            add_property("verbose", "true");
        }
        static const char* class_name()
        {
            return "GenericReconCartesianGrappaGadget";
        }
    };

    class GenericReconFieldOfViewAdjustmentGadget : public Gadget {
    public:
        GenericReconFieldOfViewAdjustmentGadget() :
            Gadget("FOVAdjustment", "gadgetron_mricore",
            "GenericReconFieldOfViewAdjustmentGadget")
        {
            add_property("debug_folder", "");
            add_property("perform_timing", "false");
            add_property("verbose", "false");
        }
        static const char* class_name()
        {
            return "GenericReconFieldOfViewAdjustmentGadget";
        }
    };

    class GenericReconImageArrayScalingGadget : public Gadget {
    public:
        GenericReconImageArrayScalingGadget() :
            Gadget("Scaling", "gadgetron_mricore",
            "GenericReconImageArrayScalingGadget")
        {
            add_property("perform_timing", "false");
            add_property("verbose", "false");
            add_property("min_intensity_value", "64");
            add_property("max_intensity_value", "4095");
            add_property("scalingFactor", "10.0");
            add_property("use_constant_scalingFactor", "true");
            add_property("scalingFactor_dedicated", "100.0");
            add_property("auto_scaling_only_once", "true");
        }
        static const char* class_name()
        {
            return "GenericReconImageArrayScalingGadget";
        }
    };

    class FatWaterGadget : public Gadget {
    public:
        FatWaterGadget() :
            Gadget("FatWater", "gadgetron_fatwater", "FatWaterGadget")
        {}
        static const char* class_name()
        {
            return "FatWaterGadget";        
        }
    };

    class ImageArraySplitGadget : public Gadget {
    public:
        ImageArraySplitGadget() :
            Gadget("ImageArraySplit", "gadgetron_mricore", "ImageArraySplitGadget")
        {}
        static const char* class_name()
        {
            return "ImageArraySplitGadget";
        }
    };

    class PhysioInterpolationGadget : public Gadget {
    public:
        PhysioInterpolationGadget() :
            Gadget("PhysioInterpolation", "gadgetron_mricore", "PhysioInterpolationGadget")
        {
            add_property("phases", "30");
            add_property("mode", "0");
            add_property("first_beat_on_trigger", "true");
            add_property("interp_method", "BSpline");
        }
        static const char* class_name()
        {
            return "PhysioInterpolationGadget";
        }
    };

    class GPURadialPrepGadget : public Gadget {
    public:
        GPURadialPrepGadget(std::string name, std::string dll, std::string cl) :
            Gadget(name, dll, cl)
        {
            add_property("mode", "0");
            add_property("deviceno", "0");
            add_property("profiles_per_frame", "0");
            add_property("rotations_per_reconstruction", "0");
            add_property("frames_per_rotation", "0");
            add_property("buffer_frames_per_rotation", "0");
            add_property("buffer_length_in_rotations", "1");
            add_property("buffer_using_solver", "false");
            add_property("buffer_convolution_kernel_width", "5.5");
            add_property("buffer_convolution_oversampling_factor", "1.25");
            add_property("reconstruction_os_factor_x", "1.0");
            add_property("reconstruction_os_factor_y", "1.0");
            add_property("output_timing", "false");
        }
/*
        static const char* class_name()
        {
            return "GPUSenseGadget";
        }
*/
    };

    class GPURadialSensePrepGadget : public GPURadialPrepGadget {
    public:
        GPURadialSensePrepGadget() :
            GPURadialPrepGadget("gpuRadialSensePrepGadget", "gadgetron_gpuradial", "gpuRadialSensePrepGadget")
        {}
        static const char* class_name()
        {
            return "GPURadialSensePrepGadget";
        }
    };

    class GPUSenseGadget : public Gadget {
    public:
        GPUSenseGadget(std::string name, std::string dll, std::string cl) :
            Gadget(name, dll, cl)
        {
            add_property("deviceno", "0");
            add_property("setno", "0");
            add_property("sliceno", "0");
            add_property("oversampling_factor", "1.5");
            add_property("kernel_width", "5.5");
            add_property("save_individual_frames", "true");
            add_property("output_convergence", "false");
            add_property("rotations_to_discard", "0");
            add_property("output_timing", "false");
        }
/*
        static const char* class_name()
        {
            return "GPUSenseGadget";
        }
*/
    };

    class GPUCGSenseGadget : public GPUSenseGadget {
    public:
        GPUCGSenseGadget() : 
            GPUSenseGadget("gpuCgSenseGadget", "gadgetron_gpuparallelmri", "gpuCgSenseGadget")
        {
            add_property("kappa", "0.3");
            add_property("number_of_iterations", "5");
            add_property("cg_limit", "1e-6");
        }
        static const char* class_name()
        {
            return "GPUCGSenseGadget";
        }
    };

    class ExtractGadget : public Gadget {
    public:
        ExtractGadget() :
            Gadget("Extract", "gadgetron_mricore", "ExtractGadget")
        {
            add_property("extract_mask", "0");
            add_property("extract_magnitude", "true");
            add_property("extract_real", "false");
            add_property("extract_imag", "false");
            add_property("extract_phase", "false");
        }
        static const char* class_name()
        {
            return "ExtractGadget";
        }
    };

    class AutoScaleGadget : public Gadget {
    public:
        AutoScaleGadget() :
            Gadget("AutoScale", "gadgetron_mricore", "AutoScaleGadget")
        {}
        static const char* class_name()
        {
            return "AutoScaleGadget";
        }
    };

    class ComplexToFloatGadget : public Gadget {
    public:
        ComplexToFloatGadget() :
            Gadget("ComplexToFloatAttrib", "gadgetron_mricore", "ComplexToFloatGadget")
        {}
        static const char* class_name()
        {
            return "ComplexToFloatGadget";
        }
    };

    class FloatToFixPointGadget : public Gadget {
    public:
        FloatToFixPointGadget(std::string name, // = "FloatToFixPoint", 
            std::string dll, // = "gadgetron_mricore", 
            std::string cl, // = "FloatToFixPointGadget",
            std::string max_int) : // = "32767") :
                Gadget(name, dll, cl)
        {
            add_property("min_intensity", "0");
            add_property("max_intensity", max_int.c_str());
            add_property("intensity_offset", "0");
        }
/*
        static const char* class_name()
        {
            return "FloatToFixPointGadget";
        }
*/
    };

    class FloatToUShortGadget : public FloatToFixPointGadget {
    public:
        FloatToUShortGadget() :
            FloatToFixPointGadget("FloatToShort", "gadgetron_mricore", "FloatToUShortGadget", "65535")
        {}
        static const char* class_name()
        {
            return "FloatToUShortGadget";
        }
    };

    class FloatToShortGadget : public FloatToFixPointGadget {
    public:
        FloatToShortGadget() :
            FloatToFixPointGadget("FloatToShortAttrib", "gadgetron_mricore",
            "FloatToShortGadget", "32767")
        {}
        static const char* class_name()
        {
            return "FloatToShortGadget";
        }
    };
/*
    class FloatToShortGadget : public Gadget {
    public:
        FloatToShortGadget() :
            Gadget("FloatToShortAttrib", "gadgetron_mricore",
            "FloatToShortGadget")
        {
            add_property("min_intensity", "0");
            add_property("max_intensity", "32767");
            add_property("intensity_offset", "0");
        }
        static const char* class_name()
        {
            return "FloatToShortGadget";
        }
    };
*/
    class ImageFinishGadget : public Gadget {
    public:
        ImageFinishGadget() :
            Gadget("ImageFinish", "gadgetron_mricore", "ImageFinishGadget")
        {}
        static const char* class_name()
        {
            return "ImageFinishGadget";
        }
    };

    class DicomFinishGadget : public Gadget {
    public:
        DicomFinishGadget() :
            Gadget("DicomFinish", "gadgetron_dicom", "DicomFinishGadget")
        {}
        static const char* class_name()
        {
            return "DicomFinishGadget";
        }
    };

    class AcquisitionFinishGadget : public Gadget {
    public:
        AcquisitionFinishGadget() :
            Gadget("AcquisitionFinish", "gadgetron_mricore", "AcquisitionFinishGadget")
        {}
        static const char* class_name()
        {
            return "AcquisitionFinishGadget";
        }
    };

    class SimpleReconGadgetSet : public aGadget {
    public:
        static const char* class_name()
        {
            return "SimpleReconGadgetSet";
        }
        virtual void set_property(const char* prop, const char* value)
        {
            if (sirf::iequals(prop, "trigger_dimension") ||
                sirf::iequals(prop, "sorting_dimension"))
                aat_.set_property(prop, value);
            else if (sirf::iequals(prop, "n_dimension") ||
                sirf::iequals(prop, "s_dimension") ||
                sirf::iequals(prop, "split_slices"))
                bb_.set_property(prop, value);
            else
                THROW("unknown gadget parameter");
        }
        virtual std::string value_of(const char* prop)
        {
            if (sirf::iequals(prop, "trigger_dimension") ||
                sirf::iequals(prop, "sorting_dimension"))
                return aat_.value_of(prop);
            else if (sirf::iequals(prop, "n_dimension") ||
                sirf::iequals(prop, "s_dimension") ||
                sirf::iequals(prop, "split_slices"))
                return bb_.value_of(prop);
            THROW("unknown gadget parameter");
        }
        virtual std::string vxml(const std::string& label) const
        {
            std::string xml_script;
            xml_script += aat_.xml();
            xml_script += bb_.xml();
            xml_script += sr_.xml();
            xml_script += ias_.xml();
            return xml_script;
        }
    private:
        AcquisitionAccumulateTriggerGadget aat_;
        BucketToBufferGadget bb_;
        SimpleReconGadget sr_;
        ImageArraySplitGadget ias_;
    };

}

#endif