2d/splinetransformpenalty.hh
Go to the documentation of this file.
1 /* -*- mia-c++ -*-
2  *
3  * This file is part of MIA - a toolbox for medical image analysis
4  * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
5  *
6  * MIA is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with MIA; if not, see <http://www.gnu.org/licenses/>.
18  *
19  */
20 
21 #ifndef mia_2d_splinetransformpenalty_hh
22 #define mia_2d_splinetransformpenalty_hh
23 
24 #include <mia/2d/interpolator.hh>
25 #include <mia/2d/datafield.hh>
26 #include <mia/core/vector.hh>
27 #include <mia/core/product_base.hh>
28 
29 
31 
40 
41 public:
43  static const char *data_descr;
45  static const char *type_descr;
46 
52  C2DSplineTransformPenalty(double weight, bool normalize);
53 
55  C2DSplineTransformPenalty& operator = (const C2DSplineTransformPenalty& org) = delete;
56 
61  C2DSplineTransformPenalty *clone() const __attribute__((warn_unused_result));
62 
63  virtual ~C2DSplineTransformPenalty();
64 
71  void initialize(const C2DBounds& size, const C2DFVector& range, PSplineKernel kernel);
72 
78  double value(const C2DFVectorfield& coefficients) const;
79 
88  double value_and_gradient(const C2DFVectorfield& coefficients, CDoubleVector& gradient) const;
89 
90 protected:
91 
92  const C2DBounds& get_size() const;
93 
94  const C2DFVector& get_range() const;
95 
96  PSplineKernel get_kernel() const;
97 
98  double get_weight() const;
99 
100  bool get_normalize() const;
101 
102 private:
103 
104  virtual void do_initialize() = 0;
105 
106  virtual double do_value(const C2DFVectorfield& coefficients) const = 0;
107 
108  virtual double do_value_and_gradient(const C2DFVectorfield& coefficients, CDoubleVector& gradient) const = 0;
109 
110  virtual C2DSplineTransformPenalty *do_clone() const = 0;
111 
112  double m_weight;
113  bool m_normalize;
114 
115  C2DBounds m_size;
116  C2DFVector m_range;
117  PSplineKernel m_kernel;
118 };
119 
120 typedef std::shared_ptr<C2DSplineTransformPenalty> P2DSplineTransformPenalty;
121 
122 
123 class EXPORT_2D C2DSplineTransformPenaltyPlugin: public TFactory<C2DSplineTransformPenalty> {
124 public:
125  C2DSplineTransformPenaltyPlugin(char const * const name);
126 private:
127  virtual Product *do_create() const __attribute__((warn_unused_result));
128  virtual Product *do_create(float weight, bool normalize) const __attribute__((warn_unused_result)) = 0 ;
129 
130  float m_weight;
131  bool m_normalize;
132 };
133 
134 
138 
139 
141 
142 
143 EXPORT_2D C2DSplineTransformPenaltyPluginHandler::ProductPtr produce_2d_spline_transform_penalty(const std::string& descr);
144 
145 
147 public:
149 };
150 
152 
153 #endif
the singleton that a plug-in handler really is
Definition: handler.hh:157
A wrapper around the c-array to provide an STL like interface for iterators.
Definition: core/vector.hh:75
FACTORY_TRAIT(C2DSplineTransformPenaltyPluginHandler)
class EXPORT_CORE CMeans private
std::shared_ptr< Image > normalize(const Image &image)
a normalizer for image intensities
Definition: normalize.hh:131
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition: defines.hh:33
C2DSplineTransformPenalty plugin_type
THandlerSingleton< TFactoryPluginHandler< C2DSplineTransformPenaltyPlugin > > C2DSplineTransformPenaltyPluginHandler
Plugin handler for image combiner plugins.
std::shared_ptr< C2DSplineTransformPenalty > P2DSplineTransformPenalty
#define EXPORT_2D
Definition: defines2d.hh:37
a 2D field of floating point single accuracy 2D vectors
std::shared_ptr< CSplineKernel > PSplineKernel
This is tha base of all plugins that create "things", like filters, cost functions time step operator...
Definition: factory.hh:49
C2DSplineTransformPenalty plugin_data
The base class for all plug-in created object.
Definition: product_base.hh:40
Base class for transformation penalties in spline based deformations.
EXPORT_2D C2DSplineTransformPenaltyPluginHandler::ProductPtr produce_2d_spline_transform_penalty(const std::string &descr)
#define NS_MIA_END
conveniance define to end the mia namespace
Definition: defines.hh:36