|
| DcmDataset () |
| default constructor
|
|
| DcmDataset (const DcmDataset &old) |
| copy constructor More...
|
|
virtual | ~DcmDataset () |
| destructor
|
|
DcmDataset & | operator= (const DcmDataset &obj) |
| assignment operator More...
|
|
virtual DcmObject * | clone () const |
| clone method More...
|
|
virtual OFCondition | copyFrom (const DcmObject &rhs) |
| Virtual object copying. More...
|
|
virtual DcmEVR | ident () const |
| get type identifier More...
|
|
virtual OFCondition | clear () |
| clear (remove) attribute value More...
|
|
virtual void | removeInvalidGroups (const OFBool cmdSet=OFFalse) |
| remove all elements with an invalid group number, i.e. More...
|
|
E_TransferSyntax | getOriginalXfer () const |
| return the transfer syntax in which this dataset was originally read or created. More...
|
|
E_TransferSyntax | getCurrentXfer () const |
| return the current transfer syntax, i.e. the one that was last used with chooseRepresentation() in order to select a specific representation or with write() or writeSignatureFormat() in order to create a byte stream according to the DICOM encoding rules. More...
|
|
virtual void | updateOriginalXfer () |
| update the original transfer syntax, e.g. in case the dataset was created in memory and pixel data was added with a particular representation. 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 dataset to a stream More...
|
|
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 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. More...
|
|
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. More...
|
|
virtual OFCondition | readUntilTag (DcmInputStream &inStream, const E_TransferSyntax xfer=EXS_Unknown, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength, const DcmTagKey &stopParsingAtElement=DCM_UndefinedTagKey) |
| This function reads the information of all attributes which are captured in the input stream and captures this information in this->elementList, up to the attribute tag stopParsingAtElement. More...
|
|
virtual OFCondition | write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache) |
| write dataset to a stream More...
|
|
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. 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 | 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. More...
|
|
template<typename Format > |
OFCondition | writeJson (STD_NAMESPACE ostream &out, Format format) |
| write object in JSON format. More...
|
|
virtual OFCondition | loadFile (const OFFilename &fileName, const E_TransferSyntax readXfer=EXS_Unknown, const E_GrpLenEncoding groupLength=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength) |
| load object from a DICOM file. More...
|
|
virtual OFCondition | loadFileUntilTag (const OFFilename &fileName, const E_TransferSyntax readXfer=EXS_Unknown, const E_GrpLenEncoding groupLength=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength, const DcmTagKey &stopParsingAtElement=DCM_UndefinedTagKey) |
| load object from a DICOM file, up to the attribute tag stopParsingAtElement. More...
|
|
virtual OFCondition | saveFile (const OFFilename &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. More...
|
|
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. More...
|
|
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"). More...
|
|
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
|
|
virtual OFBool | checkForSpecificCharacterSet () const |
| mode specifying whether the SpecificCharacterSet (0008,0005) element should be checked by convertCharacterSet() or not, i.e. whether this element might be present on this dataset-level. More...
|
|
| DcmItem () |
| default constructor
|
|
| DcmItem (const DcmTag &tag, const Uint32 len=0) |
| constructor. More...
|
|
| DcmItem (const DcmItem &old) |
| copy constructor More...
|
|
DcmItem & | operator= (const DcmItem &obj) |
| assignment operator. More...
|
|
virtual int | compare (const DcmItem &rhs) const |
| comparison operator that compares the value of this object with a given object of the same type. More...
|
|
virtual | ~DcmItem () |
| destructor
|
|
virtual unsigned long | getVM () |
| get value multiplicity More...
|
|
virtual unsigned long | getNumberOfValues () |
| get number of values (elements) stored in this item. More...
|
|
virtual unsigned long | card () const |
| get cardinality of this item More...
|
|
virtual OFBool | isLeaf () const |
| check if this element is a leaf node in a dataset tree. More...
|
|
virtual OFBool | isNested () const |
| check if this item is nested in a sequence of items, i.e. not a top-level or stand-alone item/dataset More...
|
|
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. More...
|
|
virtual void | transferInit () |
| initialize the transfer state of this object. More...
|
|
virtual void | transferEnd () |
| finalize the transfer state of this object. More...
|
|
virtual DcmItem * | getParentItem () |
| get parent item of this object, i.e. the item/dataset in which the surrounding sequence element is stored. 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 at any nesting level. More...
|
|
virtual OFBool | isAffectedBySpecificCharacterSet () const |
| check if this object is affected by SpecificCharacterSet at any nesting level. More...
|
|
virtual OFCondition | convertCharacterSet (const OFString &fromCharset, const OFString &toCharset, const size_t flags=0, const OFBool updateCharset=OFFalse) |
| convert all element values that are contained in this item and that are affected by SpecificCharacterSet from the given source character set to the given destination character set. More...
|
|
virtual OFCondition | convertCharacterSet (const OFString &toCharset, const size_t flags=0, const OFBool ignoreCharset=OFFalse) |
| convert all element values that are contained in this item and that are affected by SpecificCharacterSet to the given destination character set. More...
|
|
virtual OFCondition | convertCharacterSet (DcmSpecificCharacterSet &converter) |
| convert all element values that are contained in this item and that are affected by SpecificCharacterSet from the currently selected source character set to the currently selected destination character set More...
|
|
virtual OFCondition | convertToUTF8 () |
| convert all element values that are contained in this item and that are affected by SpecificCharacterSet to UTF-8 (Unicode). More...
|
|
virtual OFCondition | insert (DcmElement *elem, OFBool replaceOld=OFFalse, OFBool checkInsertOrder=OFFalse) |
| insert a new element into the list of elements maintained by this item. More...
|
|
virtual DcmElement * | getElement (const unsigned long num) |
| access an element from the item. 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 DcmObject * | nextInContainer (const DcmObject *obj) |
| this method is only used in container classes, that is, DcmItem and DcmSequenceOfItems. More...
|
|
virtual DcmElement * | remove (const unsigned long num) |
| remove element from list. More...
|
|
virtual DcmElement * | remove (DcmObject *elem) |
| remove element from list. More...
|
|
virtual DcmElement * | remove (const DcmTagKey &tag) |
| remove element from list. More...
|
|
virtual OFBool | isEmpty (const OFBool normalize=OFTrue) |
| check if this item is empty More...
|
|
virtual OFCondition | verify (const OFBool autocorrect=OFFalse) |
| check the currently stored element value 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...
|
|
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. More...
|
|
virtual void | compactElements (const Uint32 maxLength) |
| iterate over all elements and remove those element values from memory which exceed a given length and which can be loaded from file when needed again. More...
|
|
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. More...
|
|
OFBool | tagExists (const DcmTagKey &key, OFBool searchIntoSub=OFFalse) |
| check if an element with the given attribute tag exists in the dataset More...
|
|
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 More...
|
|
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). More...
|
|
OFCondition | findAndGetElements (const DcmTagKey &tagKey, DcmStack &resultStack) |
| find all elements matching a particular tag and return references to them on a stack. More...
|
|
OFCondition | findAndGetString (const DcmTagKey &tagKey, const char *&value, const OFBool searchIntoSub=OFFalse) |
| find element and get value as a reference to a C string. More...
|
|
OFCondition | findAndGetString (const DcmTagKey &tagKey, const char *&value, Uint32 &length, const OFBool searchIntoSub=OFFalse) |
| find element and get value as a reference to a C string. More...
|
|
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). More...
|
|
OFCondition | findAndGetOFStringArray (const DcmTagKey &tagKey, OFString &value, const OFBool searchIntoSub=OFFalse) |
| find element and get value as a C++ string (all components). More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
OFCondition | findAndGetUint64 (const DcmTagKey &tagKey, Uint64 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse) |
| find element and get value as an unsigned 64-bit integer. More...
|
|
OFCondition | findAndGetUint64Array (const DcmTagKey &tagKey, const Uint64 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse) |
| find element and get value as an array of unsigned 64-bit integers. More...
|
|
OFCondition | findAndGetSint64 (const DcmTagKey &tagKey, Sint64 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse) |
| find element and get value as a signed 64-bit integer. More...
|
|
OFCondition | findAndGetSint64Array (const DcmTagKey &tagKey, const Sint64 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse) |
| find element and get value as an array of signed 64-bit integers. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
OFCondition | findAndGetSequence (const DcmTagKey &seqTagKey, DcmSequenceOfItems *&sequence, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse) |
| looks up and returns a given sequence. More...
|
|
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. More...
|
|
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. More...
|
|
OFCondition | findAndInsertCopyOfElement (const DcmTagKey &tagKey, DcmItem *destItem, const OFBool replaceOld=OFTrue) |
| find element, create a copy and insert it into the given destination dataset. More...
|
|
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. More...
|
|
OFCondition | findAndDeleteSequenceItem (const DcmTagKey &seqTagKey, const signed long itemNum) |
| looks up the given sequence in the current dataset and deletes the given item. More...
|
|
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. More...
|
|
OFCondition | putAndInsertString (const DcmTag &tag, const char *value, const Uint32 length, const OFBool replaceOld=OFTrue) |
| create a new element, put specified value to it and insert the element into the dataset/item. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
OFCondition | putAndInsertUint32Array (const DcmTag &tag, const Uint32 *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. More...
|
|
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. More...
|
|
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. More...
|
|
OFCondition | putAndInsertFloat32Array (const DcmTag &tag, const Float32 *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. More...
|
|
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. More...
|
|
OFCondition | putAndInsertFloat64Array (const DcmTag &tag, const Float64 *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. More...
|
|
OFCondition | putAndInsertTagKey (const DcmTag &tag, const DcmTagKey &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. More...
|
|
OFCondition | insertEmptyElement (const DcmTag &tag, const OFBool replaceOld=OFTrue) |
| create a new element (with no value) and insert it into the dataset/item. More...
|
|
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. More...
|
|
| 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...
|
|
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...
|
|
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 OFCondition | setVR (DcmEVR) |
| assign a new Value Representation (VR) to this object. More...
|
|
virtual OFBool | isSignable () const |
| returns true if the current object may be included in a digital signature More...
|
|
Uint32 | getLengthField () const |
| return the current value of the Length field (which is different from the functionality of the public getLength() method). More...
|
|