ImageRegion.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLCV/src/ICLCV/ImageRegion.h                          **
** Module : ICLCV                                                  **
** Authors: Christof Elbrechter, Erik Weitnauer                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/


#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/ShallowCopyable.h>
#include <ICLUtils/Any.h>
#include <ICLCore/Img.h>
#include <ICLCV/RegionPCAInfo.h>
#include <ICLCV/LineSegment.h>

namespace icl{
  namespace cv{
    struct ImageRegionPart;
    struct ImageRegionData;

    struct ICLCV_API ImageRegion {

      ImageRegionData *m_data;

      template<class T> void calculateBoundaryIntern(const core::Img<T> &image) const;

      void calculateThinnedBoundaryIntern() const;

      utils::Point getUpperLeftPixel()const;

      public:

      ImageRegion(ImageRegionData *data=0):
        m_data(data){}

      friend class RegionDetector;


      inline operator bool() const { return m_data; }

      ImageRegionData *data() { return m_data; }

      const ImageRegionData *data() const { return m_data; }

      void sample(core::ImgBase *image, int color);

      void sample(core::ImgBase *image, const std::vector<int> &channelColors);

      int getSize() const;

      int getVal() const;

      int getID() const;

      utils::Point32f getCOG() const;

      const std::vector<LineSegment> &getLineSegments() const;

      const utils::Rect &getBoundingBox() const;

      const RegionPCAInfo &getPCAInfo() const;

      const std::vector<utils::Point> &getBoundary(bool thinned=true) const;

      int getBoundaryPointCount(bool thinned) const;


      float getBoundaryLength() const;


      const std::vector<utils::Point32f> &getBoundaryCorners() const;



      float getFormFactor() const;


      const std::vector<utils::Point> &getPixels() const;

      void drawTo(const core::ImgBase *image, icl64f val) const;


      void drawToColor(const core::ImgBase *image, const icl64f *color) const;


      const std::vector<ImageRegion> &getSubRegions(bool directOnly=true) const ;


      const ImageRegion &getParentRegion() const ;


      const std::vector<ImageRegion> &getParentTree() const ;


      const std::vector<ImageRegion> &getNeighbours() const ;

      bool isBorderRegion() const ;

      bool contains(const utils::Point &p) const;

      void showTree() const;


      void setMetaData(const utils::Any &any) const;

      const utils::Any &getMetaData() const;
   };

  } // namespace cv
}