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

a class handling the DICOM file format (with meta header) More...

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

Public Member Functions

 DcmFileFormat ()
 default constructor
 
 DcmFileFormat (DcmDataset *dataset)
 constructor
 
 DcmFileFormat (const DcmFileFormat &old)
 copy constructor
 
virtual ~DcmFileFormat ()
 destructor
 
DcmFileFormatoperator= (const DcmFileFormat &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 file meta information header and dataset
 
virtual void removeInvalidGroups ()
 remove all elements with an invalid group number from the meta information header and dataset
 
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 meta header and dataset to a stream
 
virtual OFCondition validateMetaInfo (const E_TransferSyntax oxfer, const E_FileWriteMode writeMode=EWM_fileformat)
 make sure that all data elements of the file meta information header are existent in metainfo and contain correct values.
 
DcmMetaInfogetMetaInfo ()
 get file meta information header part of the fileformat
 
DcmDatasetgetDataset ()
 get dataset part of the fileformat
 
DcmDatasetgetAndRemoveDataset ()
 get dataset part and remove it from the fileformat.
 
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.
 
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)
 read object from a stream.
 
virtual OFCondition write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 write fileformat 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, const E_FileWriteMode writeMode=EWM_fileformat)
 write object to a stream (abstract)
 
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, const E_FileReadMode readMode=ERM_autoDetect)
 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, const E_FileWriteMode writeMode=EWM_fileformat)
 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 in all pixel data elements.
 
E_FileReadMode getReadMode () const
 get current file read mode.
 
void setReadMode (const E_FileReadMode readMode)
 set current file read mode.
 
virtual OFCondition insertItem (DcmItem *item, const unsigned long where=DCM_EndOfListIndex)
 method inherited from base class that shall not be used for instances of this class.
 
virtual DcmItemremove (const unsigned long num)
 method inherited from base class that shall not be used for instances of this class.
 
virtual DcmItemremove (DcmItem *item)
 method inherited from base class that shall not be used for instances of this class.
 
- Public Member Functions inherited from DcmSequenceOfItems
 DcmSequenceOfItems (const DcmTag &tag, const Uint32 len=0, OFBool readAsUN=OFFalse)
 constructor
 
 DcmSequenceOfItems (const DcmSequenceOfItems &oldSeq)
 copy constructor
 
virtual ~DcmSequenceOfItems ()
 destructor
 
DcmSequenceOfItemsoperator= (const DcmSequenceOfItems &obj)
 copy assignment operator
 
OFCondition error () const
 returns current status flag
 
virtual OFBool isLeaf () const
 check if this element is a leaf node in a dataset tree.
 
virtual OFCondition checkValue (const OFString &card="1-n", const OFBool oldFormat=OFFalse)
 check whether stored value conforms to the VR and to the specified VM
 
virtual unsigned long getVM ()
 get value multiplicity
 
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.
 
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 OFCondition writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 special write method for creation of digital signatures
 
virtual OFBool isSignable () const
 returns true if the current object may be included in a digital signature
 
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 unsigned long card ()
 get cardinality of this sequence
 
virtual OFCondition prepend (DcmItem *item)
 insert the given item at the start of the item list maintained by this sequence.
 
virtual OFCondition insert (DcmItem *item, unsigned long where=DCM_EndOfListIndex, OFBool before=OFFalse)
 insert the given item at the given position within the item list maintained by this sequence.
 
virtual OFCondition append (DcmItem *item)
 insert the given item at the end of the item list maintained by this sequence.
 
virtual OFCondition insertAtCurrentPos (DcmItem *item, OFBool before=OFFalse)
 insert new item a current position.
 
virtual DcmItemgetItem (const unsigned long num)
 access an item from the sequence.
 
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 OFBool isEmpty (const OFBool normalize=OFTrue)
 check if this sequence 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 (void)
 this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory.
 
virtual 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.
 
- Public Member Functions inherited from DcmElement
 DcmElement (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmElement (const DcmElement &old)
 copy constructor
 
virtual ~DcmElement ()
 destructor
 
DcmElementoperator= (const DcmElement &obj)
 assignment operator
 
OFBool valueLoaded () const
 check if value of this element is loaded into main memory
 
virtual OFCondition getUint8 (Uint8 &val, const unsigned long pos=0)
 retrieve a single value of type Uint8.
 
virtual OFCondition getSint16 (Sint16 &val, const unsigned long pos=0)
 retrieve a single value of type Sint16.
 
virtual OFCondition getUint16 (Uint16 &val, const unsigned long pos=0)
 retrieve a single value of type Uint16.
 
virtual OFCondition getSint32 (Sint32 &val, const unsigned long pos=0)
 retrieve a single value of type Sint32.
 
virtual OFCondition getUint32 (Uint32 &val, const unsigned long pos=0)
 retrieve a single value of type Uint32.
 
virtual OFCondition getFloat32 (Float32 &val, const unsigned long pos=0)
 retrieve a single value of type Float32.
 
virtual OFCondition getFloat64 (Float64 &val, const unsigned long pos=0)
 retrieve a single value of type Float64.
 
virtual OFCondition getTagVal (DcmTagKey &val, const unsigned long pos=0)
 retrieve a single value of type DcmTagKey.
 
virtual OFCondition getOFString (OFString &str, const unsigned long pos, OFBool normalize=OFTrue)
 retrieve a single value of type string.
 
virtual OFCondition getOFStringArray (OFString &value, OFBool normalize=OFTrue)
 get entire element value as a character string.
 
virtual OFCondition getString (char *&val)
 get a pointer to the element value of the current element as type string.
 
virtual OFCondition getUint8Array (Uint8 *&val)
 get a pointer to the element value of the current element as type string.
 
virtual OFCondition getSint16Array (Sint16 *&val)
 get a pointer to the element value of the current element as type Sint16.
 
virtual OFCondition getUint16Array (Uint16 *&val)
 get a pointer to the element value of the current element as type Uint16.
 
virtual OFCondition getSint32Array (Sint32 *&val)
 get a pointer to the element value of the current element as type Sint32.
 
virtual OFCondition getUint32Array (Uint32 *&val)
 get a pointer to the element value of the current element as type Uint32.
 
virtual OFCondition getFloat32Array (Float32 *&val)
 get a pointer to the element value of the current element as type Float32.
 
virtual OFCondition getFloat64Array (Float64 *&val)
 get a pointer to the element value of the current element as type Float64.
 
OFCondition detachValueField (OFBool copy=OFFalse)
 detach the value field from the DICOM element (i.e., this object).
 
virtual OFCondition putOFStringArray (const OFString &stringValue)
 replace the element value by a copy of the given string (which is possibly multi-valued).
 
virtual OFCondition putString (const char *val)
 replace the element value by a copy of the given string (which is possibly multi-valued).
 
virtual OFCondition putSint16 (const Sint16 val, const unsigned long pos=0)
 insert into the element value a copy of the given Sint16 value.
 
virtual OFCondition putUint16 (const Uint16 val, const unsigned long pos=0)
 insert into the element value a copy of the given Uint16 value.
 
virtual OFCondition putSint32 (const Sint32 val, const unsigned long pos=0)
 insert into the element value a copy of the given Sint32 value.
 
virtual OFCondition putUint32 (const Uint32 val, const unsigned long pos=0)
 insert into the element value a copy of the given Uint32 value.
 
virtual OFCondition putFloat32 (const Float32 val, const unsigned long pos=0)
 insert into the element value a copy of the given Float32 value.
 
virtual OFCondition putFloat64 (const Float64 val, const unsigned long pos=0)
 insert into the element value a copy of the given Float64 value.
 
virtual OFCondition putTagVal (const DcmTagKey &attrTag, const unsigned long pos=0)
 insert into the element value a copy of the given DcmTagKey value.
 
virtual OFCondition putUint8Array (const Uint8 *vals, const unsigned long num)
 replace the element value by a copy of the given Uint8 array (which is possibly multi-valued).
 
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).
 
virtual OFCondition putUint16Array (const Uint16 *vals, const unsigned long num)
 replace the element value by a copy of the given Uint16 array (which is possibly multi-valued).
 
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).
 
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).
 
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).
 
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).
 
virtual OFCondition createUint8Array (const Uint32 numBytes, Uint8 *&bytes)
 create an empty Uint8 array of given number of bytes and set it.
 
virtual OFCondition createUint16Array (const Uint32 numWords, Uint16 *&words)
 create an empty Uint16 array of given number of words and set it.
 
virtual OFCondition createValueFromTempFile (DcmInputStreamFactory *factory, const Uint32 length, const E_ByteOrder byteOrder)
 replace the attribute value with the content of the given temporary file.
 
virtual void compact ()
 remove the attribute value from memory if the attribute value can be loaded from file when needed again.
 
virtual OFCondition getUncompressedFrameSize (DcmItem *dataset, Uint32 &frameSize) const
 compute uncompressed frame size of a single frame of this image.
 
virtual OFCondition getUncompressedFrame (DcmItem *dataset, Uint32 frameNo, Uint32 &startFragment, void *buffer, Uint32 bufSize, OFString &decompressedColorModel, DcmFileCache *cache=NULL)
 access single frame without decompressing or loading a complete multi-frame object.
 
virtual OFCondition getDecompressedColorModel (DcmItem *dataset, OFString &decompressedColorModel)
 determine color model of the decompressed image
 
- 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.
 
Uint32 getLengthField () const
 return the current value of the Length field (which is different from the functionality of the public getLength method).
 

Static Private Member Functions

static OFCondition checkMetaHeaderValue (DcmMetaInfo *metainfo, DcmDataset *dataset, const DcmTagKey &atagkey, DcmObject *obj, const E_TransferSyntax oxfer, const E_FileWriteMode writeMode)
 This function checks if a particular data element of the file meta information header is existent.
 
static E_TransferSyntax lookForXfer (DcmMetaInfo *metainfo)
 read DCM_TransferSyntaxUID from meta header dataset and return as E_TransferSyntax value
 

Private Attributes

E_FileReadMode FileReadMode
 file read mode, specifies whether to read the meta header or not
 

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)
 
- Protected Member Functions inherited from DcmSequenceOfItems
virtual OFCondition readTagAndLength (DcmInputStream &inStream, const E_TransferSyntax xfer, DcmTag &tag, Uint32 &length)
 This function reads tag and length information from inStream and returns this information to the caller.
 
virtual OFCondition makeSubObject (DcmObject *&subObject, const DcmTag &newTag, const Uint32 newLength)
 helper function for read().
 
OFCondition readSubItem (DcmInputStream &inStream, const DcmTag &newTag, const Uint32 newLength, const E_TransferSyntax xfer, const E_GrpLenEncoding glenc, const Uint32 maxReadLength=DCM_MaxReadLength)
 helper function for read().
 
virtual OFCondition searchSubFromHere (const DcmTagKey &tag, DcmStack &resultStack, const OFBool searchIntoSub)
 helper function for search().
 
- Static Protected Member Functions inherited from DcmElement
static OFCondition checkVM (const unsigned long vmNum, const OFString &vmStr)
 check for correct value multiplicity (VM)
 
- Protected Attributes inherited from DcmSequenceOfItems
DcmListitemList
 the list of items maintained by this sequence object
 

Detailed Description

a class handling the DICOM file format (with meta header)

Definition at line 48 of file dcfilefo.h.

Constructor & Destructor Documentation

DcmFileFormat::DcmFileFormat ( DcmDataset dataset)

constructor

Parameters
datasetto be copied (!) into the new DcmFileFormat object
DcmFileFormat::DcmFileFormat ( const DcmFileFormat old)

copy constructor

Parameters
oldelement to be copied

Member Function Documentation

virtual Uint32 DcmFileFormat::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 DcmSequenceOfItems.

virtual OFBool DcmFileFormat::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 DcmSequenceOfItems.

