tractor.base (version 2.5.0)

newDicomMetadataFromFile: Read a DICOM file into a DicomMetadata object

Description

This function reads a DICOM file into a DicomMetadata object. Only DICOM files from magnetic resonance scanners are supported.

Usage

newDicomMetadataFromFile(fileName, checkFormat = TRUE, dictionary = NULL,
    stopTag = NULL, ignoreTransferSyntax = FALSE)

Arguments

fileName

The name of a DICOM file.

checkFormat

If TRUE, the function will check for the magic string "DICM" at byte offset 128. This string should be present, but in reality not all files contain it.

dictionary

A tag dictionary to use when reading the file. If NULL then the built-in dictionary will be loaded and used.

stopTag

An integer vector giving the group and element numbers (in that order) of a DICOM tag, or NULL. If not NULL, the function will stop parsing the DICOM file if the specified tag is encountered. This can be used to speed up the proc

ignoreTransferSyntax

If TRUE, any transfer syntax stored in the file will be ignored, and the code will try to deduce the transfer syntax using heuristics. This may occasionally be necessary for awkward DICOM files, but is not generally recommended.

Value

• newDicomMetadataFromFile returns a DicomMetadata object, or NULL on failure.

References

Please cite the following reference when using TractoR in your work:

J.D. Clayden, S. Muñoz Maniega, A.J. Storkey, M.D. King, M.E. Bastin & C.A. Clark (2011). TractoR: Magnetic resonance imaging and tractography with R. Journal of Statistical Software 44(8):1-18. http://www.jstatsoft.org/v44/i08/.

See Also

The DICOM standard, found online at http://dicom.nema.org/. (Warning: may produce headaches!) Also dictionary, and newMriImageFromDicomDirectory for information on how to create MriImage objects from DICOM files.