GDCM  2.4.5
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;
67  typedef enum {
68  Invalid = 0,
69  Graphics = 1,
70  ROI = 2
71  } OverlayType;
73  void SetType(const char* type);
75  const char *GetType() const;
76  OverlayType GetTypeAsEnum() const;
77  static const char *GetOverlayTypeAsString(OverlayType ot);
78  static OverlayType GetOverlayTypeFromString(const char *);
80  void SetOrigin(const signed short origin[2]);
82  const signed short * GetOrigin() const;
84  void SetFrameOrigin(unsigned short frameorigin);
86  void SetBitsAllocated(unsigned short bitsallocated);
88  unsigned short GetBitsAllocated() const;
90  void SetBitPosition(unsigned short bitposition);
92  unsigned short GetBitPosition() const;
93 
95  void SetOverlay(const char *array, size_t length);
97  bool GrabOverlayFromPixelData(DataSet const &ds);
98 
101  const ByteValue &GetOverlayData() const;
102 
104  bool IsEmpty() const;
105 
107  bool IsZero() const;
108 
110  bool IsInPixelData() const;
111 
113  void IsInPixelData(bool b);
114 
116  void Decompress(std::ostream &os) const;
117 
120  size_t GetUnpackBufferLength() const;
121 
124  bool GetUnpackBuffer(char *buffer, size_t len) const;
125 
126  Overlay(Overlay const &ov);
127  Overlay &operator=(Overlay const &ov);
128 
129 private:
130  OverlayInternal *Internal;
131 };
132 
133 } // end namespace gdcm
134 
135 #endif //GDCMOVERLAY_H
Class to represent a Data Set (which contains Data Elements) A Data Set represents an instance of a r...
Definition: gdcmDataSet.h:55
#define GDCM_EXPORT
Definition: gdcmWin32.h:34
Object.
Definition: gdcmObject.h:36
Class to represent a Data Element either Implicit or Explicit.
Definition: gdcmDataElement.h:58
Class to represent binary value (array of bytes)
Definition: gdcmByteValue.h:35
Definition: gdcmASN1.h:20
Overlay class.
Definition: gdcmOverlay.h:38

Generated on Fri Sep 25 2015 17:58:23 for GDCM by doxygen 1.8.9.1
SourceForge.net Logo