ome-qtwidgets  5.2.0
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/QOpenGLBuffer>
44 #include <QtGui/QOpenGLShader>
45 #include <QtGui/QOpenGLFunctions>
46 
47 #include <ome/files/Types.h>
48 #include <ome/files/FormatReader.h>
49 
50 #include <ome/compat/memory.h>
51 
52 #include <ome/qtwidgets/glm.h>
53 
54 namespace ome
55 {
56  namespace qtwidgets
57  {
58  namespace gl
59  {
60 
69  class Image2D : public QObject,
70  protected QOpenGLFunctions
71  {
72  Q_OBJECT
73 
74  public:
84  explicit
85  Image2D(ome::compat::shared_ptr<ome::files::FormatReader> reader,
87  QObject *parent = 0);
88 
90  virtual
91  ~Image2D() = 0;
92 
99  virtual
100  void
101  create();
102 
103  protected:
110  virtual
111  void
112  setSize(const glm::vec2& xlim,
113  const glm::vec2& ylim);
114 
115  public:
121  void
123 
129  const glm::vec3&
130  getMin() const;
131 
140  void
141  setMin(const glm::vec3& min);
142 
148  const glm::vec3&
149  getMax() const;
150 
159  void
160  setMax(const glm::vec3& max);
161 
166  {
171  };
172 
178  virtual
179  void
180  render(const glm::mat4& mvp) = 0;
181 
190  unsigned int
191  texture();
192 
201  unsigned int
202  lut();
203 
204  protected:
206  QOpenGLBuffer image_vertices;
208  QOpenGLBuffer image_texcoords;
210  QOpenGLBuffer image_elements;
212  unsigned int textureid;
214  unsigned int lutid;
216  glm::vec3 texmin;
218  glm::vec3 texmax;
220  glm::vec3 texcorr;
222  ome::compat::shared_ptr<ome::files::FormatReader> reader;
227  };
228 
229  }
230  }
231 }
232 
233 #endif // OME_QTWIDGETS_GL_IMAGE2D_H
234 
235 /*
236  * Local Variables:
237  * mode:C++
238  * End:
239  */
unsigned int texture()
Get texture ID.
Definition: Image2D.cpp:464
glm::vec3 texcorr
Linear contrast correction multipliers.
Definition: Image2D.h:220
glm::vec3 texmin
Linear contrast minimum limits.
Definition: Image2D.h:216
std::size_t dimension_size_type
void setPlane(ome::files::dimension_size_type plane)
Set the plane to render.
Definition: Image2D.cpp:421
QOpenGLBuffer image_vertices
The image vertices.
Definition: Image2D.h:206
Range of samples in the current image.
Definition: Image2D.h:170
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
virtual void render(const glm::mat4 &mvp)=0
Render the image.
const glm::vec3 & getMax() const
Get maximum limit for linear contrast.
Definition: Image2D.cpp:452
Range of samples on the current plane.
Definition: Image2D.h:169
QOpenGLBuffer image_texcoords
The image texture coordinates.
Definition: Image2D.h:208
virtual ~Image2D()=0
Destructor.
Definition: Image2D.cpp:295
glm::vec3 texmax
Linear contrast maximum limits.
Definition: Image2D.h:218
virtual void create()
Create GL buffers.
Definition: Image2D.cpp:299
void setMax(const glm::vec3 &max)
Set maximum limit for linear contrast.
Definition: Image2D.cpp:458
void setMin(const glm::vec3 &min)
Set minimum limit for linear contrast.
Definition: Image2D.cpp:446
unsigned int lut()
Get LUT ID.
Definition: Image2D.cpp:470
ome::files::dimension_size_type series
The image series.
Definition: Image2D.h:224
ome::files::dimension_size_type plane
The current image plane.
Definition: Image2D.h:226
RangePolicy
Range of min/max adjustment for linear contrast.
Definition: Image2D.h:165
Range of storage type.
Definition: Image2D.h:167
QOpenGLBuffer image_elements
The image elements.
Definition: Image2D.h:210
unsigned int lutid
The identifier of the LUTs owned and used by this object.
Definition: Image2D.h:214
ome::compat::shared_ptr< ome::files::FormatReader > reader
The image reader.
Definition: Image2D.h:222
unsigned int textureid
The identifier of the texture owned and used by this object.
Definition: Image2D.h:212
2D (xy) image renderer.
Definition: Image2D.h:69
const glm::vec3 & getMin() const
Get minimum limit for linear contrast.
Definition: Image2D.cpp:440
virtual void setSize(const glm::vec2 &xlim, const glm::vec2 &ylim)
Set the size of the x and y dimensions.
Definition: Image2D.cpp:376
Range of pixel type and bits per pixel.
Definition: Image2D.h:168