DiDocument Class Reference

Interface class to DICOM data management (dcmdata). More...

Inheritance diagram for DiDocument:

List of all members.

Public Member Functions
	DiDocument (const char *filename, const unsigned long flags=0, const unsigned long fstart=0, const unsigned long fcount=0)
	constructor, open a DICOM file
	DiDocument (DcmObject *object, const E_TransferSyntax xfer, const unsigned long flags=0, const unsigned long fstart=0, const unsigned long fcount=0)
	constructor, use a given DcmObject
virtual	~DiDocument ()
	destructor
int	good () const
	check whether current document is valid
DcmObject *	getDicomObject () const
	get current DICOM object (dataset)
DcmDataset *	getDataset () const
	get current DICOM dataset
unsigned long	getFrameStart () const
	get first frame to be processed
unsigned long	getFrameCount () const
	get number of frames to be processed
unsigned long	getFlags () const
	get configuration flags
E_TransferSyntax	getTransferSyntax () const
	get transfer syntax of the DICOM dataset
const char *	getPhotometricInterpretation () const
	get photometric interpretation (color model).
DcmPixelData *	getPixelData () const
	get pixel data object
OFBool	isCompressed () const
	check whether pixel data only exist in compressed format
DcmElement *	search (const DcmTagKey &tag, DcmObject *obj=NULL) const
	search for given tag
int	search (const DcmTagKey &tag, DcmStack &stack) const
	search for given tag and put result(s) on a stack
unsigned long	getVM (const DcmTagKey &tag) const
	get value multiplicity (VM) of given tag
unsigned long	getValue (const DcmTagKey &tag, Uint16 &returnVal, const unsigned long pos=0, DcmObject *item=NULL, const OFBool allowSigned=OFFalse) const
	get value of given tag (Uint16)
unsigned long	getValue (const DcmTagKey &tag, Sint16 &returnVal, const unsigned long pos=0) const
	get value of given tag (Sint16)
unsigned long	getValue (const DcmTagKey &tag, Uint32 &returnVal, const unsigned long pos=0) const
	get value of given tag (Uint32)
unsigned long	getValue (const DcmTagKey &tag, Sint32 &returnVal, const unsigned long pos=0) const
	get value of given tag (Sint32)
unsigned long	getValue (const DcmTagKey &tag, double &returnVal, const unsigned long pos=0) const
	get value of given tag (double)
unsigned long	getValue (const DcmTagKey &tag, const Uint16 *&returnVal, DcmObject *item=NULL) const
	get value of given tag (Uint16 array)
unsigned long	getValue (const DcmTagKey &tag, const char *&returnVal, DcmObject *item=NULL) const
	get value of given tag (const char *)
unsigned long	getValue (const DcmTagKey &tag, OFString &returnVal, const unsigned long pos=0, DcmObject *item=NULL) const
	get value of given tag (OFString)
unsigned long	getSequence (const DcmTagKey &tag, DcmSequenceOfItems *&seq) const
	get sequence of given tag
Static Public Member Functions
static unsigned long	getElemValue (const DcmElement *elem, Uint16 &returnVal, const unsigned long pos=0, const OFBool allowSigned=OFFalse)
	get value of given element (Uint16)
static unsigned long	getElemValue (const DcmElement *elem, const Uint16 *&returnVal)
	get value of given element (Uint16 array)
static unsigned long	getElemValue (const DcmElement *elem, const char *&returnVal)
	get value of given element (const char *)
static unsigned long	getElemValue (const DcmElement *elem, OFString &returnVal, const unsigned long pos=0)
	get value of given element (OFString)
Protected Member Functions
void	convertPixelData ()
	convert pixel data to uncompressed representation (if required)
Private Member Functions
	DiDocument (const DiDocument &)
DiDocument &	operator= (const DiDocument &)
Private Attributes
DcmObject *	Object
	reference to DICOM dataset (in memory)
DcmFileFormat *	FileFormat
	reference to DICOM fileformat (read from file, maybe NULL)
DcmPixelData *	PixelData
	reference to pixel data object
