Mercurial > hg > orthanc
annotate OrthancFramework/Sources/DicomFormat/DicomImageInformation.h @ 4181:b416b6bf129b
clarification of sdk doc about deadlocks
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 08 Sep 2020 09:16:33 +0200 |
| parents | 1a26daefc3fe |
| children | ab4d015af660 |
| rev | line source |
|---|---|
| 853 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1206
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
|
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 853 | 6 * |
| 7 * This program is free software: you can redistribute it and/or | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
8 * modify it under the terms of the GNU Lesser General Public License |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
9 * as published by the Free Software Foundation, either version 3 of |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
10 * the License, or (at your option) any later version. |
| 853 | 11 * |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
15 * Lesser General Public License for more details. |
| 853 | 16 * |
|
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
17 * You should have received a copy of the GNU Lesser General Public |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
18 * License along with this program. If not, see |
|
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4076
diff
changeset
|
19 * <http://www.gnu.org/licenses/>. |
| 853 | 20 **/ |
| 21 | |
| 22 | |
| 23 #pragma once | |
| 24 | |
| 25 #include "DicomMap.h" | |
| 26 | |
| 27 #include <stdint.h> | |
| 28 | |
| 29 namespace Orthanc | |
| 30 { | |
|
3992
f9863630ec7f
working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
31 class ORTHANC_PUBLIC DicomImageInformation |
| 853 | 32 { |
|
4138
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
33 public: |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
34 /** |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
35 * This constant gives a bound on the maximum tag length that is |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
36 * useful to class "DicomImageInformation", in order to avoid |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
37 * using too much memory when copying DICOM tags from "DcmDataset" |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
38 * to "DicomMap" using "ExtractDicomSummary()". The value 256 |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
39 * corresponds to ORTHANC_MAXIMUM_TAG_LENGTH that was implicitly |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
40 * used in Orthanc <= 1.7.2. |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
41 **/ |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
42 static const unsigned int USEFUL_TAG_LENGTH = 256; |
|
1a26daefc3fe
DicomImageInformation::USEFUL_TAG_LENGTH
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
43 |
| 853 | 44 private: |
| 45 unsigned int width_; | |
| 46 unsigned int height_; | |
| 47 unsigned int samplesPerPixel_; | |
|
4076
eab8010c05fc
avoid relying on boost::bad_lexical_cast in DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
48 uint32_t numberOfFrames_; |
| 853 | 49 |
| 50 bool isPlanar_; | |
| 51 bool isSigned_; | |
| 860 | 52 size_t bytesPerValue_; |
| 853 | 53 |
|
4076
eab8010c05fc
avoid relying on boost::bad_lexical_cast in DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
54 uint32_t bitsAllocated_; |
|
eab8010c05fc
avoid relying on boost::bad_lexical_cast in DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
55 uint32_t bitsStored_; |
|
eab8010c05fc
avoid relying on boost::bad_lexical_cast in DicomImageInformation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
56 uint32_t highBit_; |
| 853 | 57 |
|
1206
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
58 PhotometricInterpretation photometric_; |
|
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
59 |
| 2870 | 60 protected: |
| 61 explicit DicomImageInformation() | |
| 62 { | |
| 63 } | |
| 64 | |
| 853 | 65 public: |
| 2223 | 66 explicit DicomImageInformation(const DicomMap& values); |
| 853 | 67 |
| 2870 | 68 DicomImageInformation* Clone() const; |
| 69 | |
| 853 | 70 unsigned int GetWidth() const |
| 71 { | |
| 72 return width_; | |
| 73 } | |
| 74 | |
| 75 unsigned int GetHeight() const | |
| 76 { | |
| 77 return height_; | |
| 78 } | |
| 79 | |
| 80 unsigned int GetNumberOfFrames() const | |
| 81 { | |
| 82 return numberOfFrames_; | |
| 83 } | |
| 84 | |
| 85 unsigned int GetChannelCount() const | |
| 86 { | |
| 87 return samplesPerPixel_; | |
| 88 } | |
| 89 | |
| 90 unsigned int GetBitsStored() const | |
| 91 { | |
| 92 return bitsStored_; | |
| 93 } | |
| 94 | |
| 860 | 95 size_t GetBytesPerValue() const |
| 853 | 96 { |
| 860 | 97 return bytesPerValue_; |
| 853 | 98 } |
| 99 | |
| 100 bool IsSigned() const | |
| 101 { | |
| 102 return isSigned_; | |
| 103 } | |
| 104 | |
| 105 unsigned int GetBitsAllocated() const | |
| 106 { | |
| 107 return bitsAllocated_; | |
| 108 } | |
| 109 | |
| 110 unsigned int GetHighBit() const | |
| 111 { | |
| 112 return highBit_; | |
| 113 } | |
| 114 | |
| 115 bool IsPlanar() const | |
| 116 { | |
| 117 return isPlanar_; | |
| 118 } | |
| 119 | |
| 120 unsigned int GetShift() const | |
| 121 { | |
| 122 return highBit_ + 1 - bitsStored_; | |
| 123 } | |
|
854
ff530685e46a
fast version of image copy
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
853
diff
changeset
|
124 |
|
1206
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
125 PhotometricInterpretation GetPhotometricInterpretation() const |
|
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
126 { |
|
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
127 return photometric_; |
|
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
128 } |
|
f5b0207967bc
Fix issue 19 (YBR_FULL are decoded incorrectly)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
860
diff
changeset
|
129 |
|
1905
8b1baa2315b8
Huge speedup if decoding the family of JPEG transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
130 bool ExtractPixelFormat(PixelFormat& format, |
|
8b1baa2315b8
Huge speedup if decoding the family of JPEG transfer syntaxes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
131 bool ignorePhotometricInterpretation) const; |
|
1924
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1905
diff
changeset
|
132 |
|
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1905
diff
changeset
|
133 size_t GetFrameSize() const; |
| 853 | 134 }; |
| 135 } |