Image Component Library (ICL)
NeighborhoodOp.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/NeighborhoodOp.h **
10 ** Module : ICLFilter **
11 ** Authors: Christof Elbrechter, Andre Justus **
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 <ICLFilter/UnaryOp.h>
35 
36 namespace icl {
37  namespace filter{
39 
60  public:
61 
63  virtual ~NeighborhoodOp(){}
64 
66 
76  bool computeROI(const core::ImgBase *poSrc, utils::Point& oROIoffset, utils::Size& oROIsize);
77 
79  virtual void applyMT(const core::ImgBase *operand1, core::ImgBase **dst, unsigned int nThreads);
80 
82  using UnaryOp::apply;
83 
84  protected:
85  NeighborhoodOp() : m_oMaskSize(1,1), m_oAnchor (0,0) {}
86  NeighborhoodOp(const utils::Size &size) {
87  setMask (size);
88  }
89 
90  void setMask(const utils::Size &size) {
91  m_oMaskSize = adaptSize(size);
92  m_oAnchor = utils::Point (m_oMaskSize.width/2, m_oMaskSize.height/2);
93  }
94  void setMask(const utils::Size &size, const utils::Point &anchor){
95  m_oMaskSize = adaptSize(size);
96  m_oAnchor = anchor;
97  }
98  void setROIOffset(const utils::Point &offs){
99  m_oROIOffset = offs;
100  }
101  public:
102  const utils::Size &getMaskSize() const{
103  return m_oMaskSize;
104  }
105  const utils::Point &getAnchor() const {
106  return m_oAnchor;
107  }
108  const utils::Point &getROIOffset() const{
109  return m_oROIOffset;
110  }
111  protected:
112 
114  virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc);
115 
117  virtual bool prepare (core::ImgBase **ppoDst, const core::ImgBase *poSrc, core::depth eDepht);
118 
120 
126  virtual utils::Size adaptSize(const utils::Size &size){ return size; }
127 
128  protected:
133  };
134  } // namespace filter
135 }
void setMask(const utils::Size &size)
Definition: NeighborhoodOp.h:90
NeighborhoodOp()
Definition: NeighborhoodOp.h:85
undocument this line if you encounter any issues!
Definition: Any.h:37
void setMask(const utils::Size &size, const utils::Point &anchor)
Definition: NeighborhoodOp.h:94
utils::Point m_oAnchor
anchor of filter mask
Definition: NeighborhoodOp.h:131
virtual ~NeighborhoodOp()
Destructor.
Definition: NeighborhoodOp.h:63
const utils::Point & getROIOffset() const
Definition: NeighborhoodOp.h:108
NeighborhoodOp(const utils::Size &size)
Definition: NeighborhoodOp.h:86
Abstract Base class for Unary Operators.
Definition: UnaryOp.h:51
Size class of the ICL.
Definition: Size.h:61
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)
unary operators that work on each pixels neighborhood \
Definition: NeighborhoodOp.h:59
const utils::Point & getAnchor() const
Definition: NeighborhoodOp.h:105
depth
determines the pixel type of an image (8Bit-int or 32Bit-float)
Definition: Types.h:60
void setROIOffset(const utils::Point &offs)
Definition: NeighborhoodOp.h:98
Point class of the ICL used e.g. for the Images ROI offset.
Definition: Point.h:58
utils::Point m_oROIOffset
to-be-used ROI offset for source image
Definition: NeighborhoodOp.h:132
#define ICLFilter_API
Definition: CompatMacros.h:175
virtual void apply(const core::ImgBase *operand1, core::ImgBase **dst)=0
pure virtual apply function, that must be implemented in all derived classes
utils::Size m_oMaskSize
TODO: later private with getter and setter functions.
Definition: NeighborhoodOp.h:130
const utils::Size & getMaskSize() const
Definition: NeighborhoodOp.h:102
ImgBase is the Image-Interface class that provides save access to underlying Img-template .
Definition: ImgBase.h:131
virtual utils::Size adaptSize(const utils::Size &size)
this function can be reimplemented e.g to enshure an odd mask width and height
Definition: NeighborhoodOp.h:126