images.dicom.parseDICOMDIR

Extract metadata from DICOMDIR file

Syntax

info = images.dicom.parseDICOMDIR(filename)

Description

info = images.dicom.parseDICOMDIR(filename) extracts the metadata from the DICOM directory file (DICOMDIR) named in filename, returning the information in the structure info. If filename is not a DICOMDIR file, then the function returns an error.

A DICOMDIR is a special DICOM file that serves as a directory to a collection of DICOM files stored on removable media, such as CD- and DVD-ROMs. When devices write DICOM files to removable media, they typically write a DICOMDIR file on the disk to serve as a list of the disk contents.

Examples

Extract Metadata from DICOMDIR File

Read information about the contents of a DICOM folder into the workspace.

detailsStruct = images.dicom.parseDICOMDIR("DICOMDIR");

Input Arguments

filename — Name of DICOMDIR file

string scalar | character vector

Name of the DICOMDIR file, specified as a string scalar or character vector. filename can specify a full path name or a relative path name to the file.

Data Types: char | string

Output Arguments

info — Metadata from DICOMDIR file

structure

Metadata from the DICOMDIR file, returned as a structure.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2017b

R2024b: Support for thread-based environments

images.dicom.parseDICOMDIR now supports thread-based environments.