The class DcmPixelData stores different pixel representations identified by a type (the transfer syntax) and some representation parameters The three unencapsulated transfer syntaxes belong to the same pixel representation. More...

Inheritance diagram for DcmPixelData:

Public Member Functions
	DcmPixelData (const DcmTag &tag, const Uint32 len=0)
	constructor
	DcmPixelData (const DcmPixelData &pixelData)
	copy constructor
virtual	~DcmPixelData ()
	destructor
DcmPixelData &	operator= (const DcmPixelData &obj)
	copy assignment operator
virtual DcmObject *	clone () const
	clone method
virtual OFCondition	copyFrom (const DcmObject &rhs)
	Virtual object copying.
virtual OFCondition	setVR (DcmEVR vr)
	set/change the current value representation of the uncompressed image representation, if any
virtual DcmEVR	ident () const
	return identifier for this class.
virtual void	print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char pixelFileName=NULL, size_t pixelCounter=NULL)
	print all elements of the item to a stream
virtual OFBool	canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer)
	tests if it is possible to write a specific representation Only existing representations are considered, since this method does not create a representation.
virtual Uint32	calcElementLength (const E_TransferSyntax xfer, const E_EncodingType enctype)
	returns length of representation conforming to the transfer syntax with tag, vr, ...
virtual Uint32	getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)
	returns length of representation value field conforming to given transfer syntax.
virtual void	transferInit ()
	initialize the transfer state of this object.
virtual OFCondition	read (DcmInputStream &inStream, const E_TransferSyntax ixfer, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength)
	This function reads the data value of a pixel data attribute which is captured in the input stream and captures this information in this.
virtual OFCondition	write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	writes a representation conforming to the transfer syntax It does not create a representation.
virtual OFCondition	writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
	write object in XML format
virtual OFCondition	writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	special write method for creation of digital signatures
virtual OFCondition	loadAllDataIntoMemory (void)
	this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory.
virtual void	transferEnd ()
	finalize the transfer state of this object.
OFBool	canChooseRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam)
	test if it is possible to choose the representation in the parameters
OFCondition	chooseRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam, DcmStack &stack)
	choose a specific representation.
void	putOriginalRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter repParam, DcmPixelSequence pixSeq)
	Inserts an original encapsulated representation.
virtual OFCondition	putUint8Array (const Uint8 *byteValue, const unsigned long length)
	insert an original unencapsulated representation.
virtual OFCondition	putUint16Array (const Uint16 *wordValue, const unsigned long length)
	insert an original unencapsulated representation.
virtual OFCondition	createUint8Array (const Uint32 numBytes, Uint8 *&bytes)
	create an empty Uint8 array of given number of words and set it
virtual OFCondition	createUint16Array (const Uint32 numWords, Uint16 *&words)
	create an empty Uint16 array of given number of words and set it
virtual OFCondition	createValueFromTempFile (DcmInputStreamFactory *factory, const Uint32 length, const E_ByteOrder byteOrder)
	replace the attribute value with the content of the given temporary file.
OFCondition	getEncapsulatedRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter repParam, DcmPixelSequence &pixSeq)
	get a specific exisiting Representation, creates no representation if repParam is NULL, then the representation conforming to the default presentationParameters (defined with the codec) is returned.
void	getOriginalRepresentationKey (E_TransferSyntax &repType, const DcmRepresentationParameter *&repParam)
	returns the representation identification (key) consisting of representation type and parameter of the original representation
void	getCurrentRepresentationKey (E_TransferSyntax &repType, const DcmRepresentationParameter *&repParam)
	returns the representation identification (key) consisting of representation type and parameter of the current representation
OFCondition	setCurrentRepresentationParameter (const DcmRepresentationParameter *repParam)
	sets the representation identification parameter of the current representation
OFBool	hasRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam=NULL)
	returns if a specific conforming representation exists.
OFCondition	removeRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam)
	delete a representation.
void	removeAllButOriginalRepresentations ()
	removes all but the original representation
void	removeAllButCurrentRepresentations ()
	removes all but the current representation Makes the current representation original
OFCondition	removeOriginalRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam)
	delete original representation and set new original representation.
void	setNonEncapsulationFlag (OFBool flag)
	set or clear the flag that indicates that this pixel data element will be written in uncompressed (defined length) format even if the dataset itself is written in a compressed syntax where pixel data is normally written in encapsulated (undefined length) format.
virtual OFCondition	getUncompressedFrame (DcmItem dataset, Uint32 frameNo, Uint32 &startFragment, void buffer, Uint32 bufSize, OFString &decompressedColorModel, DcmFileCache *cache=NULL)
	access single frame without decompressing or loading a complete multi-frame object.
virtual OFCondition	getDecompressedColorModel (DcmItem *dataset, OFString &decompressedColorModel)
	determine color model of the decompressed image
Private Member Functions
void	clearRepresentationList (DcmRepresentationListIterator leaveInList)
	This function removes all pixel representations from the list of pixel representations except the one which was passed.
OFCondition	findConformingEncapsulatedRepresentation (const DcmXfer &repType, const DcmRepresentationParameter *repParam, DcmRepresentationListIterator &result)
	find a conforming representation in the list of encapsulated representations
OFCondition	findRepresentationEntry (const DcmRepresentationEntry &findEntry, DcmRepresentationListIterator &result)
	find a representation entry and return an iterator to the found entry or the next element in the list.
DcmRepresentationListIterator	insertRepresentationEntry (DcmRepresentationEntry *repEntry)
	insert or replace a representation entry in the list
OFCondition	decode (const DcmXfer &fromType, const DcmRepresentationParameter fromParam, DcmPixelSequence fromPixSeq, DcmStack &pixelStack)
	decode representation to unencapsulated format
OFCondition	encode (const DcmXfer &fromType, const DcmRepresentationParameter fromParam, DcmPixelSequence fromPixSeq, const DcmXfer &toType, const DcmRepresentationParameter *toParam, DcmStack &pixelStack)
	encode to encapsulated format
void	recalcVR ()
	set the current VR, which is always OB if the currently selected pixel representation is compressed, and may be OB or OW for uncompressed.
Private Attributes
DcmRepresentationList	repList
	List of representations of pixel data.
DcmRepresentationListIterator	repListEnd
	Iterator to the last dummy element in representation lis.
DcmRepresentationListIterator	original
	Iterator to the original representation.
DcmRepresentationListIterator	current
	current list element for some operations
OFBool	existUnencapsulated
	shows if an unecapsulated representation is stored
OFBool	alwaysUnencapsulated
	this flag indicates that this pixel data element will be written in uncompressed (defined length) format even if the dataset itself is written in a compressed syntax where pixel data is normally written in encapsulated (undefined length) format.
DcmEVR	unencapsulatedVR
	value representation of unencapsulated data
DcmPixelSequence *	pixelSeqForWrite
	in write function: pointer to current pixel sequence
Friends
class	DcmRepresentationEntry

Detailed Description

The class DcmPixelData stores different pixel representations identified by a type (the transfer syntax) and some representation parameters The three unencapsulated transfer syntaxes belong to the same pixel representation.

A type (or transfer syntax) conforms to a representation if the type and the representation type are equal or both are unencapsulated. If this is valid for the representation read or set by chooseRepresentation then this representation is the conforming representation. else a representation with the default parameter set defined in the codec is the conforming representation.

Constructor & Destructor Documentation

DcmPixelData::DcmPixelData	(	const DcmTag &	tag,
		const Uint32	len = `0`
	)

constructor

Parameters:

tag	attribute tag
len	length of the attribute value

DcmPixelData::DcmPixelData ( const DcmPixelData & pixelData )

copy constructor

Parameters:

pixelData element to be copied

Member Function Documentation

virtual Uint32 DcmPixelData::calcElementLength	(	const E_TransferSyntax	xfer,
		const E_EncodingType	enctype
	)		`[virtual]`

returns length of representation conforming to the transfer syntax with tag, vr, ...

It does not create a representation. If no conforming representation exists an error code is set and 0 returned.

Reimplemented from DcmElement.

OFCondition DcmPixelData::chooseRepresentation	(	const E_TransferSyntax	repType,
		const DcmRepresentationParameter *	repParam,
		DcmStack &	stack
	)

choose a specific representation.

if representation does not exist it is created (if possible). if repParam is zero, a representation is chosen or created that is equal to the default representation parameters

void DcmPixelData::clearRepresentationList ( DcmRepresentationListIterator leaveInList ) [private]

This function removes all pixel representations from the list of pixel representations except the one which was passed.

Note that if parameter leaveInList equals repListEnd, all representations will be removed from the list.

Parameters:

leaveInList Iterator to a representation which shall not be removed from the list of representations.

virtual DcmObject* DcmPixelData::clone ( ) const [inline, virtual]

clone method

Returns:: deep copy of this object

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::copyFrom ( const DcmObject & rhs ) [virtual]

Virtual object copying.

This method can be used for DcmObject and derived classes to get a deep copy of an object. Internally the assignment operator is called if the given DcmObject parameter is of the same type as "this" object instance. If not, an error is returned. This function permits copying an object by value in a virtual way which therefore is different to just calling the assignment operator of DcmElement which could result in slicing the object.

Parameters:

rhs	- [in] The instance to copy from. Has to be of the same class type as "this" object

Returns:: EC_Normal if copying was successful, error otherwise

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::createValueFromTempFile	(	DcmInputStreamFactory *	factory,
		const Uint32	length,
		const E_ByteOrder	byteOrder
	)		`[virtual]`

replace the attribute value with the content of the given temporary file.

The temporary file is not opened/loaded until the attribute value is accessed, very much like large attributes that remain in file during a read operation.

Parameters:

factory	a factory object that is able to create an input stream to the temporary file at the right location.
length	attribute value length, in bytes. Must be even length. The length is not checked against the real length of the temporary file, which might be written or completed after the call to this method.
byteOrder	byte order in the temporary file

Returns:: EC_Normal upon success, an error code otherwise.

Reimplemented from DcmElement.

OFCondition DcmPixelData::findRepresentationEntry	(	const DcmRepresentationEntry &	findEntry,
		DcmRepresentationListIterator &	result
	)		`[private]`

find a representation entry and return an iterator to the found entry or the next element in the list.

The condition returned can be EC_Normal if such an entry is found or EC_RepresentationNotFound. The pixSeq attribute in findEntry can be NULL, it is not needed for the find operation!

virtual OFCondition DcmPixelData::getDecompressedColorModel	(	DcmItem *	dataset,
		OFString &	decompressedColorModel
	)		`[virtual]`

determine color model of the decompressed image

Parameters:

dataset	pointer to DICOM dataset in which this pixel data object is located. Used to access photometric interpretation.
decompressedColorModel	upon successful return, the color model of the decompressed image (which may be different from the one used in the compressed images) is returned in this parameter

Returns:: EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual Uint32 DcmPixelData::getLength	(	const E_TransferSyntax	xfer = `EXS_LittleEndianImplicit`,
		const E_EncodingType	enctype = `EET_UndefinedLength`
	)		`[virtual]`

returns length of representation value field conforming to given transfer syntax.

It does not create a representation. If no conforming representation exists, an error code is set and 0 returned.

Reimplemented from DcmElement.

virtual OFCondition DcmPixelData::getUncompressedFrame	(	DcmItem *	dataset,
		Uint32	frameNo,
		Uint32 &	startFragment,
		void *	buffer,
		Uint32	bufSize,
		OFString &	decompressedColorModel,
		DcmFileCache *	cache = `NULL`
	)		`[virtual]`

access single frame without decompressing or loading a complete multi-frame object.

The frame is copied into the buffer passed by the caller which must be large enough to contain a complete frame.

Parameters:

dataset	pointer to DICOM dataset in which this pixel data object is located. Used to access rows, columns, samples per pixel etc.
frameNo	number of frame, starting with 0 for the first frame.
startFragment	index of the compressed fragment that contains all or the first part of the compressed bitstream for the given frameNo. Upon successful return this parameter is updated to contain the index of the first compressed fragment of the next frame. When unknown, zero should be passed. In this case the decompression algorithm will try to determine the index by itself, which will always work if frames are decompressed in increasing order from first to last, but may fail if frames are decompressed in random order, multiple fragments per frame and multiple frames are present in the dataset, and the offset table is empty.
buffer	pointer to buffer allocated by the caller. The buffer must be large enough for one frame of this image.
bufSize	size of buffer, in bytes. This number must be even so that the data can properly be converted to a different endianness.
decompressedColorModel	upon successful return, the color model of the decompressed image (which may be different from the one used in the compressed images) is returned in this parameter.
cache	file cache object that may be passed to multiple subsequent calls to this method for the same file; the file cache will then keep a file handle open, thus improving performance. Optional, may be NULL

Returns:: EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual DcmEVR DcmPixelData::ident ( void ) const [inline, virtual]

return identifier for this class.

Every class derived from this class returns a unique value of type enum DcmEVR for this call. This is used as a "poor man's RTTI" to correctly identify instances derived from this class even on compilers not supporting RTTI.

Returns:: type identifier of this class

Reimplemented from DcmOtherByteOtherWord.

virtual OFCondition DcmPixelData::loadAllDataIntoMemory ( void ) [virtual]

this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory.

After a call to this method, the file from which a dataset was read may safely be deleted or replaced. For large files, this method may obviously allocate large amounts of memory.

Returns:: EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

DcmPixelData& DcmPixelData::operator= ( const DcmPixelData & obj )

copy assignment operator

Parameters:

obj	element to be copied

virtual void DcmPixelData::print	(	STD_NAMESPACE ostream &	out,
		const size_t	flags = `0`,
		const int	level = `0`,
		const char *	pixelFileName = `NULL`,
		size_t *	pixelCounter = `NULL`
	)		`[virtual]`

print all elements of the item to a stream

Parameters:

out	output stream
flags	optional flag used to customize the output (see DCMTypes::PF_xxx)
level	current level of nested items. Used for indentation.
pixelFileName	optional filename used to write the raw pixel data file
pixelCounter	optional counter used for automatic pixel data filename creation

Reimplemented from DcmOtherByteOtherWord.

void DcmPixelData::putOriginalRepresentation	(	const E_TransferSyntax	repType,
		const DcmRepresentationParameter *	repParam,
		DcmPixelSequence *	pixSeq
	)

Inserts an original encapsulated representation.

current and original representations are changed, all old representations are deleted

virtual OFCondition DcmPixelData::putUint16Array	(	const Uint16 *	wordValue,
		const unsigned long	length
	)		`[virtual]`

insert an original unencapsulated representation.

current and original representations are changed, all old representations are deleted. The array data is copied.

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::putUint8Array	(	const Uint8 *	byteValue,
		const unsigned long	length
	)		`[virtual]`

insert an original unencapsulated representation.

current and original representations are changed, all old representations are deleted. The array data is copied.

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::read	(	DcmInputStream &	inStream,
		const E_TransferSyntax	ixfer,
		const E_GrpLenEncoding	glenc = `EGL_noChange`,
		const Uint32	maxReadLength = `DCM_MaxReadLength`
	)		`[virtual]`

This function reads the data value of a pixel data attribute which is captured in the input stream and captures this information in this.

This function takes into account, if the pixel data is captured in native (uncompressed) or encapsulated (compressed) format.

Parameters:

inStream	The stream which contains the information.
ixfer	The transfer syntax which was used to encode the information in inStream.
glenc	Encoding type for group length; specifies what will be done with group length tags.
maxReadLength	Maximum read length for reading an attribute value.

Returns:: status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmPolymorphOBOW.

OFCondition DcmPixelData::removeOriginalRepresentation	(	const E_TransferSyntax	repType,
		const DcmRepresentationParameter *	repParam
	)

delete original representation and set new original representation.

If the new representation does not exist, the original one is not deleted and an error code returns

OFCondition DcmPixelData::removeRepresentation	(	const E_TransferSyntax	repType,
		const DcmRepresentationParameter *	repParam
	)

delete a representation.

It is not possible to delete the original representation with this method

void DcmPixelData::setNonEncapsulationFlag ( OFBool flag )

set or clear the flag that indicates that this pixel data element will be written in uncompressed (defined length) format even if the dataset itself is written in a compressed syntax where pixel data is normally written in encapsulated (undefined length) format.

By default this flag is false, unless the dataset was read in an encapsulated transfer syntax and this pixel data element was already present in uncompressed format. This flag should never be enabled for pixel data elements on the main dataset level, only for pixel data elements within the icon image sequence or some other "private" place.

Parameters:

flag	new value of flag

virtual OFCondition DcmPixelData::setVR ( DcmEVR vr ) [virtual]

set/change the current value representation of the uncompressed image representation, if any

Parameters:

vr	new value representation to be set. All VRs except for OW (Other Word String) are treated as 8 bit data (OB). This is particularily useful for unknown (UN) or unsupported VRs.

Returns:: status status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

virtual void DcmPixelData::transferEnd ( ) [virtual]

finalize the transfer state of this object.

This method must be called when reading/writing this object from/to a stream has been completed.

Reimplemented from DcmPolymorphOBOW.

virtual void DcmPixelData::transferInit ( ) [virtual]

initialize the transfer state of this object.

This method must be called before this object is written to a stream or read (parsed) from a stream.

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::write	(	DcmOutputStream &	outStream,
		const E_TransferSyntax	oxfer,
		const E_EncodingType	enctype,
		DcmWriteCache *	wcache
	)		`[virtual]`

writes a representation conforming to the transfer syntax It does not create a representation.

If no conforming representation exists, an error code is returned. The written representation is the new current representation

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::writeSignatureFormat	(	DcmOutputStream &	outStream,
		const E_TransferSyntax	oxfer,
		const E_EncodingType	enctype,
		DcmWriteCache *	wcache
	)		`[virtual]`

special write method for creation of digital signatures

Parameters:

outStream	DICOM output stream
oxfer	output transfer syntax
enctype	encoding types (undefined or explicit length)
wcache	pointer to write cache object, may be NULL

Returns:: status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmPolymorphOBOW.

virtual OFCondition DcmPixelData::writeXML	(	STD_NAMESPACE ostream &	out,
		const size_t	flags = `0`
	)		`[virtual]`

write object in XML format

Parameters:

out	output stream to which the XML document is written
flags	optional flag used to customize the output (see DCMTypes::XF_xxx)

Returns:: status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Member Data Documentation

OFBool DcmPixelData::alwaysUnencapsulated [private]

this flag indicates that this pixel data element will be written in uncompressed (defined length) format even if the dataset itself is written in a compressed syntax where pixel data is normally written in encapsulated (undefined length) format.

By default this flag is false, unless the dataset was read in an encapsulated transfer syntax and this pixel data element was already present in uncompressed format.

DcmRepresentationListIterator DcmPixelData::original [private]

Iterator to the original representation.

if an uncompressed representation is used the iterator points to repList.end()

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

dcmdata/include/dcmtk/dcmdata/dcpixel.h

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation