$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
header.hh
1 // Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development
2 // Laboratory (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef MLN_IO_FLD_HEADER_HH
28 # define MLN_IO_FLD_HEADER_HH
29 
30 namespace mln
31 {
32 
33  namespace io
34  {
35 
36  namespace fld
37  {
38 
39 
40  struct data_type { enum E { UNKNOWN, BYTE, SHORT, INTEGER, FLOAT, DOUBLE }; };
41  struct field_type { enum E { UNKNOWN, UNIFORM, RECTILINEAR, IRREGULAR }; };
42 
47  struct fld_header
48  {
49  int ndim; // The number of computational dimensions in the field.
50  int* dim; // The dimension size of each axis.
51  int nspace; // The number of physical coordinates per field element.
52  int veclen; // The number of data values for each field element.
53  data_type::E data; // The primitive data type of all the data values.
54  field_type::E field; // The field type.
55  float* min_ext; // The minimum coordinate value that any member data point occupies in space.
56  float* max_ext; // The maximum coordinate value that any member data point occupies in space.
57  // std::vector<std::string> label; // Not handled.
58  // std::vector<std::string> unit; // Not handled.
59  // void* min_val; // The minimum data value in the field. (Not used)
60  // void* max_val; // The maximum data value in the field. (Not used)
61  // struct {...} variable; // Not handled.
62  // struct {...} coord; // Not handled.
63 
64  fld_header();
65  ~fld_header();
66  };
67 
68 
69 # ifndef MLN_INCLUDE_ONLY
70 
71  inline
73  : ndim (-1),
74  dim (0),
75  nspace (-1),
76  veclen (-1),
77  data (data_type::UNKNOWN),
78  field (field_type::UNKNOWN)
79  {
80  }
81 
82  inline
84  {
85  delete [] dim;
86  delete [] max_ext;
87  delete [] min_ext;
88  }
89 
90 # endif // ! MLN_INCLUDE_ONLY
91 
92  } // end of namespace mln::io::fld
93 
94  } // end of namespace mln::io
95 
96 } // end of namespace mln
97 
98 #endif // !MLN_IO_FLD_HEADER_HH