E_TransferSyntax	Xfer
	transfer syntax used for reading the dataset
unsigned long	FrameStart
	first frame to be processed
unsigned long	FrameCount
	number of frames to be processed
unsigned long	Flags
	configuration flags
OFString	PhotometricInterpretation
	photometric interpretation (color model)

---

Detailed Description

Interface class to DICOM data management (dcmdata).

NB: This is an internal class of module dcmimgle/dcmimage. Please do not use it for accessing DICOM data structures. Instead use the classes and functions provided by dcmdata (e.g. class DcmFileFormat, DcmItem).

Definition at line 66 of file didocu.h.

---

Constructor & Destructor Documentation

DiDocument::DiDocument	(	const char *	filename,
		const unsigned long	flags = 0,
		const unsigned long	fstart = 0,
		const unsigned long	fcount = 0
	)

constructor, open a DICOM file

Parameters:

	filename	the DICOM file
	flags	configuration flags (only stored for later use)
	fstart	first frame to be processed (only stored for later use)
	fcount	number of frames (only stored for later use)

DiDocument::DiDocument	(	DcmObject *	object,
		const E_TransferSyntax	xfer,
		const unsigned long	flags = 0,
		const unsigned long	fstart = 0,
		const unsigned long	fcount = 0
	)

constructor, use a given DcmObject

Parameters:

	object	pointer to DICOM data structures
	xfer	transfer syntax
	flags	configuration flags (only stored for later use)
	fstart	first frame to be processed (only stored for later use)
	fcount	number of frames (only stored for later use)

---

Member Function Documentation

int DiDocument::good

(

)

const [inline]

check whether current document is valid

Returns:

status, true if successful, false otherwise

Definition at line 106 of file didocu.h.

References Object.

DcmObject* DiDocument::getDicomObject

(

)

const [inline]

get current DICOM object (dataset)

Returns:

pointer to DICOM object

Definition at line 115 of file didocu.h.

References Object.

DcmDataset* DiDocument::getDataset

(

void

)

const [inline]

get current DICOM dataset

Returns:

pointer to DICOM dataset

Definition at line 124 of file didocu.h.

References Object.

Referenced by DiInputPixelTemplate< T1, T2 >::convert().

unsigned long DiDocument::getFrameStart

(

)

const [inline]

get first frame to be processed

Returns:

first frame to be processed

Definition at line 133 of file didocu.h.

References FrameStart.

unsigned long DiDocument::getFrameCount

(

)

const [inline]

get number of frames to be processed

Returns:

number of frames to be processed

Definition at line 142 of file didocu.h.

References FrameCount.

unsigned long DiDocument::getFlags

(

)

const [inline]

get configuration flags

Returns:

configuration flags

Definition at line 151 of file didocu.h.

References Flags.

Referenced by DiInputPixelTemplate< T1, T2 >::convert().

E_TransferSyntax DiDocument::getTransferSyntax

(

)

const [inline]

get transfer syntax of the DICOM dataset

Returns:

transfer syntax

Definition at line 160 of file didocu.h.

References Xfer.

const char* DiDocument::getPhotometricInterpretation

(

)

const [inline]

get photometric interpretation (color model).

Please note that this is the color model of the decompressed image which might deviate from the color model of the original compressed image.

Returns:

photometric interpretation of the DICOM object

Definition at line 171 of file didocu.h.

References OFString::c_str(), and PhotometricInterpretation.

Referenced by DiInputPixelTemplate< T1, T2 >::convert().

DcmPixelData* DiDocument::getPixelData

(

)

const [inline]

get pixel data object

Returns:

reference to pixel data object (might be NULL)

Definition at line 180 of file didocu.h.

References PixelData.

Referenced by DiInputPixelTemplate< T1, T2 >::convert(), and DiInputPixelTemplate< T1, T2 >::DiInputPixelTemplate().

OFBool DiDocument::isCompressed

(

)

const [inline]

check whether pixel data only exist in compressed format

Returns:

true if pixel data is compressed, false if an uncompressed version exists

Definition at line 189 of file didocu.h.

