#include <gdcmOverlay.h>

Inheritance diagram for gdcm::Overlay:

Collaboration diagram for gdcm::Overlay:

Public Types
enum	OverlayType { Invalid = 0, Graphics = 1, ROI = 2 }

Public Member Functions
	Overlay ()

	Overlay (Overlay const &ov)

	~Overlay ()

void	Decode (std::istream &is, std::ostream &os)
	Do not use. More...

void	Decompress (std::ostream &os) const
	Decode the internal OverlayData (packed bits) into unpacked representation. More...

unsigned short	GetBitPosition () const
	return bit position More...

unsigned short	GetBitsAllocated () const
	return bits allocated More...

bool	GetBuffer (char *buffer) const
	Get the raw (packed bits) Overlay Data: More...

unsigned short	GetColumns () const
	get columns More...

const char *	GetDescription () const
	get description More...

unsigned short	GetGroup () const
	Get Group number. More...

const signed short *	GetOrigin () const
	get origin More...

const ByteValue &	GetOverlayData () const

unsigned short	GetRows () const
	get rows More...

const char *	GetType () const
	get type More...

OverlayType	GetTypeAsEnum () const

bool	GetUnpackBuffer (unsigned char *buffer) const
	Do not use. More...

bool	GetUnpackBuffer (char *buffer, size_t len) const

size_t	GetUnpackBufferLength () const

bool	GrabOverlayFromPixelData (DataSet const &ds)

bool	IsEmpty () const
	Return whether or not the Overlay is empty: More...

bool	IsInPixelData () const
	return if the Overlay is stored in the pixel data or not More...

void	IsInPixelData (bool b)
	Set wether or no the OverlayData is in the Pixel Data: More...

bool	IsZero () const
	return true if all bits are set to 0 More...

void	Print (std::ostream &) const
	Print. More...

void	SetBitPosition (unsigned short bitposition)
	set bit position More...

void	SetBitsAllocated (unsigned short bitsallocated)
	set bits allocated More...

void	SetColumns (unsigned short columns)
	set columns More...

void	SetDescription (const char *description)
	set description More...

void	SetFrameOrigin (unsigned short frameorigin)
	set frame origin More...

void	SetGroup (unsigned short group)
	Set Group number. More...

void	SetNumberOfFrames (unsigned int numberofframes)
	set number of frames More...

void	SetOrigin (const signed short origin[2])
	set origin More...

void	SetOverlay (const char *array, size_t length)
	set overlay from byte array + length More...

void	SetRows (unsigned short rows)
	set rows More...

void	SetType (const char *type)
	set type More...

void	Update (const DataElement &de)
	Update overlay from data element de: More...

Public Member Functions inherited from gdcm::Object
	Object ()

	Object (const Object &)
	Special requirement for copy/cstor, assigment operator. More...

virtual	~Object ()

void	operator= (const Object &)

Static Public Member Functions
static const char *	GetOverlayTypeAsString (OverlayType ot)

static OverlayType	GetOverlayTypeFromString (const char *)

Additional Inherited Members
Protected Member Functions inherited from gdcm::Object
void	Register ()

void	UnRegister ()

Detailed Description

Overlay class.

Note: see AreOverlaysInPixelData

Todo:: Is there actually any way to recognize an overlay ? On images with multiple overlay I do not see any way to differenciate them (other than the group tag).

Example:

Member Enumeration Documentation

enum gdcm::Overlay::OverlayType

Enumerator
Invalid
Graphics
ROI

Constructor & Destructor Documentation

gdcm::Overlay::Overlay ( )

gdcm::Overlay::~Overlay ( )

gdcm::Overlay::Overlay ( Overlay const & ov )

Member Function Documentation

void gdcm::Overlay::Decode	(	std::istream &	is,
		std::ostream &	os
	)

Do not use.

void gdcm::Overlay::Decompress ( std::ostream & os ) const

Decode the internal OverlayData (packed bits) into unpacked representation.

unsigned short gdcm::Overlay::GetBitPosition ( ) const

return bit position

unsigned short gdcm::Overlay::GetBitsAllocated ( ) const

return bits allocated

bool gdcm::Overlay::GetBuffer ( char * buffer ) const

Get the raw (packed bits) Overlay Data:

unsigned short gdcm::Overlay::GetColumns ( ) const

get columns

const char* gdcm::Overlay::GetDescription ( ) const

get description

unsigned short gdcm::Overlay::GetGroup ( ) const

Get Group number.

const signed short* gdcm::Overlay::GetOrigin ( ) const

get origin

const ByteValue& gdcm::Overlay::GetOverlayData ( ) const

Return the Overlay Data as ByteValue: Not thread safe

static const char* gdcm::Overlay::GetOverlayTypeAsString ( OverlayType ot )

static

static OverlayType gdcm::Overlay::GetOverlayTypeFromString ( const char * )

static

unsigned short gdcm::Overlay::GetRows ( ) const

get rows

const char* gdcm::Overlay::GetType ( ) const

get type

OverlayType gdcm::Overlay::GetTypeAsEnum ( ) const

bool gdcm::Overlay::GetUnpackBuffer ( unsigned char * buffer ) const

Do not use.

bool gdcm::Overlay::GetUnpackBuffer	(	char *	buffer,
		size_t	len
	)		const

Retrieve the unpack buffer for Overlay. This is an error if the size if below GetUnpackBufferLength()

size_t gdcm::Overlay::GetUnpackBufferLength ( ) const

Retrieve the size of the buffer needed to hold the Overlay as specified by Col & Row parameters

bool gdcm::Overlay::GrabOverlayFromPixelData ( DataSet const & ds )

bool gdcm::Overlay::IsEmpty ( ) const

Return whether or not the Overlay is empty:

bool gdcm::Overlay::IsInPixelData ( ) const

return if the Overlay is stored in the pixel data or not

void gdcm::Overlay::IsInPixelData ( bool b )

Set wether or no the OverlayData is in the Pixel Data:

bool gdcm::Overlay::IsZero ( ) const

return true if all bits are set to 0

void gdcm::Overlay::Print ( std::ostream & ) const

virtual

Print.

Reimplemented from gdcm::Object.

void gdcm::Overlay::SetBitPosition ( unsigned short bitposition )

set bit position

void gdcm::Overlay::SetBitsAllocated ( unsigned short bitsallocated )

set bits allocated

void gdcm::Overlay::SetColumns ( unsigned short columns )

set columns

void gdcm::Overlay::SetDescription ( const char * description )

set description

void gdcm::Overlay::SetFrameOrigin ( unsigned short frameorigin )

set frame origin

void gdcm::Overlay::SetGroup ( unsigned short group )

Set Group number.

void gdcm::Overlay::SetNumberOfFrames ( unsigned int numberofframes )

set number of frames

void gdcm::Overlay::SetOrigin ( const signed short origin[2] )

set origin

void gdcm::Overlay::SetOverlay	(	const char *	array,
		size_t	length
	)

set overlay from byte array + length

void gdcm::Overlay::SetRows ( unsigned short rows )

set rows

void gdcm::Overlay::SetType ( const char * type )

set type

void gdcm::Overlay::Update ( const DataElement & de )

Update overlay from data element de:

The documentation for this class was generated from the following file:

gdcmOverlay.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation