OFFIS DCMTK  Version 3.6.0
Public Member Functions | Private Attributes | List of all members
DcmDataset Class Reference

a class handling the DICOM dataset format (files without meta header) More...

Inheritance diagram for DcmDataset:
[legend]
Collaboration diagram for DcmDataset:
[legend]

Public Member Functions

 DcmDataset ()
 default constructor
 
 DcmDataset (const DcmDataset &old)
 copy constructor
 
virtual ~DcmDataset ()
 destructor
 
DcmDatasetoperator= (const DcmDataset &obj)
 assignment operator
 
virtual DcmObjectclone () const
 clone method
 
virtual OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying.
 
virtual DcmEVR ident () const
 get type identifier
 
virtual OFCondition clear ()
 clear (remove) attribute value
 
virtual void removeInvalidGroups ()
 remove all elements with an invalid group number, i.e.
 
E_TransferSyntax getOriginalXfer () const
 return the transfer syntax in which this dataset was originally read.
 
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 dataset to a stream
 
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.
 
virtual OFBool canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer=EXS_Unknown)
 check if this DICOM object can be encoded in the given transfer syntax.
 
virtual OFCondition read (DcmInputStream &inStream, const E_TransferSyntax xfer=EXS_Unknown, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength)
 This function reads the information of all attributes which are captured in the input stream and captures this information in this->elementList.
 
virtual OFCondition write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 write dataset to a stream
 
virtual OFCondition write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache, const E_GrpLenEncoding glenc, const E_PaddingEncoding padenc=EPD_noChange, const Uint32 padlen=0, const Uint32 subPadlen=0, Uint32 instanceLength=0)
 This function writes data values which are contained in this DcmDataset object to the stream which is passed as first argument.
 
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 writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
 write object in XML format.
 
virtual OFCondition loadFile (const char *fileName, const E_TransferSyntax readXfer=EXS_Unknown, const E_GrpLenEncoding groupLength=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength)
 load object from a DICOM file.
 
virtual OFCondition saveFile (const char *fileName, const E_TransferSyntax writeXfer=EXS_Unknown, const E_EncodingType encodingType=EET_UndefinedLength, const E_GrpLenEncoding groupLength=EGL_recalcGL, const E_PaddingEncoding padEncoding=EPD_noChange, const Uint32 padLength=0, const Uint32 subPadLength=0)
 save object to a DICOM file.
 
OFCondition chooseRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam)
 select a specific representation (compressed or uncompressed) of the dataset and create the representation if needed.
 
OFBool hasRepresentation (const E_TransferSyntax repType, const DcmRepresentationParameter *repParam)
 check if all PixelData elements in this dataset have a representation conforming to the given transfer syntax and representation parameters (see dcpixel.h for definition of "conforming").
 
void removeAllButOriginalRepresentations ()
 removes all but the original representation in all pixel data elements
 
void removeAllButCurrentRepresentations ()
 removes all but the current representation and sets the original representation to current
 
- Public Member Functions inherited from DcmItem
 DcmItem ()
 default constructor
 
 DcmItem (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmItem (const DcmItem &old)
 copy constructor
 
DcmItemoperator= (const DcmItem &obj)
 assignment operator.
 
virtual ~DcmItem ()
 destructor
 
virtual unsigned long getVM ()
 get value multiplicity
 
virtual unsigned long card () const
 get cardinality of this item
 
virtual OFBool isLeaf () const
 check if this element is a leaf node in a dataset tree.
 
virtual Uint32 getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)
 calculate the value length (without attribute tag, VR and length field) of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.
 
virtual void transferInit ()
 initialize the transfer state of this object.
 
virtual void transferEnd ()
 finalize the transfer state of this object.
 
virtual OFBool containsUnknownVR () const
 returns true if the object contains an element with Unknown VR at any nesting level
 
virtual OFBool containsExtendedCharacters (const OFBool checkAllStrings=OFFalse)
 check if this object contains non-ASCII characters at any nesting level
 
virtual OFBool isAffectedBySpecificCharacterSet () const
 check if this object is affected by SpecificCharacterSet at any nesting level.
 
virtual OFCondition insert (DcmElement *elem, OFBool replaceOld=OFFalse, OFBool checkInsertOrder=OFFalse)
 insert a new element into the list of elements maintained by this item.
 
virtual DcmElementgetElement (const unsigned long num)
 access an element from the item.
 
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).
 
virtual DcmObjectnextInContainer (const DcmObject *obj)
 this method is only used in container classes, that is, DcmItem and DcmSequenceOfItems.
 
virtual DcmElementremove (const unsigned long num)
 remove element from list.
 
virtual DcmElementremove (DcmObject *elem)
 remove element from list.
 
virtual DcmElementremove (const DcmTagKey &tag)
 remove element from list.
 
virtual OFBool isEmpty (const OFBool normalize=OFTrue)
 check if this item is empty
 
virtual OFCondition verify (const OFBool autocorrect=OFFalse)
 check the currently stored element value
 
virtual OFCondition search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue)
 a complex, stack-based, hierarchical search method.
 
virtual OFCondition loadAllDataIntoMemory ()
 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 OFCondition computeGroupLengthAndPadding (const E_GrpLenEncoding glenc, const E_PaddingEncoding padenc=EPD_noChange, const E_TransferSyntax xfer=EXS_Unknown, const E_EncodingType enctype=EET_ExplicitLength, const Uint32 padlen=0, const Uint32 subPadlen=0, Uint32 instanceLength=0)
 This function takes care of group length and padding elements in the current element list according to what is specified in glenc and padenc.
 
OFBool tagExists (const DcmTagKey &key, OFBool searchIntoSub=OFFalse)
 check if an element with the given attribute tag exists in the dataset
 
OFBool tagExistsWithValue (const DcmTagKey &key, OFBool searchIntoSub=OFFalse)
 check if an element with the given attribute tag exists in the dataset and has a non-empty value (i.e., length > 0)
 
OFCondition findAndGetElement (const DcmTagKey &tagKey, DcmElement *&element, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse)
 find element and get a pointer to it (or copy it).
 
OFCondition findAndGetElements (const DcmTagKey &tagKey, DcmStack &resultStack)
 find all elements matching a particular tag and return references to them on a stack.
 
OFCondition findAndGetString (const DcmTagKey &tagKey, const char *&value, const OFBool searchIntoSub=OFFalse)
 find element and get value as a reference to a C string.
 
