DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | List of all members
DVPSVOIWindow Class Reference

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

Public Member Functions

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

Private Member Functions

DVPSVOIWindowoperator= (const DVPSVOIWindow &)
 private undefined assignment operator
 

Detailed Description

the representation of one VOI Window in a DICOM image.

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.
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
double DVPSVOIWindow::getWindowWidth ( )
inline

gets the Window Width of this VOI Window.

Returns
window width
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
idxthe index of the VOI window to be read, must be < wcenter.getVM()
wcenterthe window center(s)
wwidththe window width(s). wwidth.getVM() must be == wcenter.getVM().
explthe window center/window width explanation. If omitted, explanation remains empty.
Returns
EC_Normal if successful, an error code otherwise.

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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8