annotate CppClient/PublicEnumerations.h @ 6:c584c25a74fd

cont
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 02 Jun 2015 10:22:49 +0200
parents Graveyard/Enumerations.h@fd402e53d263
children 39730d6727f3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
fd402e53d263 new files
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
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include <laaw/laaw.h>
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 namespace Orthanc
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 * {summary}{The memory layout of the pixels (resp. voxels) of a 2D (resp. 3D) image.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 enum LAAW_API PixelFormat
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 * {summary}{Color image in RGB24 format.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 * {description}{This format describes a color image. The pixels are stored in 3
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 * consecutive bytes. The memory layout is RGB.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 PixelFormat_RGB24 = 1,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 * {summary}{Color image in RGBA32 format.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 * {description}{This format describes a color image. The pixels are stored in 4
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 * consecutive bytes. The memory layout is RGBA.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 PixelFormat_RGBA32 = 2,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 * {summary}{Graylevel 8bpp image.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 * {description}{The image is graylevel. Each pixel is unsigned and stored in one byte.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 PixelFormat_Grayscale8 = 3,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 * {summary}{Graylevel, unsigned 16bpp image.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 * {description}{The image is graylevel. Each pixel is unsigned and stored in two bytes.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 PixelFormat_Grayscale16 = 4,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 * {summary}{Graylevel, signed 16bpp image.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 * {description}{The image is graylevel. Each pixel is signed and stored in two bytes.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 PixelFormat_SignedGrayscale16 = 5
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 };
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 * {summary}{The extraction mode specifies the way the values of the pixels are scaled when downloading a 2D image.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 enum LAAW_API ImageExtractionMode
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 {
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 * {summary}{Rescaled to 8bpp.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 * {description}{The minimum value of the image is set to 0, and its maximum value is set to 255.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 ImageExtractionMode_Preview = 1,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 * {summary}{Truncation to the [0, 255] range.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 ImageExtractionMode_UInt8 = 2,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 * {summary}{Truncation to the [0, 65535] range.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 ImageExtractionMode_UInt16 = 3,
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 /**
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 * {summary}{Truncation to the [-32768, 32767] range.}
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 **/
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 ImageExtractionMode_Int16 = 4
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 };
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
fd402e53d263 new files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 }