cImageStructure.h

Go to the documentation of this file.

/**
 * @file cImageStructure
 * file name: cImageStructure.h
 * @author Betti Oesterholz
 * @date 22.08.2012
 * @mail Oesterholz@Fib-development.org
 *
 * System: C++
 *
 * This header specifies a class to store the data of a structure in an image.
 *
 * Copyright (C) @c GPL3 2012 Betti Oesterholz
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPL) as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * This header specifies a class to store the data of a structure in an image.
 * If you want to convert an image to Fib structures, you have to search
 * the image for structures, which can be converted to Fib.
 * For this structures you can use this class.
 */
/*
History:
22.08.2012  Oesterholz  created
*/


#ifndef ___C_IMAGE_STRUCTURE_H__
#define ___C_IMAGE_STRUCTURE_H__

#include "version.h"

#include "cVectorPosition.h"

#include <set>
#include <string>


using namespace std;


namespace fib{

namespace algorithms{

namespace nConvertToFib{

namespace nImage{

namespace nStructureData{


class cImageStructure{
protected:
   
   /**
    * All points in the image structure.
    */
   set<cVectorPosition> structurePoints;
   
   /**
    * Points which are in the structure, but have neighbour points which
    * are not in the structure.
    * @see structureNeighbourPoints
    * @see structurePoints
    */
   set<cVectorPosition> structureBorderPoints;

   /**
    * Points which are neighbours of points of the structure, but not in it.
    * @see structureBorderPoints
    * @see structurePoints
    */
   set<cVectorPosition> structureNeighbourPoints;
   
   
   /**
    * If the border points of the structure should be antialised.
    */
   bool bIsAntialised;
   
public:
   
   /**
    * standard constructor
    */
   cImageStructure();
   
   /**
    * copy constructor
    *
    * @param structureToCopy the image structure to copy
    */
   cImageStructure( const cImageStructure & structureToCopy );
   
   
   /**
    * destructor
    */
   virtual ~cImageStructure();
   
   
   /**
    * @return the name of the image structure (class name without the leading 'c')
    */
   virtual string getName() const;
   
   /**
    * @return the set with the points of the structure
    *    @see structurePoints
    */
   set<cVectorPosition> getStructurePoints() const;
   
   /**
    * @return the set with the points of the structure
    *    @see structurePoints
    */
   const set<cVectorPosition> & getStructurePointsConst() const;
   
   /**
    * @return the set with the points which are in the structure, but have
    *    neighbour points which are not in the structure
    *    @see structureBorderPoints
    */
   set<cVectorPosition> getStructureBorderPoints() const;
   
   /**
    * @return the set with the points which are in the structure, but have
    *    neighbour points which are not in the structure
    *    @see structureBorderPoints
    */
   const set<cVectorPosition> & getStructureBorderPointsConst() const;
   
   /**
    * @return the set with the points which are neighbours of points of the
    *    structure, but not in it
    *    @see structureNeighbourPoints
    */
   set<cVectorPosition> getStructureNeighbourPoints() const;
   
   /**
    * @return the set with the points which are neighbours of points of the
    *    structure, but not in it
    *    @see structureNeighbourPoints
    */
   const set<cVectorPosition> & getStructureNeighbourPointsConst() const;
   
   
   /**
    * This method sets the points of the structure to the given points.
    *
    * @see structurePoints
    * @param setInStructurePoints the set with the points of the structure
    */
   void setStructurePoints( const set<cVectorPosition> & setInStructurePoints );
   
   /**
    * This method sets the points which are in the structure, but have
    * neighbour points which are not in the structure.
    *
    * @see structureBorderPoints
    * @param setInStructureBorderPoints the set with the points which are
    *    in the structure, but have neighbour points which are not in the
    *    structure
    */
   void setStructureBorderPoints( const set<cVectorPosition> & setInStructureBorderPoints );
   
   /**
    * This method sets the points which are neighbours of points of the
    * structure, but not in it.
    *
    * @see structureNeighbourPoints
    * @param setInStructureBorderPoints the set with the points which are
    *    neighbours of points of the structure
    */
   void setStructureNeighbourPoints( const set<cVectorPosition> & setInStructureNeighbourPoints );
   
   /**
    * This method adds the given the given points to the structure.
    *
    * @see structurePoints
    * @param setInStructurePoints the set with the points to add to the
    *    points of the structure
    */
   void addStructurePoints( const set<cVectorPosition> & setInStructurePoints );
   
