GDCM 2.2.1

- Main Page
- Related Pages
- Namespaces
- Classes
- Files
- Examples

- File List
- File Members

gdcmOverlay.h
Go to the documentation of this file.
1 /*=========================================================================
2
3 Program: GDCM (Grassroots DICOM). A DICOM library
4
5 Copyright (c) 2006-2011 Mathieu Malaterre
6 All rights reserved.
7 See Copyright.txt or http://gdcm.sourceforge.net/Copyright.html for details.
8
9 This software is distributed WITHOUT ANY WARRANTY; without even
10 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
11 PURPOSE. See the above copyright notice for more information.
12
13 =========================================================================*/
14 #ifndef GDCMOVERLAY_H
15 #define GDCMOVERLAY_H
16
17 #include "gdcmTypes.h"
18 #include "gdcmObject.h"
19
20 namespace gdcm
21 {
22
23 class OverlayInternal;
24 class ByteValue;
25 class DataSet;
26 class DataElement;
38 class GDCM_EXPORT Overlay : public Object
39 {
40 public:
41 Overlay();
42 ~Overlay();
44 void Print(std::ostream &) const;
45
47 void Update(const DataElement & de);
48
50 void SetGroup(unsigned short group);
52 unsigned short GetGroup() const;
54 void SetRows(unsigned short rows);
56 unsigned short GetRows() const;
58 void SetColumns(unsigned short columns);
60 unsigned short GetColumns() const;
62 void SetNumberOfFrames(unsigned int numberofframes);
64 void SetDescription(const char* description);
66 const char *GetDescription() const;
68 void SetType(const char* type);
70 const char *GetType() const;
72 void SetOrigin(const signed short *origin);
74 const signed short * GetOrigin() const;
76 void SetFrameOrigin(unsigned short frameorigin);
78 void SetBitsAllocated(unsigned short bitsallocated);
80 unsigned short GetBitsAllocated() const;
82 void SetBitPosition(unsigned short bitposition);
84 unsigned short GetBitPosition() const;
86 void SetOverlay(const char *array, unsigned int length);
88 bool GrabOverlayFromPixelData(DataSet const &ds);
89
90 const ByteValue &GetOverlayData() const;
91
92 bool IsEmpty() const;
93
95 bool IsZero() const;
96
97 // return if the Overlay is stored in the pixel data or not
98 bool IsInPixelData() const;
99 void IsInPixelData(bool b);
100
101 void Decode(std::istream &is, std::ostream &os);
102
103 void Decompress(std::ostream &os) const;
104
105 bool GetBuffer(char *buffer) const;
106 bool GetUnpackBuffer(unsigned char *buffer) const;
107
108 Overlay(Overlay const &ov);
109
110 private:
111 OverlayInternal *Internal;
112 };
113
114 } // end namespace gdcm
115
116 #endif //GDCMOVERLAY_H