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

Inheritance diagram for DiColorPixelTemplate< T >:

Public Member Functions
	DiColorPixelTemplate (const DiDocument docu, const DiInputPixel pixel, const Uint16 samples, EI_Status &status, const Uint16 sample_rate=0)
	constructor More...

virtual	~DiColorPixelTemplate ()
	destructor

EP_Representation	getRepresentation () const
	get integer representation More...

const void *	getData () const
	get pointer to internal array of pixel data. More...

void *	getDataPtr ()
	get pointer to internal array of pixel data. More...

void *	getDataArrayPtr ()
	get pointer to internal array of pixel data. More...

OFBool	getPixelData (void *data, const unsigned long count, const unsigned long fcount, const unsigned long frames, const int planar) const
	fill given memory block with pixel data (all three image planes, RGB) More...

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. More...

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). More...

Public Member Functions inherited from DiColorPixel
	DiColorPixel (const DiDocument docu, const DiInputPixel pixel, const Uint16 samples, EI_Status &status, const Uint16 sample_rate=0)
	constructor More...

virtual	~DiColorPixel ()
	destructor

int	getPlanes () const
	get number of planes More...

int	getPlanarConfiguration () const
	get planar configuration of the original pixel data More...

Public Member Functions inherited from DiPixel
	DiPixel (const unsigned long count, const unsigned long inputCount=0)
	constructor More...

virtual	~DiPixel ()
	destructor

unsigned long	getCount () const
	get number of pixels More...

unsigned long	getInputCount () const
	get number of pixels stored in the 'PixelData' element More...

Public Member Functions inherited from DiPixelRepresentationTemplate< T >
	DiPixelRepresentationTemplate ()
	default constructor

virtual	~DiPixelRepresentationTemplate ()
	destructor

int	isSigned () const
	check whether template type T is signed or not More...

Protected Member Functions
	DiColorPixelTemplate (const DiColorPixel *pixel, const unsigned long count)
	constructor More...

int	Init (const void *pixel)
	initialize internal memory More...

Protected Member Functions inherited from DiColorPixel
	DiColorPixel (const DiColorPixel *pixel, const unsigned long count)
	constructor More...

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

Protected Attributes inherited from DiColorPixel
int	PlanarConfiguration
	planar configuration of the original pixel data (0 = color-by-pixel, 1 = color-by-plane)

Protected Attributes inherited from DiPixel
unsigned long	Count
	number of pixels

unsigned long	InputCount
	number of pixels in the input buffer

Detailed Description

template<class T>
class DiColorPixelTemplate< T >

Template class to handle color pixel data.

Constructor & Destructor Documentation

◆ DiColorPixelTemplate() [1/2]

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)

◆ DiColorPixelTemplate() [2/2]

template<class T >

DiColorPixelTemplate< T >::DiColorPixelTemplate	(	const DiColorPixel *	pixel,
		const unsigned long	count
	)

inlineprotected

constructor

Parameters

pixel	pointer to intermediate color pixel data
count	number of pixels

Member Function Documentation

◆ createAWTBitmap()

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

inlinevirtual

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 occurred

Implements DiColorPixel.

◆ createDIB()

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

inlinevirtual

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 occurred

Implements DiColorPixel.

◆ getData()

template<class T >

const void* DiColorPixelTemplate< T >::getData ( ) const

inlinevirtual

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.

◆ getDataArrayPtr()

template<class T >

void* DiColorPixelTemplate< T >::getDataArrayPtr ( )

inlinevirtual

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.

◆ getDataPtr()

template<class T >

void* DiColorPixelTemplate< T >::getDataPtr ( )

inlinevirtual

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.

◆ getPixelData()

template<class T >

OFBool DiColorPixelTemplate< T >::getPixelData	(	void *	data,
		const unsigned long	count,
		const unsigned long	fcount,
		const unsigned long	frames,
		const int	planar
	)		const

inlinevirtual

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

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
fcount	number of pixels per frame
frames	total number of frames present in intermediate representation
planar	flag indicating whether data shall be stored color-by-pixel or color-by-plane

Returns: OFTrue if successful, OFFalse otherwise

Implements DiColorPixel.

◆ getRepresentation()

template<class T >

EP_Representation DiColorPixelTemplate< T >::getRepresentation ( ) const

inlinevirtual

get integer representation

Returns: integer representation of the internally stored pixel data

Reimplemented from DiPixelRepresentationTemplate< T >.

◆ Init()

template<class T >

int DiColorPixelTemplate< T >::Init ( const void * pixel )

inlineprotected

initialize internal memory

Parameters

pixel pointer to input pixel data

Returns: true (1) if successful, false (0) otherwise

Referenced by DiColorCopyTemplate< T >::copy(), DiColorFlipTemplate< T >::flip(), DiColorRotateTemplate< T >::rotate(), and DiColorScaleTemplate< T >::scale().

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

dcmimage/include/dcmtk/dcmimage/dicopxt.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class T> class DiColorPixelTemplate< T >

Constructor & Destructor Documentation

◆ DiColorPixelTemplate() [1/2]

◆ DiColorPixelTemplate() [2/2]

Member Function Documentation

◆ createAWTBitmap()

◆ createDIB()

◆ getData()

◆ getDataArrayPtr()

◆ getDataPtr()

◆ getPixelData()

◆ getRepresentation()

◆ Init()

template<class T>
class DiColorPixelTemplate< T >