annotate Orthanc/Core/ImageFormats/ImageAccessor.h @ 31:111689a2c177

author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 24 Jun 2015 16:20:41 +0200
parents 15acbf5e7545
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "../Enumerations.h"
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include <string>
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class ImageAccessor
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 private:
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 bool readOnly_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 PixelFormat format_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 unsigned int width_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 unsigned int height_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 unsigned int pitch_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 void *buffer_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 public:
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 ImageAccessor()
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 AssignEmpty(PixelFormat_Grayscale8);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 bool IsReadOnly() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 return readOnly_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 PixelFormat GetFormat() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 return format_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 unsigned int GetBytesPerPixel() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 return ::Orthanc::GetBytesPerPixel(format_);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 unsigned int GetWidth() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 return width_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 unsigned int GetHeight() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 return height_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 unsigned int GetPitch() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 return pitch_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 unsigned int GetSize() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 return GetHeight() * GetPitch();
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 const void* GetConstBuffer() const
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 {
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 return buffer_;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 void* GetBuffer() const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 const void* GetConstRow(unsigned int y) const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 void* GetRow(unsigned int y) const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 void AssignEmpty(PixelFormat format);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 void AssignReadOnly(PixelFormat format,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 unsigned int width,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 unsigned int height,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 unsigned int pitch,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 const void *buffer);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 void AssignWritable(PixelFormat format,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112 unsigned int width,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 unsigned int height,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 unsigned int pitch,
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 void *buffer);
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 void ToMatlabString(std::string& target) const;
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 };
15acbf5e7545 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }