DVPSVOILUT Class Reference

the representation of one VOI LUT in a DICOM image. More...

List of all members.

Public Member Functions

 DVPSVOILUT ()
 default constructor
 DVPSVOILUT (const DVPSVOILUT &copy)
 copy constructor
DVPSVOILUT * clone ()
 clone method.
virtual ~DVPSVOILUT ()
 destructor
OFCondition read (DcmItem &dset)
 reads a VOI LUT from a DICOM dataset.
void clear ()
 resets the object to initial state.
const char * getExplanation ()
 gets the LUT explanation for this VOI LUT.
OFCondition assign (DVPSSoftcopyVOI &voi)
 assigns the contents of this VOI LUT to the references passed as parameters.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream

Private Member Functions

DVPSVOILUT & operator= (const DVPSVOILUT &)
 private undefined assignment operator

Private Attributes

DcmUnsignedShort voiLUTDescriptor
 Module=VOI_LUT, VR=xs, VM=3, Type 1c.
DcmLongString voiLUTExplanation
 Module=VOI_LUT, VR=LO, VM=1, Type 3.
DcmUnsignedShort voiLUTData
 Module=VOI_LUT, VR=xs, VM=1-n, Type 1c.
OFConsole * logstream
 output stream for error messages, never NULL
OFBool verboseMode
 flag indicating whether we're operating in verbose mode
OFBool debugMode
 flag indicating whether we're operating in debug mode

Detailed Description

the representation of one VOI LUT in a DICOM image.

Definition at line 47 of file dvpsvl.h.

Member Function Documentation

OFCondition DVPSVOILUT::assign (  DVPSSoftcopyVOI &  voi  ) 
 

assigns the contents of this VOI LUT to the references passed as parameters.

Parameters:
reference to the Softcopy VOI in which the LUT is stored.

void DVPSVOILUT::clear (   ) 
 

resets the object to initial state.

After this call, the object is in the same state as after creation with the default constructor.

DVPSVOILUT* DVPSVOILUT::clone (   )  [inline]
 

clone method.

Returns:
a pointer to a new DVPSVOILUT object containing a copy of this object.

Definition at line 60 of file dvpsvl.h.

References DVPSVOILUT().

const char* DVPSVOILUT::getExplanation (   ) 
 

gets the LUT explanation for this VOI LUT.

If no explanation exists, NULL is returned.

Returns:
LUT explanation or NULL

OFCondition DVPSVOILUT::read (  DcmItem &  dset  ) 
 

reads a VOI LUT from a DICOM dataset.

The DICOM elements of the VOI LUT item are copied from the dataset to this object. The completeness of the item (presence of all required elements, value multiplicity) is checked. If this method returns an error code, the object is in undefined state afterwards.

Parameters:
dset the item of the VOI LUT Sequence from which the data is to be read
Returns:
EC_Normal if successful, an error code otherwise.

void DVPSVOILUT::setLog (  OFConsole *  stream,
OFBool  verbMode,
OFBool  dbgMode
) 
 

sets a new log stream

Parameters:
stream new log stream, NULL for default logstream
verbMode verbose mode flag
dbgMode debug mode flag

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