The Fib multimedia system
Fib is a system for storing multimedia data (like images or films).
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
iConvertImageStructureToFib.h
Go to the documentation of this file.
1 /**
2  * @file iConvertImageStructureToFib
3  * file name: iConvertImageStructureToFib.h
4  * @author Betti Oesterholz
5  * @date 22.08.2012
6  * @mail webmaster@BioKom.info
7  *
8  * System: C++
9  *
10  * This header specifies a interface for converting data to a Fib object.
11  *
12  * Copyright (C) @c GPL3 2012 Betti Oesterholz
13  *
14  * This program is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License (GPL) as
16  * published by the Free Software Foundation, either version 3 of the
17  * License, or any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22  * GNU Lesser General Public License for more details.
23  *
24  * This header specifies a class to store the data for a search on image data.
25  * If you want to convert an image to Fib structures, you have to search
26  * the image for structures, which can be converted to Fib.
27  * To mark for which points structures wher found and which points you can
28  * set to any overwritten property because the points are overwritten, you
29  * can use this class.
30  *
31  * This header specifies a interface for converting data to a Fib object.
32  * For this an method convertToFib() is defined.
33  *
34  */
35 /*
36 History:
37 22.08.2012 Oesterholz created
38 */
39 
40 
41 #ifndef ___I_CONVERT_IMAGE_STRUCTURE_TO_FIB_H__
42 #define ___I_CONVERT_IMAGE_STRUCTURE_TO_FIB_H__
43 
44 #include "version.h"
45 
46 #include "iConvertToFib.h"
47 
48 #include "cImageSearchData.h"
49 
50 
51 
52 namespace fib{
53 
54 namespace algorithms{
55 
56 namespace nConvertToFib{
57 
58 namespace nImage{
59 
60 namespace nStructureData{
61 
62 namespace nConvertToFib{
63 
64 
67 public:
68 
69  /**
70  * This method is for converting data to a Fib object.
71  *
72  * @param pImageSearchData a pointer to the image search data of found
73  * image parts, which will overwrite tile parts
74  * (the evaled area can be bigger, because some parts of it won't be seen)
75  * @param maxValue the maximum possible value in all evalued parameters
76  * of the evalued elements will allways have lower absolute values or
77  * the values (parameters) of the elements are coordinate values of points;
78  * if 0 (standard value) is given, the maximum possible value will
79  * be evalued from the given data (absolute maximum in given data * 256)
80  * @param ulMaxErrorPerPoint the maximal error of a point or
81  * the maximal distance a point can be outside the area and the
82  * search area
83  * @return a Fib object which represents the data of this object
84  * Beware: You have to delete the returned Fib object after usage.
85  * Also the given root element will contain no domains, you have to
86  * create them if needed (eg. with cRoot::generateNeededDomains() ).
87  */
88  virtual cRoot * convertToFib( const cImageSearchData * pImageSearchData,
89  const double maxValue = 65536.0,
90  const unsigned long ulMaxErrorPerPoint = 0.0 ) const = 0;
91 
92 
93 };//interface iConvertImageStructureToFib
94 
95 
96 };//end namespace nConvertToFib
97 };//end namespace nStructureData
98 };//end namespace nImage
99 };//end namespace nConvertToFib
100 };//end namespace algorithms
101 };//end namespace fib
102 
103 
104 #endif //___I_CONVERT_IMAGE_STRUCTURE_TO_FIB_H__