OFCondition findAndGetOFString (const DcmTagKey &tagKey, OFString &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a C++ string (only one component).
 
OFCondition findAndGetOFStringArray (const DcmTagKey &tagKey, OFString &value, const OFBool searchIntoSub=OFFalse)
 find element and get value as a C++ string (all components).
 
OFCondition findAndGetUint8 (const DcmTagKey &tagKey, Uint8 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as an unsigned 8-bit integer.
 
OFCondition findAndGetUint8Array (const DcmTagKey &tagKey, const Uint8 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of unsigned 8-bit integers.
 
OFCondition findAndGetUint16 (const DcmTagKey &tagKey, Uint16 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as an unsigned 16-bit integer.
 
OFCondition findAndGetUint16Array (const DcmTagKey &tagKey, const Uint16 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of unsigned 16-bit integers.
 
OFCondition findAndGetSint16 (const DcmTagKey &tagKey, Sint16 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a signed 16-bit integer.
 
OFCondition findAndGetSint16Array (const DcmTagKey &tagKey, const Sint16 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of signed 16-bit integers.
 
OFCondition findAndGetUint32 (const DcmTagKey &tagKey, Uint32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as an unsigned 32-bit integer.
 
OFCondition findAndGetUint32Array (const DcmTagKey &tagKey, const Uint32 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of unsigned 32-bit integers.
 
OFCondition findAndGetSint32 (const DcmTagKey &tagKey, Sint32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a signed 32-bit integer.
 
OFCondition findAndGetSint32Array (const DcmTagKey &tagKey, const Sint32 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of signed 32-bit integers.
 
OFCondition findAndGetLongInt (const DcmTagKey &tagKey, long int &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a (signed) long integer.
 
OFCondition findAndGetFloat32 (const DcmTagKey &tagKey, Float32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a 32-bit floating point.
 
OFCondition findAndGetFloat32Array (const DcmTagKey &tagKey, const Float32 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of 32-bit floating point values.
 
OFCondition findAndGetFloat64 (const DcmTagKey &tagKey, Float64 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a 64-bit floating point.
 
OFCondition findAndGetFloat64Array (const DcmTagKey &tagKey, const Float64 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of 64-bit floating point values.
 
OFCondition findAndGetSequence (const DcmTagKey &seqTagKey, DcmSequenceOfItems *&sequence, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse)
 looks up and returns a given sequence.
 
OFCondition findAndGetSequenceItem (const DcmTagKey &seqTagKey, DcmItem *&item, const signed long itemNum=0, const OFBool createCopy=OFFalse)
 looks up and returns a given sequence item, if it exists.
 
OFCondition findOrCreateSequenceItem (const DcmTag &seqTag, DcmItem *&item, const signed long itemNum=0)
 looks up the given sequence in the current dataset and returns the given item.
 
OFCondition findAndInsertCopyOfElement (const DcmTagKey &tagKey, DcmItem *destItem, const OFBool replaceOld=OFTrue)
 find element, create a copy and insert it into the given destination dataset.
 
OFCondition findAndDeleteElement (const DcmTagKey &tagKey, const OFBool allOccurrences=OFFalse, const OFBool searchIntoSub=OFFalse)
 find element, remove it from the dataset and free the associated memory.
 
OFCondition findAndDeleteSequenceItem (const DcmTagKey &seqTagKey, const signed long itemNum)
 looks up the given sequence in the current dataset and deletes the given item.
 
OFCondition putAndInsertString (const DcmTag &tag, const char *value, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertOFStringArray (const DcmTag &tag, const OFString &value, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint8Array (const DcmTag &tag, const Uint8 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint16 (const DcmTag &tag, const Uint16 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint16Array (const DcmTag &tag, const Uint16 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertSint16 (const DcmTag &tag, const Sint16 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertSint16Array (const DcmTag &tag, const Sint16 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint32 (const DcmTag &tag, const Uint32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertSint32 (const DcmTag &tag, const Sint32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertFloat32 (const DcmTag &tag, const Float32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertFloat64 (const DcmTag &tag, const Float64 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition insertEmptyElement (const DcmTag &tag, const OFBool replaceOld=OFTrue)
 create a new element (with no value) and insert it into the dataset/item.
 
OFCondition insertSequenceItem (const DcmTag &seqTag, DcmItem *item, const signed long itemNum=-2)
 looks up the given sequence in the current dataset and inserts the given item.
 
- Public Member Functions inherited from DcmObject
 DcmObject (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmObject (const DcmObject &obj)
 copy constructor
 
virtual ~DcmObject ()
 destructor
 
DcmObjectoperator= (const DcmObject &obj)
 copy assignment operator
 
DcmEVR getVR () const
 return the value representation assigned to this object.
 
OFBool isaString () const
 check if this element is a string type, based on the VR.
 
E_TransferState transferState () const
 return the current transfer (read/write) state of this object.
 
Uint16 getGTag () const
 return the group number of the attribute tag for this object
 
Uint16 getETag () const
 return the element number of the attribute tag for this object
 
const DcmTaggetTag () const
 return const reference to the attribute tag for this object
 
void setGTag (Uint16 gtag)
 assign group tag (but not element tag) of the attribute tag for this object.
 
virtual OFCondition setVR (DcmEVR)
 assign a new Value Representation (VR) to this object.
 
virtual OFBool isSignable () const
 returns true if the current object may be included in a digital signature
 
Uint32 getLengthField () const
 return the current value of the Length field (which is different from the functionality of the public getLength method).
 

Private Attributes

E_TransferSyntax Xfer
 current transfer syntax of the dataset
 

Additional Inherited Members

- Protected Member Functions inherited from DcmItem
OFCondition readTagAndLength (DcmInputStream &inStream, const E_TransferSyntax xfer, DcmTag &tag, Uint32 &length, Uint32 &bytesRead)
 This function reads tag and length information from inStream and returns this information to the caller.
 
OFCondition readSubElement (DcmInputStream &inStream, DcmTag &newTag, const Uint32 newLength, const E_TransferSyntax xfer, const E_GrpLenEncoding glenc, const Uint32 maxReadLength=DCM_MaxReadLength)
 This function creates a new DcmElement object on the basis of the newTag and newLength information which was passed, inserts this new element into elementList, reads the actual data value which belongs to this element (attribute) from the inStream and also assigns this information to the object which was created at the beginning.
 
E_TransferSyntax checkTransferSyntax (DcmInputStream &inStream)
 This function reads the first 6 bytes from the input stream and determines the transfer syntax which was used to code the information in the stream.
 
void checkAndUpdateVR (DcmItem &item, DcmTag &tag)
 check whether the given tag requires some special handling regarding the VR (i.e.
 
- 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.
 
- Protected Attributes inherited from DcmItem
DcmListelementList
 the list of elements maintained by this object
 
OFBool lastElementComplete
 flag used during suspended I/O.
 
offile_off_t fStartPosition
 used during reading.
 

Detailed Description

a class handling the DICOM dataset format (files without meta header)

Definition at line 46 of file dcdatset.h.

Constructor & Destructor Documentation

DcmDataset::DcmDataset ( const DcmDataset old)

copy constructor

Parameters
olddataset to be copied

Member Function Documentation

Uint32 DcmDataset::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. Never returns undefined length.

Parameters
xfertransfer syntax for length calculation
enctypesequence encoding type for length calculation
Returns
length of DICOM element

Reimplemented from DcmItem.

virtual OFBool DcmDataset::canWriteXfer ( const E_TransferSyntax  newXfer,
const E_TransferSyntax  oldXfer = EXS_Unknown 
)
virtual

check if this DICOM object can be encoded in the given transfer syntax.

Parameters
newXfertransfer syntax in which the DICOM object is to be encoded
oldXfertransfer syntax in which the DICOM object was read or created.
Returns
true if object can be encoded in desired transfer syntax, false otherwise.

Reimplemented from DcmItem.

OFCondition DcmDataset::chooseRepresentation ( const E_TransferSyntax  repType,
const DcmRepresentationParameter repParam 
)

select a specific representation (compressed or uncompressed) of the dataset and create the representation if needed.

This may cause compression or decompression to be applied to the pixel data in the dataset.

Parameters
repTypedesired transfer syntax
repParamdesired representation parameter (e.g. quality factor for lossy compression)
Returns
EC_Normal upon success, an error code otherwise.

Referenced by DcmFileFormat::chooseRepresentation().

virtual OFCondition DcmDataset::clear ( )
virtual

clear (remove) attribute value

Returns
EC_Normal if successful, an error code otherwise

Reimplemented from DcmItem.

virtual DcmObject* DcmDataset::clone ( ) const
inlinevirtual

clone method

Returns
deep copy of this object

Reimplemented from DcmItem.

Definition at line 73 of file dcdatset.h.

References DcmDataset().

virtual OFCondition DcmDataset::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 DcmItem.

E_TransferSyntax DcmDataset::getOriginalXfer ( ) const

return the transfer syntax in which this dataset was originally read.

Returns
transfer syntax in which this dataset was originally read, EXS_Unknown if the dataset was created in memory
OFBool DcmDataset::hasRepresentation ( const E_TransferSyntax  repType,
const DcmRepresentationParameter repParam 
)

check if all PixelData elements in this dataset have a representation conforming to the given transfer syntax and representation parameters (see dcpixel.h for definition of "conforming").

Parameters
repTypedesired transfer syntax
repParamdesired representation parameter (e.g. quality factor for lossy compression)
Returns
true if all pixel elements have the desired representation, false otherwise

Referenced by DcmFileFormat::hasRepresentation().

virtual DcmEVR DcmDataset::ident ( ) const
virtual

get type identifier

Returns
type identifier of this class (EVR_dataset)

Reimplemented from DcmItem.

virtual OFCondition DcmDataset::loadFile ( const char *  fileName,
const E_TransferSyntax  readXfer = EXS_Unknown,
const E_GrpLenEncoding  groupLength = EGL_noChange,
const Uint32  maxReadLength = DCM_MaxReadLength 
)
virtual

load object from a DICOM file.

This method only supports DICOM objects stored as a dataset, i.e. without meta header. Use DcmFileFormat::loadFile() to load files with meta header.

Parameters
fileNamename of the file to load
readXfertransfer syntax used to read the data (auto detection if EXS_Unknown)
groupLengthflag, specifying how to handle the group length tags
maxReadLengthmaximum number of bytes to be read for an element value. Element values with a larger size are not loaded until their value is retrieved (with getXXX()) or loadAllDataElements() is called.
Returns
status, EC_Normal if successful, an error code otherwise
DcmDataset& DcmDataset::operator= ( const DcmDataset obj)

assignment operator

Parameters
objthe dataset to be copied
virtual void DcmDataset::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 dataset to a stream

Parameters
outoutput stream
flagsoptional flag used to customize the output (see DCMTypes::PF_xxx)
levelcurrent level of nested items. Used for indentation.
pixelFileNameoptional filename used to write the raw pixel data file
pixelCounteroptional counter used for automatic pixel data filename creation

Reimplemented from DcmItem.

virtual OFCondition DcmDataset::read ( DcmInputStream inStream,
const E_TransferSyntax  xfer = EXS_Unknown,
const E_GrpLenEncoding  glenc = EGL_noChange,
const Uint32  maxReadLength = DCM_MaxReadLength 
)
virtual

This function reads the information of all attributes which are captured in the input stream and captures this information in this->elementList.

Each attribute is represented as an element in this list. Having read all information for this particular data set or command, this function will also take care of group length (according to what is specified in glenc) and padding elements (don't change anything).

Parameters
inStreamThe stream which contains the information.
xferThe transfer syntax which was used to encode the information in inStream.
glencEncoding type for group length; specifies what will be done with group length tags.
maxReadLengthMaximum read length for reading an attribute value.
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmItem.

virtual void DcmDataset::removeInvalidGroups ( )
virtual

remove all elements with an invalid group number, i.e.

0x0000 to 0x0003, 0x0005, 0x0007 and 0xFFFF

virtual OFCondition DcmDataset::saveFile ( const char *  fileName,
const E_TransferSyntax  writeXfer = EXS_Unknown,
const E_EncodingType  encodingType = EET_UndefinedLength,
const E_GrpLenEncoding  groupLength = EGL_recalcGL,
const E_PaddingEncoding  padEncoding = EPD_noChange,
const Uint32  padLength = 0,
const Uint32  subPadLength = 0 
)
virtual

save object to a DICOM file.

This method only supports DICOM objects stored as a dataset, i.e. without meta header. Use DcmFileFormat::saveFile() to save files with meta header.

Parameters
fileNamename of the file to save
writeXfertransfer syntax used to write the data (EXS_Unknown means use current)
encodingTypeflag, specifying the encoding with undefined or explicit length
groupLengthflag, specifying how to handle the group length tags
padEncodingflag, specifying how to handle the padding tags
padLengthnumber of bytes used for the dataset padding (has to be an even number)
subPadLengthnumber of bytes used for the item padding (has to be an even number)
Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DcmDataset::write ( DcmOutputStream outStream,
const E_TransferSyntax  oxfer,
const E_EncodingType  enctype,
DcmWriteCache wcache 
)
virtual

write dataset to a stream

Parameters
outStreamDICOM output stream
oxferoutput transfer syntax
enctypeencoding types (undefined or explicit length)
wcachepointer to write cache object, may be NULL
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmItem.

virtual OFCondition DcmDataset::write ( DcmOutputStream outStream,
const E_TransferSyntax  oxfer,
const E_EncodingType  enctype,
DcmWriteCache wcache,
const E_GrpLenEncoding  glenc,
const E_PaddingEncoding  padenc = EPD_noChange,
const Uint32  padlen = 0,
const Uint32  subPadlen = 0,
Uint32  instanceLength = 0 
)
virtual

This function writes data values which are contained in this DcmDataset object to the stream which is passed as first argument.

With regard to the writing of information, the other parameters which are passed are accounted for. The function will return EC_Normal, if the information from all elements of this data set has been written to the buffer, it will return EC_StreamNotifyClient, if there is no more space in the buffer and not all elements have been written to it, and it will return some other (error) value if there was an error.

Parameters
outStreamThe stream that the information will be written to.
oxferThe transfer syntax which shall be used.
enctypeEncoding type for sequences; specifies how sequences will be handled.
wcachepointer to write cache object, may be NULL
glencEncoding type for group length; specifies what will be done with group length tags.
padencEncoding type for padding. Specifies what will be done with padding tags.
padlenThe length up to which the dataset shall be padded, if padding is desired.
subPadlenFor sequences (ie sub elements), the length up to which item shall be padded, if padding is desired.
instanceLengthNumber of extra bytes added to the item/dataset length used when computing the padding; this parameter is for instance used to pass the length of the file meta header from the DcmFileFormat to the DcmDataset object.
Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DcmDataset::writeSignatureFormat ( DcmOutputStream outStream,
const E_TransferSyntax  oxfer,
const E_EncodingType  enctype,
DcmWriteCache wcache 
)
virtual

special write method for creation of digital signatures

Parameters
outStreamDICOM output stream
oxferoutput transfer syntax
enctypeencoding types (undefined or explicit length)
wcachepointer to write cache object, may be NULL
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmItem.

virtual OFCondition DcmDataset::writeXML ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0 
)
virtual

write object in XML format.

The XML declaration (e.g. <?xml version="1.0"?>) is not written by this function.

Parameters
outoutput stream to which the XML document is written
flagsoptional flag used to customize the output (see DCMTypes::XF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmItem.


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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2