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