My Project
core/cost.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_core_cost_hh
22 #define mia_core_cost_hh
23 
24 #include <mia/core/factory.hh>
25 #include <mia/core/refholder.hh>
26 
27 
28 #ifndef EXPORT_HANDLER
29 # ifdef WIN32
30 # define EXPORT_HANDLER __declspec(dllimport)
31 # else
32 # define EXPORT_HANDLER
33 # endif
34 #endif
35 
37 
41  static const char *type_descr;
42 };
43 
44 
63 template <typename T, typename V>
65 {
66 public:
68  typedef T Data;
69 
71  typedef V Force;
72 
75 
77  typedef typename RData::Pointer PData;
78 
80  typedef T plugin_data;
81 
84 
86  virtual ~TCost();
87 
94  double value(const T& src) const;
95 
96 
105  double evaluate_force(const T& src, V& force) const;
106 
112  void set_reference(const T& ref);
113 private:
114  virtual double do_value(const T& a, const T& b) const = 0;
115  virtual double do_evaluate_force(const T& a, const T& b, V& force) const = 0;
116  virtual void post_set_reference(const T& ref);
117 
118  PData m_reference;
119 };
120 
122 #endif
The base class for all plug-in created object.
Definition: product_base.hh:41
The generic cost function interface.
Definition: core/cost.hh:65
V Force
typedef for generic programming: The gradient forca type create by the cost function
Definition: core/cost.hh:71
void set_reference(const T &ref)
cost_type plugin_type
plugin searchpath helper type
Definition: core/cost.hh:83
double value(const T &src) const
TRefHolder< T > RData
Const reference holder TRefHolder of the cost function data.
Definition: core/cost.hh:74
virtual ~TCost()
ensure virtual destruction, since we have virtual functions
RData::Pointer PData
Pointer to const reference holder TRefHolder of the cost function data.
Definition: core/cost.hh:77
double evaluate_force(const T &src, V &force) const
T plugin_data
plugin searchpath helper type
Definition: core/cost.hh:80
T Data
typedef for generic programming: The data type used by the cost function
Definition: core/cost.hh:68
A class to make a const reference not so const.
Definition: refholder.hh:40
std::shared_ptr< TRefHolder< T > > Pointer
pointer type of this reference holder.
Definition: refholder.hh:43
#define EXPORT_HANDLER
Definition: core/cost.hh:32
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition: defines.hh:33
#define EXPORT_CORE
Macro to manage Visual C++ style dllimport/dllexport.
Definition: defines.hh:101
#define NS_MIA_END
conveniance define to end the mia namespace
Definition: defines.hh:36
plugin helper type
Definition: core/cost.hh:39
static const char * type_descr
plugin path helper variable
Definition: core/cost.hh:41