OFFIS DCMTK: DVPSCurve Class Reference

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.
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

Detailed Description

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 57 of file dvpscu.h.

References DVPSCurve().

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.

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 77 of file dvpscu.h.

References curveGroup.

size_t DVPSCurve::getNumberOfPoints ( ) [inline]

gets the number of points in the curve.

Returns:: number of points

Definition at line 82 of file dvpscu.h.

References numberOfPoints.

DVPSCurveType DVPSCurve::getTypeOfData ( ) [inline]

gets the type of data in the curve (ROI or POLY).

Returns:: type of data in curve

Definition at line 87 of file dvpscu.h.

References typeOfData.

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.

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 101 of file dvpscu.h.

References OFString::c_str(), and curveDescription.

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 107 of file dvpscu.h.

References OFString::c_str(), and curveLabel.

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 113 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 119 of file dvpscu.h.

References axisUnitsY, and OFString::c_str().

DVPSCurve Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation