Registration.h

Go to the documentation of this file.

/*
SyneRBI Synergistic Image Reconstruction Framework (SIRF)
Copyright 2017 - 2020 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.

*/

#pragma once

#include <string>
#include <vector>
#include <memory>

namespace sirf {

template<class dataType> class Transformation;
class ImageData;

template<class dataType>
class Registration
{
public:

    Registration() {}

    virtual ~Registration() {}

    void set_reference_image(const std::shared_ptr<const ImageData> reference_image_sptr);

    void set_floating_image(const std::shared_ptr<const ImageData> floating_image_sptr);

    void add_floating_image(const std::shared_ptr<const ImageData> floating_image_sptr);

    void set_reference_image_filename(const std::string &filename);

    void set_floating_image_filename(const std::string &filename);

    void add_floating_image_filename(const std::string &filename);

    void clear_floating_images();

    virtual void process() = 0;

    virtual const std::shared_ptr<const ImageData> get_output_sptr(const unsigned idx = 0) const { return _warped_images.at(idx); }

    virtual const std::shared_ptr<const Transformation<dataType> > get_deformation_field_forward_sptr(const unsigned idx = 0) const { return _def_fwd_images.at(idx); }

    virtual const std::shared_ptr<const Transformation<dataType> > get_deformation_field_inverse_sptr(const unsigned idx = 0) const = 0;

    virtual const std::shared_ptr<const Transformation<dataType> > get_displacement_field_forward_sptr(const unsigned idx = 0) const = 0;

    virtual const std::shared_ptr<const Transformation<dataType> > get_displacement_field_inverse_sptr(const unsigned idx = 0) const = 0;

protected:

    virtual void check_parameters() const;

    std::shared_ptr<const ImageData> _reference_image_sptr;
    std::vector<std::shared_ptr<const ImageData> > _floating_images;
    std::vector<std::shared_ptr<ImageData> > _warped_images;

    std::vector<std::shared_ptr<Transformation<dataType> > > _def_fwd_images;

    std::string _reference_image_filename = "";
    std::vector<std::string> _floating_image_filenames;
};
}