DVPSCurve Class Reference

the representation of one Curve in a DICOM image. More...

List of all members.

Public Member Functions
	DVPSCurve ()
	default constructor
	DVPSCurve (const DVPSCurve &copy)
	copy constructor
DVPSCurve *	clone ()
	clone method.
virtual	~DVPSCurve ()
	destructor
OFCondition	read (DcmItem &dset, Uint8 group)
	reads a curve from a DICOM dataset.
Uint8	getCurveGroup ()
	get group number of curve repeating group managed by this object.
size_t	getNumberOfPoints ()
	gets the number of points in the curve.
DVPSCurveType	getTypeOfData ()
	gets the type of data in the curve (ROI or POLY).
OFCondition	getPoint (size_t idx, double &x, double &y)
	gets one point from the curve data.
const char *	getCurveDescription ()
	gets the curve description string if present.
const char *	getCurveLabel ()
	gets the curve label string if present.
const char *	getCurveAxisUnitsX ()
	gets the curve axis units string for the X dimension if present.
const char *	getCurveAxisUnitsY ()
	gets the curve axis units string for the Y dimension if present.
void	setLog (OFConsole *stream, OFBool verbMode, OFBool dbgMode)
	sets a new log stream
Private Member Functions
DVPSCurve &	operator= (const DVPSCurve &)
	private undefined assignment operator
Private Attributes
Uint8	curveGroup
	lower byte of the curve repeating group managed by this object
size_t	numberOfPoints
	number of points in curve data
DVPSCurveType	typeOfData
	type of curve data
double *	curveData
	curve data, converted to double
OFString	curveDescription
	curve data description if present
OFString	curveLabel
	curve label if present
OFString	axisUnitsX
	axis units X if present
OFString	axisUnitsY
	axis units Y if present
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 Curve in a DICOM image.

Definition at line 49 of file dvpscu.h.

---

Member Function Documentation

DVPSCurve* DVPSCurve::clone (   )  [inline]

clone method. Returns: a pointer to a new DVPSCurve object containing a copy of this object. Definition at line 62 of file dvpscu.h. References DVPSCurve().

const char* DVPSCurve::getCurveAxisUnitsX (   )  [inline]

gets the curve axis units string for the X dimension if present. If the string is absent, this method returns NULL or an empty string. Returns: curve description Definition at line 118 of file dvpscu.h. References axisUnitsX, and OFString::c_str().

const char* DVPSCurve::getCurveAxisUnitsY (   )  [inline]

gets the curve axis units string for the Y dimension if present. If the string is absent, this method returns NULL or an empty string. Returns: curve description Definition at line 124 of file dvpscu.h. References axisUnitsY, and OFString::c_str().

const char* DVPSCurve::getCurveDescription (   )  [inline]

gets the curve description string if present. If the description string is absent, this method returns NULL or an empty string. Returns: curve description Definition at line 106 of file dvpscu.h. References OFString::c_str(), and curveDescription.

Uint8 DVPSCurve::getCurveGroup (   )  [inline]

get group number of curve repeating group managed by this object. Returns: the lower byte of the curve group Definition at line 82 of file dvpscu.h. References curveGroup.

const char* DVPSCurve::getCurveLabel (   )  [inline]

gets the curve label string if present. If the label string is absent, this method returns NULL or an empty string. Returns: curve label Definition at line 112 of file dvpscu.h. References OFString::c_str(), and curveLabel.

size_t DVPSCurve::getNumberOfPoints (   )  [inline]

gets the number of points in the curve. Returns: number of points Definition at line 87 of file dvpscu.h. References numberOfPoints.

OFCondition DVPSCurve::getPoint (  size_t  idx, double &  x, double &  y )

gets one point from the curve data. Parameters: idx  index of the curve point, must be < getNumberOfPoints(); x  upon success the x value of the point is returned in this parameter y  upon success the y value of the point is returned in this parameter Returns: EC_Normal if successful, an error code otherwise.

DVPSCurveType DVPSCurve::getTypeOfData (   )  [inline]

gets the type of data in the curve (ROI or POLY). Returns: type of data in curve Definition at line 92 of file dvpscu.h. References typeOfData.

OFCondition DVPSCurve::read (  DcmItem &  dset, Uint8  group )

reads a curve from a DICOM dataset. The DICOM elements of the Graphic Object item are copied from the dataset to this object. The completeness of the curve (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 DICOM dataset from which the data is to be read group  lower byte of the curve repeating group to be read Returns: EC_Normal if successful, an error code otherwise.

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

• dcmpstat/include/dcmtk/dcmpstat/dvpscu.h

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5