Image Component Library (ICL)
WarpOp.h
Go to the documentation of this file.
1 /********************************************************************
2 ** Image Component Library (ICL) **
3 ** **
4 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld **
5 ** Neuroinformatics Group **
6 ** Website: www.iclcv.org and **
7 ** http://opensource.cit-ec.de/projects/icl **
8 ** **
9 ** File : ICLFilter/src/ICLFilter/WarpOp.h **
10 ** Module : ICLFilter **
11 ** Authors: Christof Elbrechter **
12 ** **
13 ** **
14 ** GNU LESSER GENERAL PUBLIC LICENSE **
15 ** This file may be used under the terms of the GNU Lesser General **
16 ** Public License version 3.0 as published by the **
17 ** **
18 ** Free Software Foundation and appearing in the file LICENSE.LGPL **
19 ** included in the packaging of this file. Please review the **
20 ** following information to ensure the license requirements will **
21 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt **
22 ** **
23 ** The development of this software was supported by the **
24 ** Excellence Cluster EXC 277 Cognitive Interaction Technology. **
25 ** The Excellence Cluster EXC 277 is a grant of the Deutsche **
26 ** Forschungsgemeinschaft (DFG) in the context of the German **
27 ** Excellence Initiative. **
28 ** **
29 ********************************************************************/
30 
31 #pragma once
32 
33 #include <ICLUtils/CompatMacros.h>
34 #include <ICLCore/Img.h>
35 #include <ICLFilter/UnaryOp.h>
36 
37 namespace icl{
38  namespace filter{
39 
41 
92  class ICLFilter_API WarpOp : public UnaryOp{
93  public:
94 
96 
105  explicit WarpOp(const core::Img32f &warpMap=core::Img32f(),
107  bool allowWarpMapScaling=true);
108 
110  ~WarpOp();
111 
113  void setScaleMode(core::scalemode scaleMode);
114 
116  void setWarpMap(const core::Img32f &warpMap);
117 
119 
120  void setAllowWarpMapScaling(bool allow);
121 
123 
126  void setTryUseOpenCL(bool enabled);
127 
129  core::scalemode getScaleMode() const { return m_scaleMode; }
130 
132  const core::Img32f &getWarpMap() const { return m_warpMap; }
133 
135  bool getAllowWarpMapScaling() const { return m_allowWarpMapScaling; }
136 
138  virtual void apply(const core::ImgBase *src, core::ImgBase **dst);
139 
141  using UnaryOp::apply;
142 
143  private:
149 
150 #ifdef ICL_HAVE_OPENCL
151  struct CLWarp; // forward declaration
152  CLWarp *m_clWarp;
153 #endif
154  };
155 
156 
157  } // namespace filter
158 }
159 
undocument this line if you encounter any issues!
Definition: Any.h:37
CLWarp * m_clWarp
Definition: WarpOp.h:151
core::scalemode getScaleMode() const
returns the current scalemode
Definition: WarpOp.h:129
const core::Img32f & getWarpMap() const
returns the current warp map
Definition: WarpOp.h:132
bool getAllowWarpMapScaling() const
returns whether warp map scaling is allowed
Definition: WarpOp.h:135
Abstract Base class for Unary Operators.
Definition: UnaryOp.h:51
ICLQt_API core::Img< T > filter(const core::Img< T > &image, const std::string &filter)
applies a filter operation on the source image (affinity for float)
core::scalemode m_scaleMode
Definition: WarpOp.h:147
core::Img32f m_warpMap
Definition: WarpOp.h:145
scalemode
for scaling of Img images theses functions are provided
Definition: Types.h:84
bool m_allowWarpMapScaling
Definition: WarpOp.h:144
#define ICLFilter_API
Definition: CompatMacros.h:175
core::Img32f m_scaledWarpMap
Definition: WarpOp.h:146
virtual void apply(const core::ImgBase *operand1, core::ImgBase **dst)=0
pure virtual apply function, that must be implemented in all derived classes
bool m_tryUseOpenCL
Definition: WarpOp.h:148
Definition: Types.h:86
ImgBase is the Image-Interface class that provides save access to underlying Img-template .
Definition: ImgBase.h:131
Operator that remaps an image with given look-up map.
Definition: WarpOp.h:92