3d/vfregularizerkernel.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 
22 #ifndef mia_3d_vfregularizerkernel_hh
23 #define mia_3d_vfregularizerkernel_hh
24 
25 #include <mia/core/factory.hh>
26 #include <mia/3d/vectorfield.hh>
27 
29 
42 public:
45 
46  class CBuffers {
47  public:
48  virtual ~CBuffers();
49  };
50 
51  typedef std::unique_ptr<CBuffers> PBuffers;
52 
53  static const char *type_descr;
54 
55  typedef std::shared_ptr< C3DFVectorfieldRegularizerKernel > Pointer;
56 
57  C3DFVectorfieldRegularizerKernel(bool has_pertuberation);
58 
59  float evaluate_pertuberation_row(unsigned y, unsigned z, CBuffers& buffers) const;
60 
62 
63  void set_data_fields(C3DFVectorfield *output, const C3DFVectorfield *input);
64 
65  void set_update_fields(const T3DDatafield<unsigned char> *update_flags,
67  float residual_thresh);
68 
69  float evaluate_row(unsigned y, unsigned z, CBuffers& buffers);
70 
71  float evaluate_row_sparse(unsigned y, unsigned z, CBuffers& buffers);
72 
73  unsigned get_boundary_padding() const;
74 
75  PBuffers get_buffers() const;
76 
77  void start_slice(unsigned z, CBuffers& buffers) const;
78 
79  bool has_pertuberation() const;
80  protected:
81  C3DFVectorfield& get_output_field() const;
82  const C3DFVectorfield& get_input_field() const;
83  T3DDatafield<float>& get_residua() const;
84  const T3DDatafield<unsigned char>& get_update_flags() const;
85  T3DDatafield<unsigned char>& get_set_flags() const;
86  float get_residual_thresh() const;
87  private:
88  virtual void post_set_data_fields();
89 
90  virtual float do_evaluate_row(unsigned y, unsigned z, CBuffers& buffers) = 0;
91 
92  virtual float do_evaluate_row_sparse(unsigned y, unsigned z, CBuffers& buffers) = 0;
93 
94  virtual unsigned do_get_boundary_padding() const = 0;
95 
96  virtual PBuffers do_get_buffers() const;
97 
98  virtual void do_start_slice(unsigned z, CBuffers& buffers) const;
99 
100  virtual float do_evaluate_pertuberation_row(unsigned y, unsigned z, CBuffers& buffers) const;
101 
102  C3DFVectorfield *m_output;
103  const C3DFVectorfield *m_input;
104  T3DDatafield<float> *m_residua;
105  const T3DDatafield<unsigned char> *m_update_flags;
106  T3DDatafield<unsigned char> *m_set_flags;
107  float m_residual_thresh;
108  bool m_has_pertuberation;
109 };
110 
111 inline
113 {
114  return m_has_pertuberation;
115 }
116 
117 inline
119 {
120  return *m_output;
121 }
122 
123 inline
125 {
126  return *m_input;
127 }
128 
129 inline
131 {
132  return *m_residua;
133 }
134 
135 inline
137 {
138  return *m_update_flags;
139 }
140 
141 inline
143 {
144  return *m_set_flags;
145 }
146 
147 inline
149 {
150  return m_residual_thresh;
151 }
152 
154 
156 
158 
159 
164 
172 
173 
174 
176 #endif
the singleton that a plug-in handler really is
Definition: handler.hh:157
T3DDatafield< unsigned char > & get_set_flags() const
THandlerSingleton< TFactoryPluginHandler< C3DFVectorfieldRegularizerKernelPlugin > > C3DFVectorfieldRegularizerKernelPluginHandler
a 3D field of floating point single accuracy 3D vectors
std::shared_ptr< C3DFVectorfieldRegularizerKernel > Pointer
#define NS_MIA_BEGIN
conveniance define to start the mia namespace
Definition: defines.hh:33
C3DFVectorfield & get_output_field() const
#define EXPORT_3D
Definition: defines3d.hh:44
#define FACTORY_TRAIT(F)
This is tha base of all plugins that create "things", like filters, cost functions time step operator...
Definition: factory.hh:49
const T3DDatafield< unsigned char > & get_update_flags() const
TFactory< C3DFVectorfieldRegularizerKernel > C3DFVectorfieldRegularizerKernelPlugin
const C3DFVectorfield & get_input_field() const
std::unique_ptr< CBuffers > PBuffers
The base class for all plug-in created object.
Definition: product_base.hh:40
the Base class for all plugn handlers that deal with factory plugins.
Definition: factory.hh:93
T3DDatafield< float > & get_residua() const
C3DFVectorfieldRegularizerKernel::Pointer P3DVectorfieldRegularizerKernel
C3DFVectorfieldRegularizerKernel plugin_type
The basic template of all plugin handlers.
Definition: handler.hh:56
#define NS_MIA_END
conveniance define to end the mia namespace
Definition: defines.hh:36