OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DVPSVOIWindow Class Reference

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

Collaboration diagram for DVPSVOIWindow:
[legend]

Public Member Functions

 DVPSVOIWindow ()
 default constructor
 
 DVPSVOIWindow (const DVPSVOIWindow &copy)
 copy constructor
 
DVPSVOIWindowclone ()
 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.
 

Private Member Functions

DVPSVOIWindowoperator= (const DVPSVOIWindow &)
 private undefined assignment operator
 

Private Attributes

double windowCenter
 
double windowWidth
 
OFString windowCenterWidthExplanation
 

Detailed Description

the representation of one VOI Window in a DICOM image.

Definition at line 43 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 56 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 87 of file dvpsvw.h.

double DVPSVOIWindow::getWindowWidth ( )
inline

gets the Window Width of this VOI Window.

Returns
window width

Definition at line 92 of file dvpsvw.h.

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 Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2