DiBaseLUT Class Reference

Base class to handle look-up tables. More...

Inheritance diagram for DiBaseLUT:


Public Member Functions
	DiBaseLUT (const Uint32 count=0, const Uint16 bits=0)
	constructor
virtual	~DiBaseLUT ()
	destructor
Uint32	getCount () const
	get number of LUT entries
Uint16	getBits () const
	get number of bits per entry
Uint32	getFirstEntry (const Uint32=0) const
	get index of first LUT entry.
Sint32	getFirstEntry (const Sint32) const
	get index of first LUT entry.
Uint32	getLastEntry (const Uint32=0) const
	get index of last LUT entry.
Sint32	getLastEntry (const Sint32) const
	get index of last LUT entry.
Uint16	getValue (const Uint16 pos) const
	get value of specified LUT entry
Uint16	getValue (const Uint32 pos) const
	get value of specified LUT entry.
Uint16	getValue (const Sint32 pos) const
	get value of specified LUT entry.
Uint16	getFirstValue () const
	get value of first LUT entry.
Uint16	getLastValue () const
	get value of last LUT entry.
const Uint16 *	getData () const
	get pointer to LUT data
Uint16	getMinValue () const
	get minimum value of the LUT.
Uint16	getMaxValue () const
	get maximum value of the LUT.
Uint32	getAbsMaxRange () const
	get absolute value range of the LUT entries.
int	isValid () const
	check whether LUT is valid
const char *	getExplanation () const
	get LUT explanation string
virtual OFBool	operator== (const DiBaseLUT &lut)
	compares current LUT with specified LUT
Protected Member Functions
	DiBaseLUT (Uint16 *buffer, const Uint32 count=0, const Uint16 bits=0)
	constructor
int	compare (const DiBaseLUT *lut)
	compares current LUT with specified LUT
Protected Attributes
Uint32	Count
	number of LUT entries
Uint16	FirstEntry
	first input value mapped (FIV)
Uint16	Bits
	number of bits per entry
Uint16	MinValue
	minimum LUT value
Uint16	MaxValue
	maximum LUT value
int	Valid
	status code, indicating whether LUT is valid
OFString	Explanation
	LUT explanation string.
const Uint16 *	Data
	pointer to lookup table data
Uint16 *	DataBuffer
	pointer to data buffer (will be deleted in the destructor)
Private Member Functions
	DiBaseLUT (const DiBaseLUT &)
DiBaseLUT &	operator= (const DiBaseLUT &)

Detailed Description

Base class to handle look-up tables.

Definition at line 55 of file dibaslut.h.

Constructor & Destructor Documentation

DiBaseLUT::DiBaseLUT	(	const Uint32	count = `0`,
		const Uint16	bits = `0`
	)

constructor

Parameters:

	count	number of LUT entries
	bits	number of bits per entry

DiBaseLUT::DiBaseLUT	(	Uint16 *	buffer,
		const Uint32	count = `0`,
		const Uint16	bits = `0`
	)			`[protected]`

constructor

Parameters:

	buffer	pointer to array with LUT entries
	count	number of LUT entries
	bits	number of bits per entry

Member Function Documentation

Uint32 DiBaseLUT::getCount ( ) const [inline]

get number of LUT entries

Returns:: number of LUT entries

Definition at line 76 of file dibaslut.h.