   /**
    * This method adds the given points to the points which are in the
    * structure, but have neighbour points which are not in the structure.
    *
    * @see structureBorderPoints
    * @param setInStructureBorderPoints the set with the points which to
    *    add to the structure of points, which have neighbour points which
    *    are not in the structure
    */
   void addStructureBorderPoints( const set<cVectorPosition> & setInStructureBorderPoints );
   
   /**
    * This method adds the given points to the points which are neighbours
    * of points of the structure, but not in it.
    *
    * @see structureNeighbourPoints
    * @param setInStructureBorderPoints the set with the points to add as
    *    the neighbours of points of the structure
    */
   void addStructureNeighbourPoints( const set<cVectorPosition> & setInStructureNeighbourPoints );
   
   /**
    * This method adds the given the given point to the structure.
    *
    * @see structurePoints
    * @param setInStructurePoints the point to add to the structure
    */
   void addStructurePoints( const cVectorPosition & pointInStructurePoints );
   
   /**
    * This method adds the given point to the points which are in the
    * structure, but have neighbour points, which are not in the structure.
    *
    * @see structureBorderPoints
    * @param setInStructureBorderPoints the point which to add to the
    *    structure of points which have neighbour points, which are not in
    *    the structure
    */
   void addStructureBorderPoints( const cVectorPosition & pointInStructureBorderPoints );
   
   /**
    * This method adds the given point to the points, which are neighbours
    * of points of the structure, but not in it.
    *
    * @see structureNeighbourPoints
    * @param setInStructureBorderPoints the points to add to the
    *    neighbours of points of the structure
    */
   void addStructureNeighbourPoints( const cVectorPosition & pointInStructureNeighbourPoints );
   
   
   /**
    * This method deletes the given points from the structure.
    *
    * @see structurePoints
    * @param setInStructurePoints the set with the points to delete from the
    *    points of the structure
    */
   void deleteStructurePoints( const set<cVectorPosition> & setInStructurePoints );
   
   /**
    * This method deletes the given points from the points which are in the
    * structure, but have neighbour points, which are not in the structure.
    *
    * @see structureBorderPoints
    * @param setInStructureBorderPoints the set with the points which to
    *    delete from the structure of points which have neighbour points, which
    *    are not in the structure
    */
   void deleteStructureBorderPoints( const set<cVectorPosition> & setInStructureBorderPoints );
   
   /**
    * This method deletes the given points from the points which are neighbours
    * of points of the structure, but not in it.
    *
    * @see structureNeighbourPoints
    * @param setInStructureBorderPoints the set with the points to delete
    *    of the neighbours of points of the structure
    */
   void deleteStructureNeighbourPoints( const set<cVectorPosition> & setInStructureNeighbourPoints );
   
   /**
    * This method deletes the given the given point from the structure.
    *
    * @see structurePoints
    * @param setInStructurePoints the point to delete from the structure
    */
   void deleteStructurePoints( const cVectorPosition & pointInStructurePoints );
   
   /**
    * This method deletes the given point from the points which are in the
    * structure, but have neighbour points, which are not in the structure.
    *
    * @see structureBorderPoints
    * @param setInStructureBorderPoints the point which to delete from the
    *    structure of points which have neighbour points, which are not in
    *    the structure
    */
   void deleteStructureBorderPoints( const cVectorPosition & pointInStructureBorderPoints );
   
   /**
    * This method deletes the given point from the points which are neighbours
    * of points of the structure, but not in it.
    *
    * @see structureNeighbourPoints
    * @param setInStructureBorderPoints the points to delete from the
    *    neighbours of points of the structure
    */
   void deleteStructureNeighbourPoints( const cVectorPosition & pointInStructureNeighbourPoints );
   
   
   /**
    * @see bIsAntialised
    * @return if the structure border is antialised
    */
   bool isAntialised() const;
   
   /**
    * Set if the border as antialised.
    *
    * @see bIsAntialised
    * @param bInIsAntialised if true the structure border will be set to
    *    antialised or if false, it will be to set to not antialised
    */
   void setAntialised( const bool bInIsAntialised = true );
   
   
};//class cImageStructure

};//end namespace nStructureData
};//end namespace nImage
};//end namespace nConvertToFib
};//end namespace algorithms
};//end namespace fib


#endif //___C_IMAGE_STRUCTURE_H__