static OFCondition DcmFileFormat::checkMetaHeaderValue ( DcmMetaInfo metainfo,
DcmDataset dataset,
const DcmTagKey atagkey,
DcmObject obj,
const E_TransferSyntax  oxfer,
const E_FileWriteMode  writeMode 
)
staticprivate

This function checks if a particular data element of the file meta information header is existent.

If the element is not existent, it will be inserted. Additionally, this function makes sure that the corresponding data element will contain a correct value.

Parameters
metainfothe meta header information
datasetthe data set information
atagkeytag of the data element which shall be checked
objdata object from metainfo which represents the data element that shall be checked. Equals NULL if this data element is not existent in the meta header information.
oxferThe transfer syntax which shall be used.
writeModeflag indicating whether to update the file meta information or not
Returns
EC_Normal if successful, an error code otherwise
OFCondition DcmFileFormat::chooseRepresentation ( const E_TransferSyntax  repType,
const DcmRepresentationParameter repParam 
)
inline

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.

Definition at line 286 of file dcfilefo.h.

References DcmDataset::chooseRepresentation(), and getDataset().

virtual OFCondition DcmFileFormat::clear ( )
virtual

clear file meta information header and dataset

Returns
EC_Normal if successful, an error code otherwise

Reimplemented from DcmSequenceOfItems.

virtual DcmObject* DcmFileFormat::clone ( ) const
inlinevirtual

clone method

Returns
deep copy of this object

Reimplemented from DcmSequenceOfItems.

Definition at line 81 of file dcfilefo.h.

References DcmFileFormat().

virtual OFCondition DcmFileFormat::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 DcmSequenceOfItems.

DcmDataset* DcmFileFormat::getAndRemoveDataset ( )

get dataset part and remove it from the fileformat.

Please note that a new, initially empty dataset is also added to the fileformat.

Returns
reference to previously stored but now removed dataset
DcmDataset* DcmFileFormat::getDataset ( )

get dataset part of the fileformat

Returns
reference to internally stored dataset

Referenced by chooseRepresentation(), hasRepresentation(), removeAllButCurrentRepresentations(), and removeAllButOriginalRepresentations().

DcmMetaInfo* DcmFileFormat::getMetaInfo ( )

get file meta information header part of the fileformat

Returns
reference to internally stored file meta information header
E_FileReadMode DcmFileFormat::getReadMode ( ) const
inline

get current file read mode.

This mode specifies whether a file is read as a fileformat or dataset (without meta header). In addition, the reading can be restricted to DICOM files only.

Returns
file read mode

Definition at line 325 of file dcfilefo.h.

References FileReadMode.

OFBool DcmFileFormat::hasRepresentation ( const E_TransferSyntax  repType,
const DcmRepresentationParameter repParam 
)
inline

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

Definition at line 299 of file dcfilefo.h.

References getDataset(), and DcmDataset::hasRepresentation().

virtual DcmEVR DcmFileFormat::ident ( ) const
virtual

get type identifier

Returns
type identifier of this class (EVR_fileFormat)

Reimplemented from DcmSequenceOfItems.

virtual OFCondition DcmFileFormat::insertItem ( DcmItem item,
const unsigned long  where = DCM_EndOfListIndex 
)
virtual

method inherited from base class that shall not be used for instances of this class.

Method immediately returns with error code.

Parameters
itemitem
wherewhere
Returns
always returns EC_IllegalCall.
virtual OFCondition DcmFileFormat::loadFile ( const char *  fileName,
const E_TransferSyntax  readXfer = EXS_Unknown,
const E_GrpLenEncoding  groupLength = EGL_noChange,
const Uint32  maxReadLength = DCM_MaxReadLength,
const E_FileReadMode  readMode = ERM_autoDetect 
)
virtual

load object from a DICOM file.

