3d/splinetransformpenalty.hh

Go to the documentation of this file.

/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis
 * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
 *
 * MIA is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MIA; if not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef mia_3d_splinetransformpenalty_hh
#define mia_3d_splinetransformpenalty_hh
 
#include <mia/3d/interpolator.hh>
#include <mia/3d/datafield.hh>
#include <mia/core/vector.hh>
#include <mia/core/product_base.hh>
 
 
NS_MIA_BEGIN

 
class EXPORT_3D C3DSplineTransformPenalty : public CProductBase
{
 
public:
       typedef C3DSplineTransformPenalty plugin_data;
       static const char *data_descr;
       typedef C3DSplineTransformPenalty plugin_type;
       static const char *type_descr;

       C3DSplineTransformPenalty(double weight, bool normalize);
 
       C3DSplineTransformPenalty(const C3DSplineTransformPenalty& org) = delete;
       C3DSplineTransformPenalty& operator = (const C3DSplineTransformPenalty& org) = delete;

       C3DSplineTransformPenalty *clone() const __attribute__((warn_unused_result));
 
       virtual ~C3DSplineTransformPenalty();

       void initialize(const C3DBounds& size, const C3DFVector& range, PSplineKernel kernel);

       double value(const C3DFVectorfield&  coefficients) const;

 
       double value_and_gradient(const C3DFVectorfield&  coefficients, CDoubleVector& gradient) const;
 
protected:
 
 
 
       const C3DBounds& get_size() const;
 
       const C3DFVector& get_range() const;
 
       PSplineKernel get_kernel() const;
 
       double get_weight() const;
 
       bool get_normalize() const;
 
private:
 
       virtual void do_initialize() = 0;
 
       virtual double do_value(const C3DFVectorfield&  coefficients) const = 0;
 
       virtual double do_value_and_gradient(const C3DFVectorfield&  coefficients, CDoubleVector& gradient) const = 0;
 
       virtual C3DSplineTransformPenalty *do_clone() const  = 0;
 
       double m_weight;
       bool m_normalize;
 
       C3DBounds m_size;
       C3DFVector m_range;
       PSplineKernel m_kernel;
};
 
typedef std::shared_ptr<C3DSplineTransformPenalty> P3DSplineTransformPenalty;
 
 
class EXPORT_3D C3DSplineTransformPenaltyPlugin: public TFactory<C3DSplineTransformPenalty>
{
public:
       C3DSplineTransformPenaltyPlugin(char const *const  name);
private:
       virtual Product *do_create() const __attribute__((warn_unused_result));
       virtual Product *do_create(float weight, bool normalize) const __attribute__((warn_unused_result)) = 0 ;
 
       float m_weight;
       bool m_normalize;
};
 

typedef THandlerSingleton<TFactoryPluginHandler<C3DSplineTransformPenaltyPlugin>>
              C3DSplineTransformPenaltyPluginHandler;
 
 
FACTORY_TRAIT(C3DSplineTransformPenaltyPluginHandler);
 
 
EXPORT_3D  C3DSplineTransformPenaltyPluginHandler::ProductPtr produce_3d_spline_transform_penalty(const std::string& descr);
 
 
class EXPORT_3D C3DSplineTransformPenaltyPluginHandlerTest
{
public:
       C3DSplineTransformPenaltyPluginHandlerTest();
};
 
NS_MIA_END
 
#endif