References Count.

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::sigmoid(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

Uint16 DiBaseLUT::getBits ( ) const [inline]

get number of bits per entry

Returns:: number of bits per entry

Definition at line 85 of file dibaslut.h.

References Bits.

Referenced by DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::sigmoid(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

Uint32 DiBaseLUT::getFirstEntry ( const Uint32 = 0 ) const [inline]

get index of first LUT entry.

First input value mapped (FIV) in LUT descriptor is US -> 16 bit unsigned. ... or the previous pixel transformation requires an unsigned LUT input value.

(#)param dummy (used to distinguish between signed and unsigned methods)

Returns:: index of first LUT entry

Definition at line 98 of file dibaslut.h.

References FirstEntry.

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut().

Sint32 DiBaseLUT::getFirstEntry ( const Sint32 ) const [inline]

get index of first LUT entry.

First input value mapped (FIV) in LUT descriptor is SS -> 16 bit signed. ... or the previous pixel transformation requires a signed LUT input value.

(#)param dummy (used to distinguish between signed and unsigned methods)

Returns:: index of first LUT entry

Definition at line 111 of file dibaslut.h.

References FirstEntry.

Uint32 DiBaseLUT::getLastEntry ( const Uint32 = 0 ) const [inline]

get index of last LUT entry.

FIV in LUT descriptor is US -> 16 bit unsigned. ... or the previous pixel transformation requires an unsigned LUT input value.

(#)param dummy (used to distinguish between signed and unsigned methods)

Returns:: index of last LUT entry

Definition at line 124 of file dibaslut.h.

References Count, and FirstEntry.

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut().

Sint32 DiBaseLUT::getLastEntry ( const Sint32 ) const [inline]

get index of last LUT entry.

FIV in LUT descriptor is SS -> 16 bit signed. ... or the previous pixel transformation requires a signed LUT input value.

(#)param dummy (used to distinguish between signed and unsigned methods)

Returns:: index of first LUT entry

Definition at line 137 of file dibaslut.h.

References Count, and FirstEntry.

Uint16 DiBaseLUT::getValue ( const Uint16 pos ) const [inline]

get value of specified LUT entry

Parameters:

pos

position in the LUT to be returned

Returns:: value of specified LUT entry

Definition at line 148 of file dibaslut.h.

References Data.

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::overlay(), DiMonoOutputPixelTemplate< T1, T2, T3 >::sigmoid(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

Uint16 DiBaseLUT::getValue ( const Uint32 pos ) const [inline]

get value of specified LUT entry.

FIV in LUT descriptor is US -> 16 bit unsigned. ... or the previous pixel transformation requires an unsigned LUT input value.

Parameters:

pos

position in the LUT to be returned

Returns:: value of specified LUT entry

Definition at line 161 of file dibaslut.h.

References Data, and FirstEntry.

Uint16 DiBaseLUT::getValue ( const Sint32 pos ) const [inline]

get value of specified LUT entry.

FIV in LUT descriptor is SS -> 16 bit signed. ... or the previous pixel transformation requires a signed LUT input value.

Parameters:

pos

position in the LUT to be returned

Returns:: value of specified LUT entry

Definition at line 174 of file dibaslut.h.

References Data, and FirstEntry.

Uint16 DiBaseLUT::getFirstValue ( ) const [inline]

get value of first LUT entry.

Returns:: value of first LUT entry

Definition at line 183 of file dibaslut.h.

References Data.

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut().

Uint16 DiBaseLUT::getLastValue ( ) const [inline]

get value of last LUT entry.

Returns:: value of last LUT entry

Definition at line 192 of file dibaslut.h.

References Count, and Data.

Referenced by DiMonoInputPixelTemplate< T1, T2, T3 >::modlut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut().

const Uint16* DiBaseLUT::getData ( ) const [inline]

get pointer to LUT data

Returns:: pointer to LUT data

Definition at line 201 of file dibaslut.h.

References Data.

Uint16 DiBaseLUT::getMinValue ( ) const [inline]

get minimum value of the LUT.

Returns:: minimum value of the LUT

Definition at line 210 of file dibaslut.h.

References MinValue.

Referenced by DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut().

Uint16 DiBaseLUT::getMaxValue ( ) const [inline]

get maximum value of the LUT.

Returns:: maximum value of the LUT

Definition at line 219 of file dibaslut.h.

References MaxValue.

Referenced by DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut().

Uint32 DiBaseLUT::getAbsMaxRange ( ) const [inline]

get absolute value range of the LUT entries.

The maximum value which could be stored with the specified bit depth is calculated.

Returns:: absolute range of LUT entries

Definition at line 229 of file dibaslut.h.

References Bits, and DicomImageClass::maxval().

int DiBaseLUT::isValid ( ) const [inline]

check whether LUT is valid

Returns:: status, true if valid, false otherwise

Definition at line 238 of file dibaslut.h.

References Valid.

Referenced by DiMonoOutputPixelTemplate< T1, T2, T3 >::createDisplayLUT(), DiMonoOutputPixelTemplate< T1, T2, T3 >::DiMonoOutputPixelTemplate(), DiMonoOutputPixelTemplate< T1, T2, T3 >::nowindow(), DiMonoOutputPixelTemplate< T1, T2, T3 >::overlay(), DiMonoOutputPixelTemplate< T1, T2, T3 >::sigmoid(), DiMonoOutputPixelTemplate< T1, T2, T3 >::voilut(), and DiMonoOutputPixelTemplate< T1, T2, T3 >::window().

const char* DiBaseLUT::getExplanation ( ) const [inline]

get LUT explanation string

Returns:: LUT explanation string if successful, NULL otherwise

Definition at line 247 of file dibaslut.h.

References OFString::c_str(), OFString::empty(), and Explanation.

Referenced by DiMonoModality::getExplanation(), and DiMonoImage::getPresentationLutExplanation().

virtual OFBool DiBaseLUT::operator== ( const DiBaseLUT & lut ) [virtual]

compares current LUT with specified LUT

Parameters:

lut

LUT to be compared with the current one

Returns:: OFTrue if LUTs are equal, OFFalse otherwise

Reimplemented in DiLookupTable.

int DiBaseLUT::compare ( const DiBaseLUT * lut ) [protected]

compares current LUT with specified LUT

Parameters:

lut

LUT to be compared with the current one

Returns:: true if LUTs are not equal (1 = invalid LUT, 2 = descriptor differs, 3 = data differs) false (0) otherwise

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

dcmimgle/include/dcmtk/dcmimgle/dibaslut.h

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1

DiBaseLUT Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation