DiColorPixelTemplate< T > Class Template Reference

Template class to handle color pixel data. More...

Inheritance diagram for DiColorPixelTemplate< T >:

DiColorPixel DiPixelRepresentationTemplate< T > DiPixel DiColorCopyTemplate< T > DiColorFlipTemplate< T > DiColorRotateTemplate< T > DiColorScaleTemplate< T > List of all members.

Public Member Functions

 DiColorPixelTemplate (const DiDocument *docu, const DiInputPixel *pixel, const Uint16 samples, EI_Status &status, const Uint16 sample_rate=0)
 constructor
virtual ~DiColorPixelTemplate ()
 destructor
EP_Representation getRepresentation () const
 get integer representation
const void * getData () const
 get pointer to internal array of pixel data.
void * getDataPtr ()
 get pointer to internal array of pixel data.
void * getDataArrayPtr ()
 get pointer to internal array of pixel data.
OFBool getPixelData (void *data, const size_t count) const
 fill given memory block with pixel data (all three image planes, RGB).
unsigned long createDIB (void *&data, const unsigned long size, const Uint16 width, const Uint16 height, const unsigned long frame, const int fromBits, const int toBits, const int mode, const int upsideDown, const int padding) const
 create true color (24/32 bit) bitmap for MS Windows.
unsigned long createAWTBitmap (void *&data, const Uint16 width, const Uint16 height, const unsigned long frame, const int fromBits, const int toBits) const
 create true color (32 bit) bitmap for Java (AWT default format).

Protected Member Functions

 DiColorPixelTemplate (const DiColorPixel *pixel, const unsigned long count)
 constructor
int Init (const void *pixel)
 initialize internal memory

Protected Attributes

T * Data [3]
 pointer to pixel data (3 components)

Private Member Functions

 DiColorPixelTemplate (const DiColorPixelTemplate< T > &)
DiColorPixelTemplate< T > & operator= (const DiColorPixelTemplate< T > &)

Detailed Description

template<class T>
class DiColorPixelTemplate< T >

Template class to handle color pixel data.

Definition at line 109 of file dicopxt.h.

Constructor & Destructor Documentation

template<class T>
DiColorPixelTemplate< T >::DiColorPixelTemplate (  const DiDocument *  docu,
const DiInputPixel *  pixel,
const Uint16  samples,
EI_Status &  status,
const Uint16  sample_rate = 0
)  [inline]
 

constructor

Parameters:
docu pointer to the DICOM document
pixel pointer to input pixel data
samples number of expected samples per pixel (for checking purposes)
status status of the image object (reference variable)
sample_rate dummy parameter (used for derived classes only)

Definition at line 124 of file dicopxt.h.

template<class T>
DiColorPixelTemplate< T >::DiColorPixelTemplate (  const DiColorPixel *  pixel,
const unsigned long  count
)  [inline, protected]
 

constructor

Parameters:
pixel pointer to intermediate color pixel data
count number of pixels

Definition at line 509 of file dicopxt.h.

Member Function Documentation

template<class T>
unsigned long DiColorPixelTemplate< T >::createAWTBitmap (  void *&  data,
const Uint16  width,
const Uint16  height,
const unsigned long  frame,
const int  fromBits,
const int  toBits
)  const [inline, virtual]
 

create true color (32 bit) bitmap for Java (AWT default format).

Parameters:
data resulting pointer to bitmap data (set to NULL if an error occurred)
width number of columns of the image
height number of rows of the image
frame index of frame to be converted (starting from 0)
fromBits number of bits per sample used for internal representation of the image
toBits number of bits per sample used for the output bitmap (<= 8)
Returns:
number of bytes allocated by the bitmap, or 0 if an error occured

Implements DiColorPixel.

Definition at line 426 of file dicopxt.h.

template<class T>
unsigned long DiColorPixelTemplate< T >::createDIB (  void *&  data,
const unsigned long  size,
const Uint16  width,
const Uint16  height,
const unsigned long  frame,
const int  fromBits,
const int  toBits,
const int  mode,
const int  upsideDown,
const int  padding
)  const [inline, virtual]
 

create true color (24/32 bit) bitmap for MS Windows.

Parameters:
data untyped pointer memory buffer (set to NULL if not allocated externally)
size size of the memory buffer in bytes (if 0 'data' is set to NULL)
width number of columns of the image
height number of rows of the image
frame index of frame to be converted (starting from 0)
fromBits number of bits per sample used for internal representation of the image
toBits number of bits per sample used for the output bitmap (<= 8)
mode color output mode (24 or 32 bits, see dcmimgle/dcmimage.h for details)
upsideDown specifies the order of lines in the images (0 = top-down, bottom-up otherwise)
padding align each line to a 32-bit address if true
Returns:
number of bytes allocated by the bitmap, or 0 if an error occured

Implements DiColorPixel.

Definition at line 225 of file dicopxt.h.

template<class T>
const void* DiColorPixelTemplate< T >::getData (   )  const [inline, virtual]
 

get pointer to internal array of pixel data.

The returned array [0..2] points to the three image planes.

Returns:
pointer to array of pixel data

Implements DiPixel.

Definition at line 159 of file dicopxt.h.

template<class T>
void* DiColorPixelTemplate< T >::getDataArrayPtr (   )  [inline, virtual]
 

get pointer to internal array of pixel data.

The returned array [0..2] points to the three image planes.

Returns:
reference to pointer to pixel data

Implements DiPixel.

Definition at line 179 of file dicopxt.h.

template<class T>
void* DiColorPixelTemplate< T >::getDataPtr (   )  [inline, virtual]
 

get pointer to internal array of pixel data.

The returned array [0..2] points to the three image planes.

Returns:
pointer to array of pixel data

Implements DiPixel.

Definition at line 169 of file dicopxt.h.

template<class T>
OFBool DiColorPixelTemplate< T >::getPixelData (  void *  data,
const size_t  count
)  const [inline, virtual]
 

fill given memory block with pixel data (all three image planes, RGB).

Currently, the samples are always ordered by plane, thus the DICOM attribute 'PlanarConfiguration' has to be set to '1'.

Parameters:
data pointer to memory block (array of 8 or 16 bit values, OB/OW)
count number of T-size entries allocated in the 'data' array
Returns:
OFTrue if successful, OFFalse otherwise

Implements DiColorPixel.

Definition at line 193 of file dicopxt.h.

template<class T>
EP_Representation DiColorPixelTemplate< T >::getRepresentation (   )  const [inline, virtual]
 

get integer representation

Returns:
integer representation of the internally stored pixel data

Reimplemented from DiPixelRepresentationTemplate< T >.

Definition at line 149 of file dicopxt.h.

template<class T>
int DiColorPixelTemplate< T >::Init (  const void *  pixel  )  [inline, protected]
 

initialize internal memory

Parameters:
pixel pointer to input pixel data
Returns:
true (1) if successful, false (0) otherwise

Definition at line 524 of file dicopxt.h.

Referenced by DiColorCopyTemplate< T >::copy().

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5