ome-qtwidgets 5.3.2

Image2D.h
1 /*
2 * #%L
3 * OME-QTWIDGETS C++ library for display of OME-Files pixel data and metadata.
4 * %%
5 * Copyright © 2014 - 2015 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
39 #ifndef OME_QTWIDGETS_GL_IMAGE2D_H
40 #define OME_QTWIDGETS_GL_IMAGE2D_H
41
42 #include <QtCore/QObject>
43 #include <QtGui/QOpenGLVertexArrayObject>
44 #include <QtGui/QOpenGLBuffer>
45 #include <QtGui/QOpenGLShader>
46 #include <QtGui/QOpenGLFunctions_3_3_Core>
47
48 #include <ome/files/Types.h>
49 #include <ome/files/FormatReader.h>
50
51 #include <ome/compat/memory.h>
52
53 #include <ome/qtwidgets/glm.h>
54
55 namespace ome
56 {
57 namespace qtwidgets
58 {
59 namespace gl
60 {
61
70 class Image2D : public QObject,
71 protected QOpenGLFunctions_3_3_Core
72 {
73 Q_OBJECT
74
75 public:
85 explicit
86 Image2D(ome::compat::shared_ptr<ome::files::FormatReader> reader,
87 ome::files::dimension_size_type series,
88 QObject *parent = 0);
89
91 virtual
92 ~Image2D() = 0;
93
100 virtual
101 void
102 create();
103
104 protected:
111 virtual
112 void
113 setSize(const glm::vec2& xlim,
114 const glm::vec2& ylim);
115
116 public:
122 void
123 setPlane(ome::files::dimension_size_type plane);
124
130 const glm::vec3&
131 getMin() const;
132
141 void
142 setMin(const glm::vec3& min);
143
149 const glm::vec3&
150 getMax() const;
151
160 void
161 setMax(const glm::vec3& max);
162
166 enum RangePolicy
167 {
168 StorageRange,
169 BPPRange,
170 PlaneRange,
171 ImageRange
172 };
173
179 virtual
180 void
181 render(const glm::mat4& mvp) = 0;
182
191 unsigned int
192 texture();
193
202 unsigned int
203 lut();
204
205 protected:
207 QOpenGLVertexArrayObject vertices;
209 QOpenGLBuffer image_vertices;
211 QOpenGLBuffer image_texcoords;
213 QOpenGLBuffer image_elements;
215 unsigned int textureid;
217 unsigned int lutid;
219 glm::vec3 texmin;
221 glm::vec3 texmax;
223 glm::vec3 texcorr;
225 ome::compat::shared_ptr<ome::files::FormatReader> reader;
227 ome::files::dimension_size_type series;
229 ome::files::dimension_size_type plane;
230 };
231
232 }
233 }
234 }
235
236 #endif // OME_QTWIDGETS_GL_IMAGE2D_H
237
238 /*
239 * Local Variables:
240 * mode:C++
241 * End:
242 */
ome::qtwidgets::gl::Image2D::texture
unsigned int texture()
Get texture ID.
Definition: Image2D.cpp:469
ome::qtwidgets::gl::Image2D::texcorr
glm::vec3 texcorr
Linear contrast correction multipliers.
Definition: Image2D.h:223
ome::qtwidgets::gl::Image2D::texmin
glm::vec3 texmin
Linear contrast minimum limits.
Definition: Image2D.h:219
ome::files::dimension_size_type
std::size_t dimension_size_type
ome::qtwidgets::gl::Image2D::setPlane
void setPlane(ome::files::dimension_size_type plane)
Set the plane to render.
Definition: Image2D.cpp:426
ome::qtwidgets::gl::Image2D::image_vertices
QOpenGLBuffer image_vertices
The image vertices.
Definition: Image2D.h:209
ome::qtwidgets::gl::Image2D::ImageRange
Range of samples in the current image.
Definition: Image2D.h:171
ome::qtwidgets::gl::Image2D::Image2D
Image2D(ome::compat::shared_ptr< ome::files::FormatReader > reader, ome::files::dimension_size_type series, QObject *parent=0)
Create a 2D image.
Definition: Image2D.cpp:276
ome::qtwidgets::gl::Image2D::render
virtual void render(const glm::mat4 &mvp)=0
Render the image.
ome::qtwidgets::gl::Image2D::getMax
const glm::vec3 & getMax() const
Get maximum limit for linear contrast.
Definition: Image2D.cpp:457
ome::qtwidgets::gl::Image2D::vertices
QOpenGLVertexArrayObject vertices
The vertex array.
Definition: Image2D.h:207
ome::qtwidgets::gl::Image2D::PlaneRange
Range of samples on the current plane.
Definition: Image2D.h:170
ome::qtwidgets::gl::Image2D::image_texcoords
QOpenGLBuffer image_texcoords
The image texture coordinates.
Definition: Image2D.h:211
ome::qtwidgets::gl::Image2D::~Image2D
virtual ~Image2D()=0
Destructor.
Definition: Image2D.cpp:296
ome::qtwidgets::gl::Image2D::texmax
glm::vec3 texmax
Linear contrast maximum limits.
Definition: Image2D.h:221
ome
Open Microscopy Environment C++.
ome::qtwidgets::gl::Image2D::create
virtual void create()
Create GL buffers.
Definition: Image2D.cpp:300
ome::qtwidgets::gl::Image2D::setMax
void setMax(const glm::vec3 &max)
Set maximum limit for linear contrast.
Definition: Image2D.cpp:463
ome::qtwidgets::gl::Image2D::setMin
void setMin(const glm::vec3 &min)
Set minimum limit for linear contrast.
Definition: Image2D.cpp:451
ome::qtwidgets::gl::Image2D::lut
unsigned int lut()
Get LUT ID.
Definition: Image2D.cpp:475
memory.h
ome::qtwidgets::gl::Image2D::series
ome::files::dimension_size_type series
The image series.
Definition: Image2D.h:227
ome::qtwidgets::gl::Image2D::plane
ome::files::dimension_size_type plane
The current image plane.
Definition: Image2D.h:229
ome::qtwidgets::gl::Image2D::RangePolicy
RangePolicy
Range of min/max adjustment for linear contrast.
Definition: Image2D.h:166
ome::qtwidgets::gl::Image2D::getMin
const glm::vec3 & getMin() const
Get minimum limit for linear contrast.
Definition: Image2D.cpp:445
ome::qtwidgets::gl::Image2D::StorageRange
Range of storage type.
Definition: Image2D.h:168
ome::qtwidgets::gl::Image2D::image_elements
QOpenGLBuffer image_elements
The image elements.
Definition: Image2D.h:213
ome::qtwidgets::gl::Image2D::lutid
unsigned int lutid
The identifier of the LUTs owned and used by this object.
Definition: Image2D.h:217
ome::qtwidgets::gl::Image2D::reader
ome::compat::shared_ptr< ome::files::FormatReader > reader
The image reader.
Definition: Image2D.h:225
ome::qtwidgets::gl::Image2D::textureid
unsigned int textureid
The identifier of the texture owned and used by this object.
Definition: Image2D.h:215
ome::qtwidgets::gl::Image2D
2D (xy) image renderer.
Definition: Image2D.h:70
ome::qtwidgets::gl::Image2D::setSize
virtual void setSize(const glm::vec2 &xlim, const glm::vec2 &ylim)
Set the size of the x and y dimensions.
Definition: Image2D.cpp:377
ome::qtwidgets::gl::Image2D::BPPRange
Range of pixel type and bits per pixel.
Definition: Image2D.h:169