GDCM
2.2.3
|
#include <gdcmOverlay.h>
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. | |
void | Decompress (std::ostream &os) const |
Decode the internal OverlayData (packed bits) into unpacked representation. | |
unsigned short | GetBitPosition () const |
return bit position | |
unsigned short | GetBitsAllocated () const |
return bits allocated | |
bool | GetBuffer (char *buffer) const |
Get the raw (packed bits) Overlay Data: | |
unsigned short | GetColumns () const |
get columns | |
const char * | GetDescription () const |
get description | |
unsigned short | GetGroup () const |
Get Group number. | |
const signed short * | GetOrigin () const |
get origin | |
const ByteValue & | GetOverlayData () const |
unsigned short | GetRows () const |
get rows | |
const char * | GetType () const |
get type | |
OverlayType | GetTypeAsEnum () const |
bool | GetUnpackBuffer (unsigned char *buffer) const |
Do not use. | |
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: | |
bool | IsInPixelData () const |
return if the Overlay is stored in the pixel data or not | |
void | IsInPixelData (bool b) |
Set wether or no the OverlayData is in the Pixel Data: | |
bool | IsZero () const |
return true if all bits are set to 0 | |
void | Print (std::ostream &) const |
Print. | |
void | SetBitPosition (unsigned short bitposition) |
set bit position | |
void | SetBitsAllocated (unsigned short bitsallocated) |
set bits allocated | |
void | SetColumns (unsigned short columns) |
set columns | |
void | SetDescription (const char *description) |
set description | |
void | SetFrameOrigin (unsigned short frameorigin) |
set frame origin | |
void | SetGroup (unsigned short group) |
Set Group number. | |
void | SetNumberOfFrames (unsigned int numberofframes) |
set number of frames | |
void | SetOrigin (const signed short origin[2]) |
set origin | |
void | SetOverlay (const char *array, size_t length) |
set overlay from byte array + length | |
void | SetRows (unsigned short rows) |
set rows | |
void | SetType (const char *type) |
set type | |
void | Update (const DataElement &de) |
Update overlay from data element de: | |
Static Public Member Functions | |
static const char * | GetOverlayTypeAsString (OverlayType ot) |
static OverlayType | GetOverlayTypeFromString (const char *) |
Overlay class.
Example:
gdcm::Overlay::Overlay | ( | Overlay const & | ov | ) |
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 |
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: