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

	DcmPixelData (const DcmPixelData &pixelData)
	copy constructor More...

virtual	~DcmPixelData ()
	destructor

DcmPixelData &	operator= (const DcmPixelData &obj)
	copy assignment operator More...

virtual DcmObject *	clone () const
	clone method More...

virtual int	compare (const DcmElement &rhs) const
	comparison operator that compares the value of this element with a given element of the same type (e.g. More...

virtual OFCondition	copyFrom (const DcmObject &rhs)
	virtual object copying. More...

virtual OFCondition	setVR (DcmEVR vr)
	set/change the current value representation of the uncompressed image representation, if any More...

virtual DcmEVR	ident () const
	return identifier for this class. More...

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

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)
	calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences. More...

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

virtual void	transferInit ()
	initialize the transfer state of this object. More...

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

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

virtual OFCondition	writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
	write object in XML format More...

virtual OFCondition	writeJson (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
	write object in JSON format to a stream More...

virtual OFCondition	writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	special write method for creation of digital signatures More...

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

virtual void	transferEnd ()
	finalize the transfer state of this object. More...

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

void	putOriginalRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter repParam, DcmPixelSequence pixSeq)
	Inserts an original encapsulated representation. More...

virtual OFCondition	putUint8Array (const Uint8 *byteValue, const unsigned long length)
	insert an original unencapsulated representation. More...

virtual OFCondition	putUint16Array (const Uint16 *wordValue, const unsigned long length)
	insert an original unencapsulated representation. More...

virtual OFCondition	createUint8Array (const Uint32 numBytes, Uint8 *&bytes)
	create an empty Uint8 array of given number of bytes and set it. More...

virtual OFCondition	createUint16Array (const Uint32 numWords, Uint16 *&words)
	create an empty Uint16 array of given number of words and set it. More...

virtual OFCondition	createValueFromTempFile (DcmInputStreamFactory *factory, const Uint32 length, const E_ByteOrder byteOrder)
	replace the attribute value with the content of the given temporary file. More...

OFCondition	getEncapsulatedRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter repParam, DcmPixelSequence &pixSeq)
	get a specific existing Representation, creates no representation if repParam is NULL, then the representation conforming to the default representationParameters (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. More...

void	removeAllButOriginalRepresentations ()
	removes all but the original representation

void	removeAllButCurrentRepresentations ()
	removes all but the current representation. More...

OFCondition	removeOriginalRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam)
	delete original representation and set new original representation. More...

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

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

virtual OFCondition	getDecompressedColorModel (DcmItem *dataset, OFString &decompressedColorModel)
	determine color model of the decompressed image More...

Public Member Functions inherited from DcmPolymorphOBOW
	DcmPolymorphOBOW (const DcmTag &tag, const Uint32 len=0)
	constructor More...

	DcmPolymorphOBOW (const DcmPolymorphOBOW &old)
	copy constructor

virtual	~DcmPolymorphOBOW ()
	destructor

DcmPolymorphOBOW &	operator= (const DcmPolymorphOBOW &obj)
	copy assignment operator More...

virtual OFCondition	getUint8Array (Uint8 *&val)
	get a pointer to the element value of the current element as type string. More...

virtual OFCondition	getUint16Array (Uint16 *&val)
	get a pointer to the element value of the current element as type Uint16. More...

Public Member Functions inherited from DcmOtherByteOtherWord
	DcmOtherByteOtherWord (const DcmTag &tag)
	constructor. More...

	DcmOtherByteOtherWord (const DcmOtherByteOtherWord &old)
	copy constructor More...

virtual	~DcmOtherByteOtherWord ()
	destructor

DcmOtherByteOtherWord &	operator= (const DcmOtherByteOtherWord &obj)
	assignment operator More...

virtual OFCondition	checkValue (const OFString &vm="", const OFBool oldFormat=OFFalse)
	check whether stored value conforms to the VR and to the specified VM More...

virtual unsigned long	getVM ()
	get value multiplicity More...

virtual unsigned long	getNumberOfValues ()
	get number of values stored in this element More...

virtual OFCondition	getUint8 (Uint8 &byteVal, const unsigned long pos=0)
	get particular 8 bit value. More...

virtual OFCondition	getUint16 (Uint16 &wordVal, const unsigned long pos=0)
	get particular 16 bit value. More...

virtual OFCondition	getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
	get a particular value as a character string. More...

virtual OFCondition	getOFStringArray (OFString &stringVal, OFBool normalize=OFTrue)
	get element value as a character string. More...

virtual OFCondition	putString (const char *stringVal)
	set element value from the given character string. More...

virtual OFCondition	putString (const char *stringVal, const Uint32 stringLen)
	set element value from the given character string. More...

virtual OFCondition	verify (const OFBool autocorrect=OFFalse)
	check the currently stored element value More...

Public Member Functions inherited from DcmElement
	DcmElement (const DcmTag &tag, const Uint32 len=0)
	constructor. More...

	DcmElement (const DcmElement &old)
	copy constructor More...

virtual	~DcmElement ()
	destructor

DcmElement &	operator= (const DcmElement &obj)
	assignment operator More...

virtual OFBool	isLeaf () const
	check if this element is a leaf node in a dataset tree. More...

OFBool	valueLoaded () const
	check if value of this element is loaded into main memory More...

virtual OFCondition	clear ()
	clear (remove) attribute value More...

virtual OFCondition	getSint16 (Sint16 &val, const unsigned long pos=0)
	retrieve a single value of type Sint16. More...

virtual OFCondition	getSint32 (Sint32 &val, const unsigned long pos=0)
	retrieve a single value of type Sint32. More...

virtual OFCondition	getUint32 (Uint32 &val, const unsigned long pos=0)
	retrieve a single value of type Uint32. More...

virtual OFCondition	getFloat32 (Float32 &val, const unsigned long pos=0)
	retrieve a single value of type Float32. More...

virtual OFCondition	getSint64 (Sint64 &val, const unsigned long pos=0)
	retrieve a single value of type Sint64. More...

virtual OFCondition	getUint64 (Uint64 &val, const unsigned long pos=0)
	retrieve a single value of type Uint64. More...

virtual OFCondition	getFloat64 (Float64 &val, const unsigned long pos=0)
	retrieve a single value of type Float64. More...

virtual OFCondition	getTagVal (DcmTagKey &val, const unsigned long pos=0)
	retrieve a single value of type DcmTagKey. More...

virtual OFCondition	getString (char *&val)
	get a pointer to the element value of the current element as type string. More...

virtual OFCondition	getString (char *&val, Uint32 &len)
	get a pointer to the element value of the current element as type string. More...

virtual OFCondition	getSint16Array (Sint16 *&val)
	get a pointer to the element value of the current element as type Sint16. More...

virtual OFCondition	getSint32Array (Sint32 *&val)
	get a pointer to the element value of the current element as type Sint32. More...

virtual OFCondition	getUint32Array (Uint32 *&val)
	get a pointer to the element value of the current element as type Uint32. More...

virtual OFCondition	getFloat32Array (Float32 *&val)
	get a pointer to the element value of the current element as type Float32. More...

virtual OFCondition	getSint64Array (Sint64 *&val)
	get a pointer to the element value of the current element as type Sint64. More...

virtual OFCondition	getUint64Array (Uint64 *&val)
	get a pointer to the element value of the current element as type Uint64. More...

virtual OFCondition	getFloat64Array (Float64 *&val)
	get a pointer to the element value of the current element as type Float64. More...

OFCondition	detachValueField (OFBool copy=OFFalse)
	detach the value field from the DICOM element (i.e., this object). More...

virtual OFCondition	putOFStringArray (const OFString &val)
	replace the element value by a copy of the given string (which is possibly multi-valued). More...

virtual OFCondition	putSint16 (const Sint16 val, const unsigned long pos=0)
	insert into the element value a copy of the given Sint16 value. More...

virtual OFCondition	putUint16 (const Uint16 val, const unsigned long pos=0)
	insert into the element value a copy of the given Uint16 value. More...

virtual OFCondition	putSint32 (const Sint32 val, const unsigned long pos=0)
	insert into the element value a copy of the given Sint32 value. More...

virtual OFCondition	putUint32 (const Uint32 val, const unsigned long pos=0)
	insert into the element value a copy of the given Uint32 value. More...

virtual OFCondition	putFloat32 (const Float32 val, const unsigned long pos=0)
	insert into the element value a copy of the given Float32 value. More...

virtual OFCondition	putFloat64 (const Float64 val, const unsigned long pos=0)
	insert into the element value a copy of the given Float64 value. More...

virtual OFCondition	putTagVal (const DcmTagKey &attrTag, const unsigned long pos=0)
	insert into the element value a copy of the given DcmTagKey value. More...

virtual OFCondition	putSint16Array (const Sint16 *vals, const unsigned long num)
	replace the element value by a copy of the given Sint16 array (which is possibly multi-valued). More...

virtual OFCondition	putSint32Array (const Sint32 *vals, const unsigned long num)
	replace the element value by a copy of the given Sint32 array (which is possibly multi-valued). More...

virtual OFCondition	putUint32Array (const Uint32 *vals, const unsigned long num)
	replace the element value by a copy of the given Uint32 array (which is possibly multi-valued). More...

virtual OFCondition	putFloat32Array (const Float32 *vals, const unsigned long num)
	replace the element value by a copy of the given Float32 array (which is possibly multi-valued). More...

virtual OFCondition	putFloat64Array (const Float64 *vals, const unsigned long num)
	replace the element value by a copy of the given Float64 array (which is possibly multi-valued). More...

virtual OFCondition	getPartialValue (void targetBuffer, const Uint32 offset, Uint32 numBytes, DcmFileCache cache=NULL, E_ByteOrder byteOrder=gLocalByteOrder)
	Copy numBytes bytes of data from the attribute value in byteOrder byte order to targetBuffer, starting at byte offset offset of the attribute value. More...

virtual void	compact ()
	remove the attribute value from memory if the attribute value can be loaded from file when needed again. More...

virtual OFCondition	getUncompressedFrameSize (DcmItem *dataset, Uint32 &frameSize) const
	compute uncompressed frame size of a single frame of this image. More...

virtual OFBool	isUniversalMatch (const OFBool normalize=OFTrue, const OFBool enableWildCardMatching=OFTrue)
	Determine if this element is universal matching. More...

virtual OFBool	matches (const DcmElement &candidate, const OFBool enableWildCardMatching=OFTrue) const
	perform attribute matching. More...

virtual OFBool	combinationMatches (const DcmElement &keySecond, const DcmElement &candidateFirst, const DcmElement &candidateSecond) const
	perform combined attribute matching. More...

const DcmInputStreamFactory *	getInputStream () const
	returns a pointer to the input stream, if available, NULL otherwise. More...

Public Member Functions inherited from DcmObject
	DcmObject (const DcmTag &tag, const Uint32 len=0)
	constructor. More...

	DcmObject (const DcmObject &obj)
	copy constructor More...

virtual	~DcmObject ()
	destructor

DcmObject &	operator= (const DcmObject &obj)
	copy assignment operator More...

DcmEVR	getVR () const
	return the value representation assigned to this object. More...

OFBool	isaString () const
	check if this element is a string type, based on the VR. More...

virtual OFBool	isNested () const
	check if this element is nested in a sequence of items, i.e. not a top-level or stand-alone element More...

E_TransferState	transferState () const
	return the current transfer (read/write) state of this object. More...

DcmItem *	getRootItem ()
	get root dataset/item (top-level) that contains this object. More...

virtual DcmItem *	getParentItem ()
	get parent item of this object. More...

DcmObject *	getParent ()
	get parent of this object. More...

const DcmObject *	getParent () const
	get parent of this object. More...

void	setParent (DcmObject *parent)
	set parent of this object. More...

Uint16	getGTag () const
	return the group number of the attribute tag for this object More...

Uint16	getETag () const
	return the element number of the attribute tag for this object More...

const DcmTag &	getTag () const
	return const reference to the attribute tag for this object More...

void	setGTag (Uint16 gtag)
	assign group tag (but not element tag) of the attribute tag for this object. More...

virtual OFBool	isSignable () const
	returns true if the current object may be included in a digital signature More...

virtual OFBool	containsUnknownVR () const
	returns true if the object contains an element with Unknown VR at any nesting level More...

virtual OFBool	containsExtendedCharacters (const OFBool checkAllStrings=OFFalse)
	check if this object contains non-ASCII characters More...

virtual OFBool	isAffectedBySpecificCharacterSet () const
	check if this object is affected by SpecificCharacterSet More...

virtual OFCondition	convertCharacterSet (DcmSpecificCharacterSet &converter)
	convert this object from the currently selected source character set to the currently selected destination character set (if affected by SpecificCharacterSet) More...

virtual OFBool	isEmpty (const OFBool normalize=OFTrue)
	check if this object is empty More...

virtual DcmObject *	nextInContainer (const DcmObject *obj)
	this method is only used in container classes derived from this class, that is, DcmItem and DcmSequenceOfItems. More...

virtual OFCondition	nextObject (DcmStack &stack, const OFBool intoSub)
	this method enables a stack based, depth-first traversal of a complete hierarchical DICOM dataset (that is, classes derived from DcmItem or DcmSequenceOfItems). More...

virtual OFCondition	search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue)
	a complex, stack-based, hierarchical search method. More...

Uint32	getLengthField () const
	return the current value of the Length field (which is different from the functionality of the public getLength() method). More...

Private Member Functions
OFBool	writeUnencapsulated (const E_TransferSyntax xfer)
	check if this element should be written unencapsulated, even though an encapsulated transfer syntax is used. More...

void	clearRepresentationList (DcmRepresentationListIterator leaveInList)
	This function removes all pixel representations from the list of pixel representations except the one which was passed. More...

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

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

DcmRepresentationListIterator	original
	Iterator to the original representation. More...

DcmRepresentationListIterator	current
	current list element for some operations

OFBool	existUnencapsulated
	shows if an unencapsulated 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. More...

DcmEVR	unencapsulatedVR
	value representation of unencapsulated data

DcmPixelSequence *	pixelSeqForWrite
	in write function: pointer to current pixel sequence

Friends
class	DcmRepresentationEntry

Additional Inherited Members
Static Public Member Functions inherited from DcmElement
static int	scanValue (const OFString &value, const OFString &vr, const size_t pos=0, const size_t num=OFString_npos)
	scan string value for conformance with given value representation (VR) More...

static int	scanValue (const OFString &vr, const char *const value, const size_t size)
	scan string value for conformance with given value representation (VR) More...

static unsigned long	determineVM (const char *str, const size_t len)
	determine the number of values stored in a string, i.e. the value multiplicity (VM) More...

static size_t	getValueFromString (const char *str, const size_t pos, const size_t len, OFString &val)
	get the first value stored in the given string. More...

static OFCondition	checkVM (const unsigned long vmNum, const OFString &vmStr)
	check for correct value multiplicity (VM) More...

Protected Member Functions inherited from DcmOtherByteOtherWord
	DcmOtherByteOtherWord (const DcmTag &tag, const Uint32 len)
	constructor. More...

virtual void	postLoadValue ()
	method is called after the element value has been loaded. More...

OFCondition	alignValue ()
	align the element value to an even length (padding) More...

void	printPixel (STD_NAMESPACE ostream &out, const size_t flags, const int level, const char pixelFileName, size_t pixelCounter)
	print pixel data and optionally write it to a binary file. More...

Protected Member Functions inherited from DcmElement
void *	getValue (const E_ByteOrder newByteOrder=gLocalByteOrder)
	This function returns this element's value. More...

OFCondition	changeValue (const void *value, const Uint32 position, const Uint32 num)
	insert into the element value a copy of the given raw value. More...

OFCondition	putValue (const void *value, const Uint32 length)
	replace the element value by a copy of the given raw data block More...

OFCondition	createEmptyValue (const Uint32 length)
	create a new, empty value field of given size. More...

OFCondition	loadValue (DcmInputStream *inStream=NULL)
	This function reads the data value of an attribute and stores the information which was read in this. More...

virtual Uint8 *	newValueField ()
	This function creates a byte array of Length bytes and returns this array. More...

void	swapValueField (size_t valueWidth)
	swaps the content of the value field (if loaded) from big-endian to little-endian or back More...

virtual void	writeXMLStartTag (STD_NAMESPACE ostream &out, const size_t flags, const char *attrText=NULL)
	write element start tag in XML format More...

virtual void	writeXMLEndTag (STD_NAMESPACE ostream &out, const size_t flags)
	write element end tag in XML format More...

virtual void	writeJsonOpener (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
	write element start tag in JSON format More...

virtual void	writeJsonCloser (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
	write element end tag in JSON format More...

E_ByteOrder	getByteOrder () const
	return the current byte order of the value field More...

void	setByteOrder (E_ByteOrder val)
	set the current byte order of the value field More...

Protected Member Functions inherited from DcmObject
void	printNestingLevel (STD_NAMESPACE ostream &out, const size_t flags, const int level)
	print line indentation, e.g. a couple of spaces for each nesting level. More...

void	printInfoLineStart (STD_NAMESPACE ostream &out, const size_t flags, const int level, DcmTag *tag=NULL)
	print beginning of the info line. More...

void	printInfoLineEnd (STD_NAMESPACE ostream &out, const size_t flags, const unsigned long printedLength=0xffffffff, DcmTag *tag=NULL)
	print end of the info line. More...

virtual void	printInfoLine (STD_NAMESPACE ostream &out, const size_t flags, const int level=0, const char info=NULL, DcmTag tag=NULL, const OFBool isInfo=OFTrue)
	print given text with element information. More...

virtual OFCondition	writeTagAndLength (DcmOutputStream &outStream, const E_TransferSyntax oxfer, Uint32 &writtenBytes) const
	write tag, VR and length field to the given output stream More...

virtual Uint32	getTagAndLengthSize (const E_TransferSyntax oxfer) const
	return the number of bytes needed to serialize the tag, VR and length information of the current object using the given transfer syntax. More...

const char *	getTagName ()
	return the DICOM attribute tag name for this object. More...

void	setTagVR (DcmEVR vr)
	set the VR for this attribute More...

E_TransferState	getTransferState () const
	return the current transfer state of this object during serialization/deserialization More...

void	setTransferState (E_TransferState newState)
	set the current transfer state of this object during serialization/deserialization More...

Uint32	getTransferredBytes () const
	return the number of transferred bytes for this object during serialization/deserialization More...

void	setTransferredBytes (Uint32 val)
	set the number of transferred bytes for this object during serialization/deserialization More...

void	incTransferredBytes (Uint32 val)
	add to the number of transferred bytes for this object during serialization/deserialization More...

void	setLengthField (Uint32 val)
	set the current value of the Length field More...

Static Protected Member Functions inherited from DcmObject
static OFCondition	writeTag (DcmOutputStream &outStream, const DcmTag &tag, const E_TransferSyntax oxfer)
	static helper function that writes a given attribute tag to a binary output stream using the byte order indicated by the transfer syntax. More...

Protected Attributes inherited from DcmObject
OFCondition	errorFlag
	error flag for this object.

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() [1/2]

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

constructor.

Create new element from given tag and length.

Parameters

tag	attribute tag
len	length of the attribute value

◆ DcmPixelData() [2/2]

DcmPixelData::DcmPixelData ( const DcmPixelData & pixelData )

copy constructor

Parameters

pixelData element to be copied

Member Function Documentation

◆ calcElementLength()

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

virtual

calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.

For elements, the length includes the length of the tag, length field, VR field and the value itself, for items and sequences it returns the length of the complete item or sequence including delimitation tags if applicable.

Warning: Since calcElementLength() returns a 32 bit integer, an overflow during calculation is possible for some derived classes that actually represent a compound value (e.g. items like DcmPixelItem). Such overflows will be detected, in which case the maximum possible value will be returned instead, coinciding with DCM_UndefinedLength.; The implementation in DcmPixelData may return zero if no conforming representation exists and set the EC_RepresentationNotFound error flag to indicated it.; When calculation the length of a sequence or an item containing multiple attributes, the implementation may return DCM_UndefinedLength to indicate a value that can not be encoded as a 32 bit length field. It will even do so if "dcmWriteOversizedSeqsAndItemsUndefined" is disabled, but then also set the EC_SeqOrItemContentOverflow error flag (inside getLength()) to indicated it.

Note: Just check for zero or DCM_UndefinedLength return value and then have a look at the error flag in either case.

Parameters

xfer	transfer syntax for length calculation
enctype	sequence encoding type for length calculation

Returns: length of DICOM element

Reimplemented from DcmElement.

◆ chooseRepresentation()

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

◆ clearRepresentationList()

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.

◆ clone()

virtual DcmObject* DcmPixelData::clone ( ) const

inlinevirtual

clone method

Returns: deep copy of this object

Reimplemented from DcmPolymorphOBOW.

◆ compare()

virtual int DcmPixelData::compare ( const DcmElement & rhs ) const

virtual

comparison operator that compares the value of this element with a given element of the same type (e.g.

an DcmPixelData with a DcmPixelData). The tag of the element is also considered as the first component that is compared, followed by the object types (VR, i.e. DCMTK'S EVR). The DcmPixelData implementation checks whether the uncompressed data of both objects are identical, and if not provided, if the compressed data of both objects is the same, by comparing the pixel items bytewise.

Parameters

rhs	the right hand side of the comparison

Returns: 0 if the object values are equal. -1 is returned if rhs is considered greater than this object. 1 is returned if rhs is considered smaller than this object.

Reimplemented from DcmPolymorphOBOW.

◆ copyFrom()

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.

◆ createUint16Array()

virtual OFCondition DcmPixelData::createUint16Array	(	const Uint32	numWords,
		Uint16 *&	words
	)

virtual

create an empty Uint16 array of given number of words and set it.

All array elements are initialized with a value of 0 (using 'memzero'). This method is only applicable to OW data.

Parameters

numWords	number of words (16 bit) to be created
words	stores the pointer to the resulting buffer

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

Reimplemented from DcmPolymorphOBOW.

◆ createUint8Array()

virtual OFCondition DcmPixelData::createUint8Array	(	const Uint32	numBytes,
		Uint8 *&	bytes
	)

virtual

create an empty Uint8 array of given number of bytes and set it.

All array elements are initialized with a value of 0 (using 'memzero'). This method is only applicable to certain VRs, e.g. OB.

Parameters

numBytes	number of bytes (8 bit) to be created
bytes	stores the pointer to the resulting buffer

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

Reimplemented from DcmPolymorphOBOW.

◆ createValueFromTempFile()

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.

◆ findRepresentationEntry()

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!

◆ getDecompressedColorModel()

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.

◆ getLength()

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.

◆ getUncompressedFrame()

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.

◆ ident()

virtual DcmEVR DcmPixelData::ident ( ) const

inlinevirtual

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.

References EVR_PixelData.

◆ loadAllDataIntoMemory()

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.

◆ operator=()

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

copy assignment operator

Parameters

obj	element to be copied

◆ print()

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.

◆ putOriginalRepresentation()

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

◆ putUint16Array()

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.

◆ putUint8Array()

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.

◆ read()

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.

◆ removeAllButCurrentRepresentations()

void DcmPixelData::removeAllButCurrentRepresentations ( )

removes all but the current representation.

Makes the current representation original.

◆ removeOriginalRepresentation()

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

◆ removeRepresentation()

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

◆ setNonEncapsulationFlag()

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

◆ setVR()

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 particularly useful for unknown (UN) or unsupported VRs.

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

Reimplemented from DcmOtherByteOtherWord.

◆ transferEnd()

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.

◆ transferInit()

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.

◆ write()

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.

◆ writeJson()

virtual OFCondition DcmPixelData::writeJson	(	STD_NAMESPACE ostream &	out,
		DcmJsonFormat &	format
	)

virtual

write object in JSON format to a stream

Parameters

out	output stream to which the JSON document is written
format	used to format and customize the output

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

Reimplemented from DcmOtherByteOtherWord.

◆ writeSignatureFormat()

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.

◆ writeUnencapsulated()

OFBool DcmPixelData::writeUnencapsulated ( const E_TransferSyntax xfer )

private

check if this element should be written unencapsulated, even though an encapsulated transfer syntax is used.

In other words, this checks if this pixel data element is on the main level on the dataset or not.

Parameters

xfer	the transfer syntax that should be used

◆ writeXML()

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

◆ alwaysUnencapsulated

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.

◆ original

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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DcmPixelData() [1/2]

◆ DcmPixelData() [2/2]

Member Function Documentation

◆ calcElementLength()

◆ chooseRepresentation()

◆ clearRepresentationList()

◆ clone()

◆ compare()

◆ copyFrom()

◆ createUint16Array()

◆ createUint8Array()

◆ createValueFromTempFile()

◆ findRepresentationEntry()

◆ getDecompressedColorModel()

◆ getLength()

◆ getUncompressedFrame()

◆ ident()

◆ loadAllDataIntoMemory()

◆ operator=()

◆ print()

◆ putOriginalRepresentation()

◆ putUint16Array()

◆ putUint8Array()

◆ read()

◆ removeAllButCurrentRepresentations()

◆ removeOriginalRepresentation()

◆ removeRepresentation()

◆ setNonEncapsulationFlag()

◆ setVR()

◆ transferEnd()

◆ transferInit()

◆ write()

◆ writeJson()

◆ writeSignatureFormat()

◆ writeUnencapsulated()

◆ writeXML()

Member Data Documentation

◆ alwaysUnencapsulated

◆ original