DVPSVOIWindow Class Reference

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

List of all members.

Public Member Functions

 DVPSVOIWindow ()
 default constructor
 DVPSVOIWindow (const DVPSVOIWindow &copy)
 copy constructor
DVPSVOIWindow * clone ()
 clone method.
virtual ~DVPSVOIWindow ()
 destructor
OFCondition read (size_t idx, DcmDecimalString &wcenter, DcmDecimalString &wwidth, DcmLongString *expl=NULL)
 reads a VOI Window from DICOM elements.
void clear ()
 reset the object to initial state.
const char * getExplanation ()
 gets the Window center/width explanation for this VOI Window.
double getWindowCenter ()
 gets the Window Center of this VOI Window.
double getWindowWidth ()
 gets the Window Width of this VOI Window.
void setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
 sets a new log stream

Private Member Functions

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

Private Attributes

double windowCenter
double windowWidth
OFString windowCenterWidthExplanation
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 Window in a DICOM image.

Definition at line 48 of file dvpsvw.h.

Member Function Documentation

void DVPSVOIWindow::clear (   ) 
 

reset the object to initial state.

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

DVPSVOIWindow* DVPSVOIWindow::clone (   )  [inline]
 

clone method.

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

Definition at line 61 of file dvpsvw.h.

References DVPSVOIWindow().

const char* DVPSVOIWindow::getExplanation (   ) 
 

gets the Window center/width explanation for this VOI Window.

If no explanation exists, NULL is returned.

Returns:
Window explanation or NULL

double DVPSVOIWindow::getWindowCenter (   )  [inline]
 

gets the Window Center of this VOI Window.

Returns:
window center

Definition at line 92 of file dvpsvw.h.

References windowCenter.

double DVPSVOIWindow::getWindowWidth (   )  [inline]
 

gets the Window Width of this VOI Window.

Returns:
window width

Definition at line 97 of file dvpsvw.h.

References windowWidth.

OFCondition DVPSVOIWindow::read (  size_t  idx,
DcmDecimalString &  wcenter,
DcmDecimalString &  wwidth,
DcmLongString *  expl = NULL
) 
 

reads a VOI Window from DICOM elements.

The DICOM elements of the given VOI Window are copied to this object. If this method returns an error code, the object is in undefined state afterwards.

Parameters:
idx the index of the VOI window to be read, must be < wcenter.getVM()
wcenter the window center(s)
wwidth the window width(s). wwidth.getVM() must be == wcenter.getVM().
expl the window center/window width explanation. If omitted, explanation remains empty.
Returns:
EC_Normal if successful, an error code otherwise.

void DVPSVOIWindow::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