References Xfer.

DcmElement* DiDocument::search	(	const DcmTagKey &	tag,
		DcmObject *	obj = NULL
	)			const

search for given tag

Parameters:

	tag	tag to search for
	obj	element in the dataset where the search should start (default: root)

Returns:

pointer to element if successful, NULL otherwise

int DiDocument::search	(	const DcmTagKey &	tag,
		DcmStack &	stack
	)			const

search for given tag and put result(s) on a stack

Parameters:

	tag	tag to search for
	stack	stack where the result(s) should be stored

Returns:

status, true if successful, false otherwise

unsigned long DiDocument::getVM

(

const DcmTagKey &

tag

)

const

get value multiplicity (VM) of given tag

Parameters:

tag

tag to be searched

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		Uint16 &	returnVal,
		const unsigned long	pos = 0,
		DcmObject *	item = NULL,
		const OFBool	allowSigned = OFFalse
	)			const

get value of given tag (Uint16)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)
	item	element in the dataset where the search should start (default: root)
	allowSigned	also allow signed value (Sint16) if true

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		Sint16 &	returnVal,
		const unsigned long	pos = 0
	)			const

get value of given tag (Sint16)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		Uint32 &	returnVal,
		const unsigned long	pos = 0
	)			const

get value of given tag (Uint32)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		Sint32 &	returnVal,
		const unsigned long	pos = 0
	)			const

get value of given tag (Sint32)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		double &	returnVal,
		const unsigned long	pos = 0
	)			const

get value of given tag (double)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		const Uint16 *&	returnVal,
		DcmObject *	item = NULL
	)			const

get value of given tag (Uint16 array)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	item	element in the dataset where the search should start (default: root)

Returns:

VM / number of values if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		const char *&	returnVal,
		DcmObject *	item = NULL
	)			const

get value of given tag (const char *)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	item	element in the dataset where the search should start (default: root)

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getValue	(	const DcmTagKey &	tag,
		OFString &	returnVal,
		const unsigned long	pos = 0,
		DcmObject *	item = NULL
	)			const

get value of given tag (OFString)

Parameters:

	tag	tag to search for
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)
	item	element in the dataset where the search should start (default: root)

Returns:

VM if successful, 0 otherwise

unsigned long DiDocument::getSequence	(	const DcmTagKey &	tag,
		DcmSequenceOfItems *&	seq
	)			const

get sequence of given tag

Parameters:

	tag	tag to search for
	seq	reference to the storage area for the resulting value

Returns:

cardinality if successful, 0 otherwise

static unsigned long DiDocument::getElemValue	(	const DcmElement *	elem,
		Uint16 &	returnVal,
		const unsigned long	pos = 0,
		const OFBool	allowSigned = OFFalse
	)			[static]

get value of given element (Uint16)

Parameters:

	elem	element where the value is stored
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)
	allowSigned	also allow signed value (Sint16) if true

Returns:

VM if successful, 0 otherwise

static unsigned long DiDocument::getElemValue	(	const DcmElement *	elem,
		const Uint16 *&	returnVal
	)			[static]

get value of given element (Uint16 array)

Parameters:

	elem	element where the value is stored
	returnVal	reference to the storage area for the resulting value

Returns:

VM / number of values if successful, 0 otherwise

static unsigned long DiDocument::getElemValue	(	const DcmElement *	elem,
		const char *&	returnVal
	)			[static]

get value of given element (const char *)

Parameters:

	elem	element where the value is stored
	returnVal	reference to the storage area for the resulting value

Returns:

VM if successful, 0 otherwise

static unsigned long DiDocument::getElemValue	(	const DcmElement *	elem,
		OFString &	returnVal,
		const unsigned long	pos = 0
	)			[static]

get value of given element (OFString)

Parameters:

	elem	element where the value is stored
	returnVal	reference to the storage area for the resulting value
	pos	position in muti-valued elements (starting with 0)

Returns:

VM if successful, 0 otherwise

---

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

• dcmimgle/include/dcmtk/dcmimgle/didocu.h

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1