cImageAreaSameColor.h

Go to the documentation of this file.

/**
 * @file cImageAreaSameColor
 * file name: cImageAreaSameColor.h
 * @author Betti Oesterholz
 * @date 23.10.2012
 * @mail Oesterholz@Fib-development.org
 *
 * System: C++
 *
 * This header specifies a class to store the data of a same colored area
 * 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 same colored area
 * 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.
 * If you have a area with one color, you can use this class to represent it.
 */
/*
History:
23.10.2012  Oesterholz  created
*/


#ifndef ___C_IMAGE_ARAE_SAME_COLOR_H__
#define ___C_IMAGE_ARAE_SAME_COLOR_H__

#include "version.h"

#include "cImageStructure.h"

#include "iConvertImageStructureToFib.h"
#include "cUseConvertAreaToExtObjectsStrategy.h"

#include "cVectorProperty.h"


namespace fib{

namespace algorithms{

namespace nConvertToFib{

namespace nImage{

namespace nStructureData{


class cImageAreaSameColor: public cImageStructure,
   public nConvertToFib::iConvertImageStructureToFib,
   public nConvertToFib::cUseConvertAreaToExtObjectsStrategy{
protected:
   

   /**
    * The color of the area.
    * @see getColorOfArea()
    * @see setColorOfArea()
    */
   cVectorProperty vecColor;
   
public:
   
   /**
    * standard constructor
    *
    * @param vecInColor the color the area has
    */
   cImageAreaSameColor( const cVectorProperty & vecInColor );
   
   /**
    * copy constructor
    *
    * @param structureToCopy the image structure to copy
    */
   cImageAreaSameColor( const cImageAreaSameColor & structureToCopy );
   
   
   /**
    * destructor
    */
   virtual ~cImageAreaSameColor();
   
   
   /**
    * @return the name of the image structure (class name without the leading 'c')
    */
   virtual string getName() const;
   
   /**
    * @see vecColor
    * @see setColorOfArea()
    * @return the color the area has
    */
   cVectorProperty getColorOfArea() const;
   
   /**
    * @see vecColor
    * @see setColorOfArea()
    * @return the color the area has
    */
   const cVectorProperty & getColorOfAreaConst() const;
   
   /**
    * This method sets the color the area has to the given color.
    *
    * @see vecColor
    * @see getColorOfArea()
    * @param vecInColor the color the area should have
    */
   void setColorOfArea( const cVectorProperty & vecInColor );
   
   
   //methods of iConvertImageStructureToFib
   
   /**
    * This method is for converting data to a Fib object.
    *
    * @return a Fib-object which represents the data of this object
    *    Beware: You have to delete the returned Fib object after usage.
    */
   virtual cRoot * convertToFib() const;
   
   /**
    * This method is for converting data to a Fib object.
    *
    * @param pImageSearchData a pointer to the image search data of found
    *    image parts, which will overwrite tile parts
    *    (the tiles can be bigger, because some parts of them won't be seen)
    * @param maxValue the maximum possible value in all parameters
    *    the evalued spline/function elements will allways have value
    *    parameters vecFactors[i] with
    *    -1 * maxValue <= vecFactors[i] <= maxValue for 0 <= i < vecFactors.size();
    *    if 0 (standard value) is given, the maximum possible value will
    *    be evalued from the given data (absolute maximum in given data * 256)
    * @param ulMaxErrorPerPoint the maximal error of a point or
    *    the maximal distance a point can be outside the area and the
    *    search area
    * @return a Fib-object which represents the data of this object
    *    Beware: You have to delete the returned Fib object after usage.
    *       Also the given root element will contain no domains, you have to
    *       create them if needed (eg. with cRoot::generateNeededDomains() ).
    */
   virtual cRoot * convertToFib( const cImageSearchData * pImageSearchData,
      const double maxValue = 65536.0, const unsigned long ulMaxErrorPerPoint = 0.0 ) const;
   
};//class cImageAreaSameColor


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


#endif //___C_IMAGE_ARAE_SAME_COLOR_H__