OpenStructure
build-dev-doc
stage
include
ost
img
map.hh
Go to the documentation of this file.
1
//------------------------------------------------------------------------------
2
// This file is part of the OpenStructure project <www.openstructure.org>
3
//
4
// Copyright (C) 2008-2020 by the OpenStructure authors
5
//
6
// This library is free software; you can redistribute it and/or modify it under
7
// the terms of the GNU Lesser General Public License as published by the Free
8
// Software Foundation; either version 3.0 of the License, or (at your option)
9
// any later version.
10
// This library is distributed in the hope that it will be useful, but WITHOUT
11
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13
// details.
14
//
15
// You should have received a copy of the GNU Lesser General Public License
16
// along with this library; if not, write to the Free Software Foundation, Inc.,
17
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
//------------------------------------------------------------------------------
19
#ifndef OST_MAP_HH
20
#define OST_MAP_HH
21
22
#include <
ost/img/image.hh
>
23
24
namespace
ost
{
namespace
img {
25
26
typedef
ImageHandle
MapHandle
;
27
28
ImageHandle
DLLEXPORT_OST_IMG_BASE
CreateMap
(
const
Extent
& ext=
Extent
(),
29
DataType
type=
REAL
,
30
DataDomain
dom=
SPATIAL
);
31
33
ImageHandle
DLLEXPORT_OST_IMG_BASE
CreateMap
(
const
Size
& s,
const
Point
& o,
34
DataType
type=
REAL
,
35
DataDomain
dom=
SPATIAL
);
36
37
ImageHandle
DLLEXPORT_OST_IMG_BASE
CreateMap
(
const
Point
& p1,
const
Point
& p2,
38
DataType
type=
REAL
,
39
DataDomain
dom=
SPATIAL
);
40
41
ImageHandle
DLLEXPORT_OST_IMG_BASE
CreateMap
(
const
Point
& p1,
const
Size
& s,
42
DataType
type=
REAL
,
43
DataDomain
dom=
SPATIAL
);
44
45
}}
46
47
#endif
ost::img::Extent
Defines lower and upper valid indices.
Definition:
extent.hh:60
ost::img::ImageHandle
Manage shared instances of images.
Definition:
image_handle.hh:111
ost::img::Point
class encapsulating 1D to 3D point
Definition:
point.hh:47
ost::img::Size
class encapsulating 1D to 3D size
Definition:
size.hh:39
image.hh
DLLEXPORT_OST_IMG_BASE
#define DLLEXPORT_OST_IMG_BASE
Definition:
module_config.hh:33
ost::img::MapHandle
ImageHandle MapHandle
Definition:
map.hh:26
ost::img::CreateMap
ImageHandle DLLEXPORT_OST_IMG_BASE CreateMap(const Extent &ext=Extent(), DataType type=REAL, DataDomain dom=SPATIAL)
ost::img::DataDomain
DataDomain
underlying data type
Definition:
data_types.hh:42
ost::img::SPATIAL
@ SPATIAL
Definition:
data_types.hh:42
ost::img::DataType
DataType
Definition:
data_types.hh:37
ost::img::REAL
@ REAL
Definition:
data_types.hh:37
ost
Definition:
base.dox:1
Generated by
1.9.1