This method supports DICOM objects stored as a file (with meta header) or as a dataset (without meta header). By default, the presence of a meta header is detected automatically.

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.
readModeread file with or without meta header, i.e. as a fileformat or a dataset. Use ERM_fileOnly in order to force the presence of a meta header.
Returns
status, EC_Normal if successful, an error code otherwise
static E_TransferSyntax DcmFileFormat::lookForXfer ( DcmMetaInfo metainfo)
staticprivate

read DCM_TransferSyntaxUID from meta header dataset and return as E_TransferSyntax value

Parameters
metainfometa-header dataset
Returns
E_TransferSyntax value for DCM_TransferSyntaxUID, EXS_Unknown if not found or unknown
DcmFileFormat& DcmFileFormat::operator= ( const DcmFileFormat obj)

assignment operator

Parameters
objfileformat to be assigned/copied
Returns
reference to this object
virtual void DcmFileFormat::print ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0,
const int  level = 0,
const char *  pixelFileName = NULL,
size_t *  pixelCounter = NULL 
)
virtual

print meta header and 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 DcmSequenceOfItems.

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

read object from a stream.

Parameters
inStreamDICOM input stream
xfertransfer syntax to use when parsing
glenchandling of group length parameters
maxReadLengthattribute values larger than this value are skipped while parsing and read later upon first access if the stream type supports this.
Returns
EC_Normal if successful, an error code otherwise

Reimplemented from DcmSequenceOfItems.

virtual DcmItem* DcmFileFormat::remove ( const unsigned long  num)
virtual

method inherited from base class that shall not be used for instances of this class.

Method immediately returns.

Parameters
numnum
Returns
always returns NULL.

Reimplemented from DcmSequenceOfItems.

virtual DcmItem* DcmFileFormat::remove ( DcmItem item)
virtual

method inherited from base class that shall not be used for instances of this class.

Method immediately returns.

Parameters
itemitem
Returns
always returns NULL.

Reimplemented from DcmSequenceOfItems.

void DcmFileFormat::removeAllButCurrentRepresentations ( )
inline

removes all but the current representation in all pixel data elements.

Makes the current representation original.

Definition at line 315 of file dcfilefo.h.

References getDataset(), and DcmDataset::removeAllButCurrentRepresentations().

virtual OFCondition DcmFileFormat::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,
const E_FileWriteMode  writeMode = EWM_fileformat 
)
virtual

save object to a DICOM file.

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)
writeModewrite file with or without meta header. Also allows for updating the information in the file meta information header.
Returns
status, EC_Normal if successful, an error code otherwise
void DcmFileFormat::setReadMode ( const E_FileReadMode  readMode)
inline

set current file read mode.

This mode specifies whether a file is read as a fileformat or dataset (without meta header). In addition, the reading can be restricted to DICOM files only.

Parameters
readModefile read mode to be set

Definition at line 335 of file dcfilefo.h.

References FileReadMode.

virtual OFCondition DcmFileFormat::validateMetaInfo ( const E_TransferSyntax  oxfer,
const E_FileWriteMode  writeMode = EWM_fileformat 
)
virtual

make sure that all data elements of the file meta information header are existent in metainfo and contain correct values.

Parameters
oxferthe transfer syntax which shall be used
writeModeflag indicating whether to update the file meta information or not
virtual OFCondition DcmFileFormat::write ( DcmOutputStream outStream,
const E_TransferSyntax  oxfer,
const E_EncodingType  enctype,
DcmWriteCache wcache 
)
virtual

write fileformat 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 DcmSequenceOfItems.

virtual OFCondition DcmFileFormat::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,
const E_FileWriteMode  writeMode = EWM_fileformat 
)
virtual

write object to a stream (abstract)

Parameters
outStreamDICOM output stream
oxferoutput transfer syntax
enctypeencoding types (undefined or explicit length)
wcachepointer to write cache object, may be NULL
glencgroup length encoding
padencdataset trailing padding encoding
padlenpadding structure size for complete file
subPadlenpadding structure set for sequence items
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 information header from the DcmFileFormat to the DcmDataset object.
writeModewrite file with or without meta header. Also allows for updating the information in the file meta information header.
Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DcmFileFormat::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 DcmSequenceOfItems.


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