gdcmOverlay.h

Go to the documentation of this file.

/*=========================================================================
 
  Program: GDCM (Grassroots DICOM). A DICOM library
 
  Copyright (c) 2006-2011 Mathieu Malaterre
  All rights reserved.
  See Copyright.txt or http://gdcm.sourceforge.net/Copyright.html for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef GDCMOVERLAY_H
#define GDCMOVERLAY_H
 
#include "gdcmTypes.h"
#include "gdcmObject.h"
 
namespace gdcm
{
 
class OverlayInternal;
class ByteValue;
class DataSet;
class DataElement;
class GDCM_EXPORT Overlay : public Object
{
public:
  Overlay();
  ~Overlay() override;
  void Print(std::ostream &) const override;
 
  void Update(const DataElement & de);
 
  void SetGroup(unsigned short group);
  unsigned short GetGroup() const;
  void SetRows(unsigned short rows);
  unsigned short GetRows() const;
  void SetColumns(unsigned short columns);
  unsigned short GetColumns() const;
  void SetNumberOfFrames(unsigned int numberofframes);
  void SetDescription(const char* description);
  const char *GetDescription() const;
  typedef enum {
    Invalid  = 0,
    Graphics = 1,
    ROI      = 2
  } OverlayType;
  void SetType(const char* type);
  const char *GetType() const;
  OverlayType GetTypeAsEnum() const;
  static const char *GetOverlayTypeAsString(OverlayType ot);
  static OverlayType GetOverlayTypeFromString(const char *);
  void SetOrigin(const signed short origin[2]);
  const signed short * GetOrigin() const;
  void SetFrameOrigin(unsigned short frameorigin);
  void SetBitsAllocated(unsigned short bitsallocated);
  unsigned short GetBitsAllocated() const;
  void SetBitPosition(unsigned short bitposition);
  unsigned short GetBitPosition() const;
 
  void SetOverlay(const char *array, size_t length);
  bool GrabOverlayFromPixelData(DataSet const &ds);
 
  const ByteValue &GetOverlayData() const;
 
  bool IsEmpty() const;
 
  bool IsZero() const;
 
  bool IsInPixelData() const;
 
  void IsInPixelData(bool b);
 
  void Decompress(std::ostream &os) const;
 
  size_t GetUnpackBufferLength() const;
 
  bool GetUnpackBuffer(char *buffer, size_t len) const;
 
  Overlay(Overlay const &ov);
  Overlay &operator=(Overlay const &ov);
 
private:
  OverlayInternal *Internal;
};
 
} // end namespace gdcm
 
#endif //GDCMOVERLAY_H