ome-files 0.2.2

OMETIFF.h
1 /*
2 * #%L
3 * OME-FILES C++ library for image IO.
4 * Copyright © 2006 - 2015 Open Microscopy Environment:
5 * - Massachusetts Institute of Technology
6 * - National Institutes of Health
7 * - University of Dundee
8 * - Board of Regents of the University of Wisconsin-Madison
9 * - Glencoe Software, Inc.
10 * %%
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * The views and conclusions contained in the software and documentation are
33 * those of the authors and should not be interpreted as representing official
34 * policies, either expressed or implied, of any organization.
35 * #L%
36 */
37
38 #ifndef OME_FILES_DETAIL_OMETIFF_H
39 #define OME_FILES_DETAIL_OMETIFF_H
40
41 #include <ome/files/Types.h>
42
43 #include <boost/filesystem/path.hpp>
44
45 namespace ome
46 {
47 namespace files
48 {
49 namespace detail
50 {
51
55 class OMETIFFPlane
56 {
57 public:
59 enum Status
60 {
61 UNKNOWN,
62 PRESENT,
63 ABSENT
64 };
65
67 boost::filesystem::path id;
69 dimension_size_type ifd;
71 bool certain;
73 Status status;
74
81 OMETIFFPlane():
82 id(),
83 ifd(),
84 certain(false),
85 status(UNKNOWN)
86 {
87 }
88
97 OMETIFFPlane(const boost::filesystem::path& id):
98 id(id),
99 ifd(),
100 certain(false),
101 status(UNKNOWN)
102 {
103 }
104 };
105
106 }
107 }
108 }
109
110 #endif // OME_FILES_DETAIL_OMETIFF_H
111
112 /*
113 * Local Variables:
114 * mode:C++
115 * End:
116 */
ome::files::detail::OMETIFFPlane::UNKNOWN
Not known.
Definition: OMETIFF.h:61
ome::files::dimension_size_type
std::size_t dimension_size_type
Size type for image dimensions.
Definition: Types.h:59
ome::files::detail::OMETIFFPlane::OMETIFFPlane
OMETIFFPlane(const boost::filesystem::path &id)
Construct with filename.
Definition: OMETIFF.h:97
ome::files::detail::OMETIFFPlane::certain
bool certain
Certainty flag, for dealing with unspecified NumPlanes.
Definition: OMETIFF.h:71
ome
Open Microscopy Environment C++.
ome::files::detail::OMETIFFPlane::PRESENT
File exists.
Definition: OMETIFF.h:62
ome::files::detail::OMETIFFPlane::ifd
dimension_size_type ifd
IFD index.
Definition: OMETIFF.h:69
ome::files::detail::OMETIFFPlane::Status
Status
Status of the file associated with this plane.
Definition: OMETIFF.h:59
ome::files::detail::OMETIFFPlane::id
boost::filesystem::path id
File containing this plane.
Definition: OMETIFF.h:67
ome::files::detail::OMETIFFPlane::status
Status status
File status.
Definition: OMETIFF.h:73
ome::files::detail::OMETIFFPlane
Metadata for a single plane within an OME-TIFF file set.
Definition: OMETIFF.h:55
ome::files::detail::OMETIFFPlane::OMETIFFPlane
OMETIFFPlane()
Default constructor.
Definition: OMETIFF.h:81
ome::files::detail::OMETIFFPlane::ABSENT
File is missing.
Definition: OMETIFF.h:63